120cb1f56SAlexander Leidinger# Doxyfile 1.5.2 2ff4b8cb7SAlexander Leidinger 3ff4b8cb7SAlexander Leidinger# $FreeBSD$ 4ff4b8cb7SAlexander Leidinger 5ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 6ff4b8cb7SAlexander Leidinger# Project related configuration options 7ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 820cb1f56SAlexander LeidingerDOXYFILE_ENCODING = UTF-8 9ff4b8cb7SAlexander LeidingerPROJECT_NUMBER = 10ff4b8cb7SAlexander LeidingerCREATE_SUBDIRS = YES 11ff4b8cb7SAlexander LeidingerOUTPUT_LANGUAGE = English 12ff4b8cb7SAlexander LeidingerBRIEF_MEMBER_DESC = YES 13ff4b8cb7SAlexander LeidingerREPEAT_BRIEF = YES 14ff4b8cb7SAlexander LeidingerABBREVIATE_BRIEF = "The $name class" \ 15ff4b8cb7SAlexander Leidinger "The $name widget" \ 16ff4b8cb7SAlexander Leidinger "The $name file" \ 17ff4b8cb7SAlexander Leidinger is \ 18ff4b8cb7SAlexander Leidinger provides \ 19ff4b8cb7SAlexander Leidinger specifies \ 20ff4b8cb7SAlexander Leidinger contains \ 21ff4b8cb7SAlexander Leidinger represents \ 22ff4b8cb7SAlexander Leidinger a \ 23ff4b8cb7SAlexander Leidinger an \ 24ff4b8cb7SAlexander Leidinger the 25ff4b8cb7SAlexander LeidingerALWAYS_DETAILED_SEC = NO 26ff4b8cb7SAlexander LeidingerINLINE_INHERITED_MEMB = NO 27ff4b8cb7SAlexander LeidingerFULL_PATH_NAMES = YES 2820cb1f56SAlexander LeidingerSTRIP_FROM_PATH = $(DOXYGEN_SRC_PATH) $(DOXYGEN_DEST_PATH) 29ff4b8cb7SAlexander LeidingerSTRIP_FROM_INC_PATH = 30ff4b8cb7SAlexander LeidingerSHORT_NAMES = NO 31ff4b8cb7SAlexander LeidingerJAVADOC_AUTOBRIEF = NO 32ff4b8cb7SAlexander LeidingerMULTILINE_CPP_IS_BRIEF = NO 33ff4b8cb7SAlexander LeidingerINHERIT_DOCS = YES 3420cb1f56SAlexander LeidingerSEPARATE_MEMBER_PAGES = NO 35ff4b8cb7SAlexander LeidingerTAB_SIZE = 8 36ff4b8cb7SAlexander LeidingerALIASES = 37ff4b8cb7SAlexander LeidingerOPTIMIZE_OUTPUT_FOR_C = YES 38ff4b8cb7SAlexander LeidingerOPTIMIZE_OUTPUT_JAVA = NO 3920cb1f56SAlexander LeidingerBUILTIN_STL_SUPPORT = NO 4020cb1f56SAlexander LeidingerCPP_CLI_SUPPORT = NO 4120cb1f56SAlexander LeidingerDISTRIBUTE_GROUP_DOC = NO 42ff4b8cb7SAlexander LeidingerSUBGROUPING = YES 43ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 44ff4b8cb7SAlexander Leidinger# Build related configuration options 45ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 46ff4b8cb7SAlexander LeidingerEXTRACT_PRIVATE = YES 47ff4b8cb7SAlexander LeidingerEXTRACT_STATIC = YES 48ff4b8cb7SAlexander LeidingerEXTRACT_LOCAL_CLASSES = YES 49ff4b8cb7SAlexander LeidingerEXTRACT_LOCAL_METHODS = NO 50ff4b8cb7SAlexander LeidingerHIDE_UNDOC_MEMBERS = NO 51ff4b8cb7SAlexander LeidingerHIDE_UNDOC_CLASSES = NO 52ff4b8cb7SAlexander LeidingerHIDE_FRIEND_COMPOUNDS = NO 53ff4b8cb7SAlexander LeidingerHIDE_IN_BODY_DOCS = NO 54ff4b8cb7SAlexander LeidingerINTERNAL_DOCS = YES 55ff4b8cb7SAlexander LeidingerCASE_SENSE_NAMES = YES 56ff4b8cb7SAlexander LeidingerHIDE_SCOPE_NAMES = NO 57ff4b8cb7SAlexander LeidingerSHOW_INCLUDE_FILES = YES 58ff4b8cb7SAlexander LeidingerINLINE_INFO = YES 59ff4b8cb7SAlexander LeidingerSORT_MEMBER_DOCS = YES 60ff4b8cb7SAlexander LeidingerSORT_BRIEF_DOCS = NO 61ff4b8cb7SAlexander LeidingerSORT_BY_SCOPE_NAME = NO 62ff4b8cb7SAlexander LeidingerGENERATE_TODOLIST = YES 63ff4b8cb7SAlexander LeidingerGENERATE_TESTLIST = YES 64ff4b8cb7SAlexander LeidingerGENERATE_BUGLIST = YES 65ff4b8cb7SAlexander LeidingerGENERATE_DEPRECATEDLIST= YES 66ff4b8cb7SAlexander LeidingerENABLED_SECTIONS = 67ff4b8cb7SAlexander LeidingerMAX_INITIALIZER_LINES = 30 68ff4b8cb7SAlexander LeidingerSHOW_USED_FILES = YES 69ff4b8cb7SAlexander LeidingerSHOW_DIRECTORIES = YES 70ff4b8cb7SAlexander LeidingerFILE_VERSION_FILTER = 71ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 72ff4b8cb7SAlexander Leidinger# configuration options related to warning and progress messages 73ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 74ff4b8cb7SAlexander LeidingerQUIET = NO 75ff4b8cb7SAlexander LeidingerWARNINGS = YES 76ff4b8cb7SAlexander LeidingerWARN_IF_UNDOCUMENTED = YES 77ff4b8cb7SAlexander LeidingerWARN_IF_DOC_ERROR = YES 78ff4b8cb7SAlexander LeidingerWARN_NO_PARAMDOC = NO 79ff4b8cb7SAlexander LeidingerWARN_FORMAT = "$file:$line: $text" 80ff4b8cb7SAlexander LeidingerWARN_LOGFILE = 8120cb1f56SAlexander Leidinger 82ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 83ff4b8cb7SAlexander Leidinger# configuration options related to the input files 84ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 8520cb1f56SAlexander LeidingerINPUT_ENCODING = UTF-8 86ff4b8cb7SAlexander LeidingerFILE_PATTERNS = *.c \ 87ff4b8cb7SAlexander Leidinger *.cc \ 88ff4b8cb7SAlexander Leidinger *.cxx \ 89ff4b8cb7SAlexander Leidinger *.cpp \ 90ff4b8cb7SAlexander Leidinger *.c++ \ 91ff4b8cb7SAlexander Leidinger *.java \ 92ff4b8cb7SAlexander Leidinger *.ii \ 93ff4b8cb7SAlexander Leidinger *.ixx \ 94ff4b8cb7SAlexander Leidinger *.ipp \ 95ff4b8cb7SAlexander Leidinger *.i++ \ 96ff4b8cb7SAlexander Leidinger *.inl \ 97ff4b8cb7SAlexander Leidinger *.h \ 98ff4b8cb7SAlexander Leidinger *.hh \ 99ff4b8cb7SAlexander Leidinger *.hxx \ 100ff4b8cb7SAlexander Leidinger *.hpp \ 101ff4b8cb7SAlexander Leidinger *.h++ \ 102ff4b8cb7SAlexander Leidinger *.idl \ 103ff4b8cb7SAlexander Leidinger *.odl \ 104ff4b8cb7SAlexander Leidinger *.cs \ 105ff4b8cb7SAlexander Leidinger *.php \ 106ff4b8cb7SAlexander Leidinger *.php3 \ 107ff4b8cb7SAlexander Leidinger *.inc \ 108ff4b8cb7SAlexander Leidinger *.m \ 109ff4b8cb7SAlexander Leidinger *.mm \ 110ff4b8cb7SAlexander Leidinger *.dox \ 111ff4b8cb7SAlexander Leidinger *.C \ 112ff4b8cb7SAlexander Leidinger *.CC \ 113ff4b8cb7SAlexander Leidinger *.C++ \ 114ff4b8cb7SAlexander Leidinger *.II \ 115ff4b8cb7SAlexander Leidinger *.I++ \ 116ff4b8cb7SAlexander Leidinger *.H \ 117ff4b8cb7SAlexander Leidinger *.HH \ 118ff4b8cb7SAlexander Leidinger *.H++ \ 119ff4b8cb7SAlexander Leidinger *.CS \ 120ff4b8cb7SAlexander Leidinger *.PHP \ 121ff4b8cb7SAlexander Leidinger *.PHP3 \ 122ff4b8cb7SAlexander Leidinger *.M \ 123ff4b8cb7SAlexander Leidinger *.MM 124ff4b8cb7SAlexander LeidingerRECURSIVE = YES 125ff4b8cb7SAlexander LeidingerEXCLUDE = 126ff4b8cb7SAlexander LeidingerEXCLUDE_SYMLINKS = NO 12720cb1f56SAlexander LeidingerEXCLUDE_PATTERNS = */.\#* */.svn/* 12820cb1f56SAlexander LeidingerEXCLUDE_SYMBOLS = 129ff4b8cb7SAlexander LeidingerEXAMPLE_PATH = 130ff4b8cb7SAlexander LeidingerEXAMPLE_PATTERNS = * 131ff4b8cb7SAlexander LeidingerEXAMPLE_RECURSIVE = NO 132ff4b8cb7SAlexander LeidingerIMAGE_PATH = 133ff4b8cb7SAlexander LeidingerINPUT_FILTER = 134ff4b8cb7SAlexander LeidingerFILTER_PATTERNS = 135ff4b8cb7SAlexander LeidingerFILTER_SOURCE_FILES = NO 136ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 137ff4b8cb7SAlexander Leidinger# configuration options related to source browsing 138ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 139ff4b8cb7SAlexander LeidingerSOURCE_BROWSER = YES 140ff4b8cb7SAlexander LeidingerINLINE_SOURCES = NO 141ff4b8cb7SAlexander LeidingerSTRIP_CODE_COMMENTS = YES 142ff4b8cb7SAlexander LeidingerREFERENCED_BY_RELATION = YES 143ff4b8cb7SAlexander LeidingerREFERENCES_RELATION = YES 14420cb1f56SAlexander LeidingerREFERENCES_LINK_SOURCE = YES 14520cb1f56SAlexander LeidingerUSE_HTAGS = NO 146ff4b8cb7SAlexander LeidingerVERBATIM_HEADERS = YES 147ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 148ff4b8cb7SAlexander Leidinger# configuration options related to the alphabetical class index 149ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 15020cb1f56SAlexander LeidingerALPHABETICAL_INDEX = YES 151ff4b8cb7SAlexander LeidingerCOLS_IN_ALPHA_INDEX = 5 152ff4b8cb7SAlexander LeidingerIGNORE_PREFIX = 153ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 154ff4b8cb7SAlexander Leidinger# configuration options related to the HTML output 155ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 156ff4b8cb7SAlexander LeidingerGENERATE_HTML = YES 157ff4b8cb7SAlexander LeidingerHTML_OUTPUT = html 158ff4b8cb7SAlexander LeidingerHTML_FILE_EXTENSION = .html 159ff4b8cb7SAlexander LeidingerHTML_HEADER = 160ff4b8cb7SAlexander LeidingerHTML_FOOTER = 161ff4b8cb7SAlexander LeidingerHTML_STYLESHEET = 162ff4b8cb7SAlexander LeidingerHTML_ALIGN_MEMBERS = YES 163ff4b8cb7SAlexander LeidingerGENERATE_HTMLHELP = NO 164ff4b8cb7SAlexander LeidingerCHM_FILE = 165ff4b8cb7SAlexander LeidingerHHC_LOCATION = 166ff4b8cb7SAlexander LeidingerGENERATE_CHI = NO 167ff4b8cb7SAlexander LeidingerBINARY_TOC = NO 168ff4b8cb7SAlexander LeidingerTOC_EXPAND = NO 169ff4b8cb7SAlexander LeidingerDISABLE_INDEX = NO 170ff4b8cb7SAlexander LeidingerENUM_VALUES_PER_LINE = 4 171ff4b8cb7SAlexander LeidingerGENERATE_TREEVIEW = YES 172ff4b8cb7SAlexander LeidingerTREEVIEW_WIDTH = 250 173ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 174ff4b8cb7SAlexander Leidinger# configuration options related to the LaTeX output 175ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 176ff4b8cb7SAlexander LeidingerGENERATE_LATEX = YES 177ff4b8cb7SAlexander LeidingerLATEX_OUTPUT = latex 178ff4b8cb7SAlexander LeidingerLATEX_CMD_NAME = latex 179ff4b8cb7SAlexander LeidingerMAKEINDEX_CMD_NAME = makeindex 180ff4b8cb7SAlexander LeidingerCOMPACT_LATEX = NO 181ff4b8cb7SAlexander LeidingerPAPER_TYPE = a4wide 182ff4b8cb7SAlexander LeidingerEXTRA_PACKAGES = 183ff4b8cb7SAlexander LeidingerLATEX_HEADER = 184ff4b8cb7SAlexander LeidingerPDF_HYPERLINKS = YES 185ff4b8cb7SAlexander LeidingerUSE_PDFLATEX = YES 186ff4b8cb7SAlexander LeidingerLATEX_BATCHMODE = NO 187ff4b8cb7SAlexander LeidingerLATEX_HIDE_INDICES = NO 188ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 189ff4b8cb7SAlexander Leidinger# configuration options related to the RTF output 190ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 191ff4b8cb7SAlexander LeidingerGENERATE_RTF = NO 192ff4b8cb7SAlexander LeidingerRTF_OUTPUT = rtf 193ff4b8cb7SAlexander LeidingerCOMPACT_RTF = NO 194ff4b8cb7SAlexander LeidingerRTF_HYPERLINKS = NO 195ff4b8cb7SAlexander LeidingerRTF_STYLESHEET_FILE = 196ff4b8cb7SAlexander LeidingerRTF_EXTENSIONS_FILE = 197ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 198ff4b8cb7SAlexander Leidinger# configuration options related to the man page output 199ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 200ff4b8cb7SAlexander LeidingerGENERATE_MAN = NO 201ff4b8cb7SAlexander LeidingerMAN_OUTPUT = man 202ff4b8cb7SAlexander LeidingerMAN_EXTENSION = .3 203ff4b8cb7SAlexander LeidingerMAN_LINKS = NO 204ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 205ff4b8cb7SAlexander Leidinger# configuration options related to the XML output 206ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 207ff4b8cb7SAlexander LeidingerGENERATE_XML = NO 208ff4b8cb7SAlexander LeidingerXML_OUTPUT = xml 209ff4b8cb7SAlexander LeidingerXML_SCHEMA = 210ff4b8cb7SAlexander LeidingerXML_DTD = 211ff4b8cb7SAlexander LeidingerXML_PROGRAMLISTING = YES 212ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 213ff4b8cb7SAlexander Leidinger# configuration options for the AutoGen Definitions output 214ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 215ff4b8cb7SAlexander LeidingerGENERATE_AUTOGEN_DEF = NO 216ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 217ff4b8cb7SAlexander Leidinger# configuration options related to the Perl module output 218ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 219ff4b8cb7SAlexander LeidingerGENERATE_PERLMOD = NO 220ff4b8cb7SAlexander LeidingerPERLMOD_LATEX = NO 221ff4b8cb7SAlexander LeidingerPERLMOD_PRETTY = YES 222ff4b8cb7SAlexander LeidingerPERLMOD_MAKEVAR_PREFIX = 223ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 224ff4b8cb7SAlexander Leidinger# Configuration options related to the preprocessor 225ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 226ff4b8cb7SAlexander LeidingerENABLE_PREPROCESSING = YES 227ff4b8cb7SAlexander LeidingerMACRO_EXPANSION = YES 228ff4b8cb7SAlexander LeidingerEXPAND_ONLY_PREDEF = YES 229ff4b8cb7SAlexander LeidingerSEARCH_INCLUDES = YES 23020cb1f56SAlexander LeidingerINCLUDE_PATH = $(DOXYGEN_SRC_INCLUDE_PATH) \ 23120cb1f56SAlexander Leidinger . 232ff4b8cb7SAlexander LeidingerINCLUDE_FILE_PATTERNS = *.h 233b5a02379SAlexander Leidinger# __FreeBSD__ is normally defined to the the major version number of 234*9b3e7585SAlexander Leidinger# FreeBSD. In the kernel source it is just checked if it is defined, and 235b5a02379SAlexander Leidinger# __FreeBSD_version is used for version dependend code. 236b5a02379SAlexander Leidinger# To make live simple on major version bumps, just define __FreeBSD__ to 1. 23720cb1f56SAlexander LeidingerPREDEFINED = _KERNEL \ 238b5a02379SAlexander Leidinger __FreeBSD__=1 \ 23920cb1f56SAlexander Leidinger __${TARGET_ARCH}__=1 \ 24020cb1f56SAlexander Leidinger __${TARGET_ARCH}=1 241ff4b8cb7SAlexander LeidingerEXPAND_AS_DEFINED = 242ff4b8cb7SAlexander LeidingerSKIP_FUNCTION_MACROS = YES 243ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 244ff4b8cb7SAlexander Leidinger# Configuration::additions related to external references 245ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 246ff4b8cb7SAlexander LeidingerALLEXTERNALS = NO 247ff4b8cb7SAlexander LeidingerEXTERNAL_GROUPS = YES 248ff4b8cb7SAlexander LeidingerPERL_PATH = /usr/bin/perl 249ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 250ff4b8cb7SAlexander Leidinger# Configuration options related to the dot tool 251ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 252ff4b8cb7SAlexander LeidingerCLASS_DIAGRAMS = NO 25320cb1f56SAlexander LeidingerMSCGEN_PATH = 254ff4b8cb7SAlexander LeidingerHIDE_UNDOC_RELATIONS = YES 255ff4b8cb7SAlexander LeidingerHAVE_DOT = YES 256ff4b8cb7SAlexander LeidingerCLASS_GRAPH = YES 257ff4b8cb7SAlexander LeidingerCOLLABORATION_GRAPH = YES 258ff4b8cb7SAlexander LeidingerGROUP_GRAPHS = YES 259ff4b8cb7SAlexander LeidingerUML_LOOK = NO 260ff4b8cb7SAlexander LeidingerTEMPLATE_RELATIONS = NO 261ff4b8cb7SAlexander LeidingerINCLUDE_GRAPH = YES 262ff4b8cb7SAlexander LeidingerINCLUDED_BY_GRAPH = YES 263ff4b8cb7SAlexander LeidingerCALL_GRAPH = YES 26420cb1f56SAlexander LeidingerCALLER_GRAPH = YES 265ff4b8cb7SAlexander LeidingerGRAPHICAL_HIERARCHY = YES 266ff4b8cb7SAlexander LeidingerDIRECTORY_GRAPH = YES 267ff4b8cb7SAlexander LeidingerDOT_IMAGE_FORMAT = png 268ff4b8cb7SAlexander LeidingerDOT_PATH = 269ff4b8cb7SAlexander LeidingerDOTFILE_DIRS = 27020cb1f56SAlexander LeidingerDOT_GRAPH_MAX_NODES = 50 271ff4b8cb7SAlexander LeidingerDOT_TRANSPARENT = NO 272ff4b8cb7SAlexander LeidingerDOT_MULTI_TARGETS = YES 273ff4b8cb7SAlexander LeidingerGENERATE_LEGEND = YES 274ff4b8cb7SAlexander LeidingerDOT_CLEANUP = YES 275ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 276ff4b8cb7SAlexander Leidinger# Configuration::additions related to the search engine 277ff4b8cb7SAlexander Leidinger#--------------------------------------------------------------------------- 278ff4b8cb7SAlexander LeidingerSEARCHENGINE = NO 279