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 *.md \ 108 *.dox \ 109 *.C \ 110 *.CC \ 111 *.C++ \ 112 *.II \ 113 *.I++ \ 114 *.H \ 115 *.HH \ 116 *.H++ \ 117 *.CS \ 118 *.PHP \ 119 *.PHP3 \ 120 *.M \ 121 *.MM 122RECURSIVE = YES 123EXCLUDE = 124EXCLUDE_SYMLINKS = NO 125EXCLUDE_PATTERNS = */.\#* */.svn/* */.git/* 126EXCLUDE_SYMBOLS = 127EXAMPLE_PATH = 128EXAMPLE_PATTERNS = * 129EXAMPLE_RECURSIVE = NO 130IMAGE_PATH = 131INPUT_FILTER = 132FILTER_PATTERNS = 133FILTER_SOURCE_FILES = NO 134#--------------------------------------------------------------------------- 135# configuration options related to source browsing 136#--------------------------------------------------------------------------- 137SOURCE_BROWSER = YES 138INLINE_SOURCES = NO 139STRIP_CODE_COMMENTS = YES 140REFERENCED_BY_RELATION = YES 141REFERENCES_RELATION = YES 142REFERENCES_LINK_SOURCE = YES 143USE_HTAGS = NO 144VERBATIM_HEADERS = YES 145#--------------------------------------------------------------------------- 146# configuration options related to the alphabetical class index 147#--------------------------------------------------------------------------- 148ALPHABETICAL_INDEX = YES 149COLS_IN_ALPHA_INDEX = 5 150IGNORE_PREFIX = 151#--------------------------------------------------------------------------- 152# configuration options related to the HTML output 153#--------------------------------------------------------------------------- 154GENERATE_HTML = YES 155HTML_OUTPUT = html 156HTML_FILE_EXTENSION = .html 157HTML_HEADER = 158HTML_FOOTER = 159HTML_STYLESHEET = 160GENERATE_HTMLHELP = NO 161CHM_FILE = 162HHC_LOCATION = 163GENERATE_CHI = NO 164BINARY_TOC = NO 165TOC_EXPAND = NO 166DISABLE_INDEX = NO 167ENUM_VALUES_PER_LINE = 4 168GENERATE_TREEVIEW = YES 169TREEVIEW_WIDTH = 250 170#--------------------------------------------------------------------------- 171# configuration options related to the LaTeX output 172#--------------------------------------------------------------------------- 173GENERATE_LATEX = YES 174LATEX_OUTPUT = latex 175LATEX_CMD_NAME = latex 176MAKEINDEX_CMD_NAME = makeindex 177COMPACT_LATEX = NO 178PAPER_TYPE = a4wide 179EXTRA_PACKAGES = 180LATEX_HEADER = 181PDF_HYPERLINKS = YES 182USE_PDFLATEX = YES 183LATEX_BATCHMODE = NO 184LATEX_HIDE_INDICES = NO 185#--------------------------------------------------------------------------- 186# configuration options related to the RTF output 187#--------------------------------------------------------------------------- 188GENERATE_RTF = NO 189RTF_OUTPUT = rtf 190COMPACT_RTF = NO 191RTF_HYPERLINKS = NO 192RTF_STYLESHEET_FILE = 193RTF_EXTENSIONS_FILE = 194#--------------------------------------------------------------------------- 195# configuration options related to the man page output 196#--------------------------------------------------------------------------- 197GENERATE_MAN = NO 198MAN_OUTPUT = man 199MAN_EXTENSION = .3 200MAN_LINKS = NO 201#--------------------------------------------------------------------------- 202# configuration options related to the XML output 203#--------------------------------------------------------------------------- 204GENERATE_XML = NO 205XML_OUTPUT = xml 206XML_PROGRAMLISTING = YES 207#--------------------------------------------------------------------------- 208# configuration options for the AutoGen Definitions output 209#--------------------------------------------------------------------------- 210GENERATE_AUTOGEN_DEF = NO 211#--------------------------------------------------------------------------- 212# configuration options related to the Perl module output 213#--------------------------------------------------------------------------- 214GENERATE_PERLMOD = NO 215PERLMOD_LATEX = NO 216PERLMOD_PRETTY = YES 217PERLMOD_MAKEVAR_PREFIX = 218#--------------------------------------------------------------------------- 219# Configuration options related to the preprocessor 220#--------------------------------------------------------------------------- 221ENABLE_PREPROCESSING = YES 222MACRO_EXPANSION = YES 223EXPAND_ONLY_PREDEF = YES 224SEARCH_INCLUDES = YES 225INCLUDE_PATH = $(DOXYGEN_SRC_INCLUDE_PATH) \ 226 . 227INCLUDE_FILE_PATTERNS = *.h 228# __FreeBSD__ is normally defined to the major version number of 229# FreeBSD. In the kernel source it is just checked if it is defined, and 230# __FreeBSD_version is used for version dependend code. 231# To make live simple on major version bumps, just define __FreeBSD__ to 1. 232PREDEFINED = _KERNEL \ 233 __FreeBSD__=1 \ 234 __${TARGET_ARCH}__=1 \ 235 __${TARGET_ARCH}=1 236EXPAND_AS_DEFINED = 237SKIP_FUNCTION_MACROS = YES 238#--------------------------------------------------------------------------- 239# Configuration::additions related to external references 240#--------------------------------------------------------------------------- 241ALLEXTERNALS = NO 242EXTERNAL_GROUPS = YES 243PERL_PATH = /usr/bin/perl 244#--------------------------------------------------------------------------- 245# Configuration options related to the dot tool 246#--------------------------------------------------------------------------- 247CLASS_DIAGRAMS = NO 248MSCGEN_PATH = 249HIDE_UNDOC_RELATIONS = YES 250HAVE_DOT = YES 251CLASS_GRAPH = YES 252COLLABORATION_GRAPH = YES 253GROUP_GRAPHS = YES 254UML_LOOK = NO 255TEMPLATE_RELATIONS = NO 256INCLUDE_GRAPH = YES 257INCLUDED_BY_GRAPH = YES 258CALL_GRAPH = YES 259CALLER_GRAPH = YES 260GRAPHICAL_HIERARCHY = YES 261DIRECTORY_GRAPH = YES 262DOT_IMAGE_FORMAT = png 263DOT_PATH = 264DOTFILE_DIRS = 265DOT_GRAPH_MAX_NODES = 50 266DOT_TRANSPARENT = NO 267DOT_MULTI_TARGETS = YES 268GENERATE_LEGEND = YES 269DOT_CLEANUP = YES 270#--------------------------------------------------------------------------- 271# Configuration::additions related to the search engine 272#--------------------------------------------------------------------------- 273SEARCHENGINE = NO 274