1# Doxyfile 1.5.2 2 3#--------------------------------------------------------------------------- 4# Project related configuration options 5#--------------------------------------------------------------------------- 6DOXYFILE_ENCODING = UTF-8 7PROJECT_NUMBER = 8CREATE_SUBDIRS = YES 9OUTPUT_LANGUAGE = English 10BRIEF_MEMBER_DESC = YES 11REPEAT_BRIEF = YES 12ABBREVIATE_BRIEF = "The $name class" \ 13 "The $name widget" \ 14 "The $name file" \ 15 is \ 16 provides \ 17 specifies \ 18 contains \ 19 represents \ 20 a \ 21 an \ 22 the 23ALWAYS_DETAILED_SEC = NO 24INLINE_INHERITED_MEMB = NO 25FULL_PATH_NAMES = YES 26STRIP_FROM_PATH = $(DOXYGEN_SRC_PATH) $(DOXYGEN_DEST_PATH) 27STRIP_FROM_INC_PATH = 28SHORT_NAMES = NO 29JAVADOC_AUTOBRIEF = NO 30MULTILINE_CPP_IS_BRIEF = NO 31INHERIT_DOCS = YES 32SEPARATE_MEMBER_PAGES = NO 33TAB_SIZE = 8 34ALIASES = 35OPTIMIZE_OUTPUT_FOR_C = YES 36OPTIMIZE_OUTPUT_JAVA = NO 37BUILTIN_STL_SUPPORT = NO 38CPP_CLI_SUPPORT = NO 39DISTRIBUTE_GROUP_DOC = NO 40SUBGROUPING = YES 41#--------------------------------------------------------------------------- 42# Build related configuration options 43#--------------------------------------------------------------------------- 44EXTRACT_PRIVATE = YES 45EXTRACT_STATIC = YES 46EXTRACT_LOCAL_CLASSES = YES 47EXTRACT_LOCAL_METHODS = NO 48HIDE_UNDOC_MEMBERS = NO 49HIDE_UNDOC_CLASSES = NO 50HIDE_FRIEND_COMPOUNDS = NO 51HIDE_IN_BODY_DOCS = NO 52INTERNAL_DOCS = YES 53CASE_SENSE_NAMES = YES 54HIDE_SCOPE_NAMES = NO 55SHOW_INCLUDE_FILES = YES 56INLINE_INFO = YES 57SORT_MEMBER_DOCS = YES 58SORT_BRIEF_DOCS = NO 59SORT_BY_SCOPE_NAME = NO 60GENERATE_TODOLIST = YES 61GENERATE_TESTLIST = YES 62GENERATE_BUGLIST = YES 63GENERATE_DEPRECATEDLIST= YES 64ENABLED_SECTIONS = 65MAX_INITIALIZER_LINES = 30 66SHOW_USED_FILES = YES 67FILE_VERSION_FILTER = 68#--------------------------------------------------------------------------- 69# configuration options related to warning and progress messages 70#--------------------------------------------------------------------------- 71QUIET = NO 72WARNINGS = YES 73WARN_IF_UNDOCUMENTED = YES 74WARN_IF_DOC_ERROR = YES 75WARN_NO_PARAMDOC = NO 76WARN_FORMAT = "$file:$line: $text" 77WARN_LOGFILE = 78 79#--------------------------------------------------------------------------- 80# configuration options related to the input files 81#--------------------------------------------------------------------------- 82INPUT_ENCODING = UTF-8 83FILE_PATTERNS = *.c \ 84 *.cc \ 85 *.cxx \ 86 *.cpp \ 87 *.c++ \ 88 *.java \ 89 *.ii \ 90 *.ixx \ 91 *.ipp \ 92 *.i++ \ 93 *.inl \ 94 *.h \ 95 *.hh \ 96 *.hxx \ 97 *.hpp \ 98 *.h++ \ 99 *.idl \ 100 *.odl \ 101 *.cs \ 102 *.php \ 103 *.php3 \ 104 *.inc \ 105 *.m \ 106 *.mm \ 107 *.dox \ 108 *.C \ 109 *.CC \ 110 *.C++ \ 111 *.II \ 112 *.I++ \ 113 *.H \ 114 *.HH \ 115 *.H++ \ 116 *.CS \ 117 *.PHP \ 118 *.PHP3 \ 119 *.M \ 120 *.MM 121RECURSIVE = YES 122EXCLUDE = 123EXCLUDE_SYMLINKS = NO 124EXCLUDE_PATTERNS = */.\#* */.svn/* 125EXCLUDE_SYMBOLS = 126EXAMPLE_PATH = 127EXAMPLE_PATTERNS = * 128EXAMPLE_RECURSIVE = NO 129IMAGE_PATH = 130INPUT_FILTER = 131FILTER_PATTERNS = 132FILTER_SOURCE_FILES = NO 133#--------------------------------------------------------------------------- 134# configuration options related to source browsing 135#--------------------------------------------------------------------------- 136SOURCE_BROWSER = YES 137INLINE_SOURCES = NO 138STRIP_CODE_COMMENTS = YES 139REFERENCED_BY_RELATION = YES 140REFERENCES_RELATION = YES 141REFERENCES_LINK_SOURCE = YES 142USE_HTAGS = NO 143VERBATIM_HEADERS = YES 144#--------------------------------------------------------------------------- 145# configuration options related to the alphabetical class index 146#--------------------------------------------------------------------------- 147ALPHABETICAL_INDEX = YES 148COLS_IN_ALPHA_INDEX = 5 149IGNORE_PREFIX = 150#--------------------------------------------------------------------------- 151# configuration options related to the HTML output 152#--------------------------------------------------------------------------- 153GENERATE_HTML = YES 154HTML_OUTPUT = html 155HTML_FILE_EXTENSION = .html 156HTML_HEADER = 157HTML_FOOTER = 158HTML_STYLESHEET = 159GENERATE_HTMLHELP = NO 160CHM_FILE = 161HHC_LOCATION = 162GENERATE_CHI = NO 163BINARY_TOC = NO 164TOC_EXPAND = NO 165DISABLE_INDEX = NO 166ENUM_VALUES_PER_LINE = 4 167GENERATE_TREEVIEW = YES 168TREEVIEW_WIDTH = 250 169#--------------------------------------------------------------------------- 170# configuration options related to the LaTeX output 171#--------------------------------------------------------------------------- 172GENERATE_LATEX = YES 173LATEX_OUTPUT = latex 174LATEX_CMD_NAME = latex 175MAKEINDEX_CMD_NAME = makeindex 176COMPACT_LATEX = NO 177PAPER_TYPE = a4wide 178EXTRA_PACKAGES = 179LATEX_HEADER = 180PDF_HYPERLINKS = YES 181USE_PDFLATEX = YES 182LATEX_BATCHMODE = NO 183LATEX_HIDE_INDICES = NO 184#--------------------------------------------------------------------------- 185# configuration options related to the RTF output 186#--------------------------------------------------------------------------- 187GENERATE_RTF = NO 188RTF_OUTPUT = rtf 189COMPACT_RTF = NO 190RTF_HYPERLINKS = NO 191RTF_STYLESHEET_FILE = 192RTF_EXTENSIONS_FILE = 193#--------------------------------------------------------------------------- 194# configuration options related to the man page output 195#--------------------------------------------------------------------------- 196GENERATE_MAN = NO 197MAN_OUTPUT = man 198MAN_EXTENSION = .3 199MAN_LINKS = NO 200#--------------------------------------------------------------------------- 201# configuration options related to the XML output 202#--------------------------------------------------------------------------- 203GENERATE_XML = NO 204XML_OUTPUT = xml 205XML_PROGRAMLISTING = YES 206#--------------------------------------------------------------------------- 207# configuration options for the AutoGen Definitions output 208#--------------------------------------------------------------------------- 209GENERATE_AUTOGEN_DEF = NO 210#--------------------------------------------------------------------------- 211# configuration options related to the Perl module output 212#--------------------------------------------------------------------------- 213GENERATE_PERLMOD = NO 214PERLMOD_LATEX = NO 215PERLMOD_PRETTY = YES 216PERLMOD_MAKEVAR_PREFIX = 217#--------------------------------------------------------------------------- 218# Configuration options related to the preprocessor 219#--------------------------------------------------------------------------- 220ENABLE_PREPROCESSING = YES 221MACRO_EXPANSION = YES 222EXPAND_ONLY_PREDEF = YES 223SEARCH_INCLUDES = YES 224INCLUDE_PATH = $(DOXYGEN_SRC_INCLUDE_PATH) \ 225 . 226INCLUDE_FILE_PATTERNS = *.h 227# __FreeBSD__ is normally defined to the major version number of 228# FreeBSD. In the kernel source it is just checked if it is defined, and 229# __FreeBSD_version is used for version dependend code. 230# To make live simple on major version bumps, just define __FreeBSD__ to 1. 231PREDEFINED = _KERNEL \ 232 __FreeBSD__=1 \ 233 __${TARGET_ARCH}__=1 \ 234 __${TARGET_ARCH}=1 235EXPAND_AS_DEFINED = 236SKIP_FUNCTION_MACROS = YES 237#--------------------------------------------------------------------------- 238# Configuration::additions related to external references 239#--------------------------------------------------------------------------- 240ALLEXTERNALS = NO 241EXTERNAL_GROUPS = YES 242PERL_PATH = /usr/bin/perl 243#--------------------------------------------------------------------------- 244# Configuration options related to the dot tool 245#--------------------------------------------------------------------------- 246CLASS_DIAGRAMS = NO 247MSCGEN_PATH = 248HIDE_UNDOC_RELATIONS = YES 249HAVE_DOT = YES 250CLASS_GRAPH = YES 251COLLABORATION_GRAPH = YES 252GROUP_GRAPHS = YES 253UML_LOOK = NO 254TEMPLATE_RELATIONS = NO 255INCLUDE_GRAPH = YES 256INCLUDED_BY_GRAPH = YES 257CALL_GRAPH = YES 258CALLER_GRAPH = YES 259GRAPHICAL_HIERARCHY = YES 260DIRECTORY_GRAPH = YES 261DOT_IMAGE_FORMAT = png 262DOT_PATH = 263DOTFILE_DIRS = 264DOT_GRAPH_MAX_NODES = 50 265DOT_TRANSPARENT = NO 266DOT_MULTI_TARGETS = YES 267GENERATE_LEGEND = YES 268DOT_CLEANUP = YES 269#--------------------------------------------------------------------------- 270# Configuration::additions related to the search engine 271#--------------------------------------------------------------------------- 272SEARCHENGINE = NO 273