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