xref: /freebsd-src/tools/kerneldoc/Doxyfile (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
1*a52b6f78SDoug Rabson# Doxyfile 1.3.6
2*a52b6f78SDoug Rabson
3*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
4*a52b6f78SDoug Rabson# Project related configuration options
5*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
6*a52b6f78SDoug RabsonPROJECT_NAME           = "FreeBSD Kernel"
7*a52b6f78SDoug RabsonPROJECT_NUMBER         =
8*a52b6f78SDoug RabsonOUTPUT_DIRECTORY       =
9*a52b6f78SDoug RabsonOUTPUT_LANGUAGE        = English
10*a52b6f78SDoug RabsonUSE_WINDOWS_ENCODING   = NO
11*a52b6f78SDoug RabsonBRIEF_MEMBER_DESC      = YES
12*a52b6f78SDoug RabsonREPEAT_BRIEF           = YES
13*a52b6f78SDoug RabsonABBREVIATE_BRIEF       =
14*a52b6f78SDoug RabsonALWAYS_DETAILED_SEC    = NO
15*a52b6f78SDoug RabsonINLINE_INHERITED_MEMB  = NO
16*a52b6f78SDoug RabsonFULL_PATH_NAMES        = YES
17*a52b6f78SDoug RabsonSTRIP_FROM_PATH        =
18*a52b6f78SDoug RabsonSHORT_NAMES            = NO
19*a52b6f78SDoug RabsonJAVADOC_AUTOBRIEF      = NO
20*a52b6f78SDoug RabsonMULTILINE_CPP_IS_BRIEF = NO
21*a52b6f78SDoug RabsonDETAILS_AT_TOP         = NO
22*a52b6f78SDoug RabsonINHERIT_DOCS           = YES
23*a52b6f78SDoug RabsonDISTRIBUTE_GROUP_DOC   = NO
24*a52b6f78SDoug RabsonTAB_SIZE               = 8
25*a52b6f78SDoug RabsonALIASES                =
26*a52b6f78SDoug RabsonOPTIMIZE_OUTPUT_FOR_C  = YES
27*a52b6f78SDoug RabsonOPTIMIZE_OUTPUT_JAVA   = NO
28*a52b6f78SDoug RabsonSUBGROUPING            = YES
29*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
30*a52b6f78SDoug Rabson# Build related configuration options
31*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
32*a52b6f78SDoug RabsonEXTRACT_ALL            = YES
33*a52b6f78SDoug RabsonEXTRACT_PRIVATE        = NO
34*a52b6f78SDoug RabsonEXTRACT_STATIC         = YES
35*a52b6f78SDoug RabsonEXTRACT_LOCAL_CLASSES  = YES
36*a52b6f78SDoug RabsonHIDE_UNDOC_MEMBERS     = NO
37*a52b6f78SDoug RabsonHIDE_UNDOC_CLASSES     = NO
38*a52b6f78SDoug RabsonHIDE_FRIEND_COMPOUNDS  = NO
39*a52b6f78SDoug RabsonHIDE_IN_BODY_DOCS      = NO
40*a52b6f78SDoug RabsonINTERNAL_DOCS          = YES
41*a52b6f78SDoug RabsonCASE_SENSE_NAMES       = YES
42*a52b6f78SDoug RabsonHIDE_SCOPE_NAMES       = NO
43*a52b6f78SDoug RabsonSHOW_INCLUDE_FILES     = YES
44*a52b6f78SDoug RabsonINLINE_INFO            = YES
45*a52b6f78SDoug RabsonSORT_MEMBER_DOCS       = YES
46*a52b6f78SDoug RabsonSORT_BRIEF_DOCS        = NO
47*a52b6f78SDoug RabsonSORT_BY_SCOPE_NAME     = NO
48*a52b6f78SDoug RabsonGENERATE_TODOLIST      = YES
49*a52b6f78SDoug RabsonGENERATE_TESTLIST      = YES
50*a52b6f78SDoug RabsonGENERATE_BUGLIST       = YES
51*a52b6f78SDoug RabsonGENERATE_DEPRECATEDLIST= YES
52*a52b6f78SDoug RabsonENABLED_SECTIONS       =
53*a52b6f78SDoug RabsonMAX_INITIALIZER_LINES  = 30
54*a52b6f78SDoug RabsonSHOW_USED_FILES        = YES
55*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
56*a52b6f78SDoug Rabson# configuration options related to warning and progress messages
57*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
58*a52b6f78SDoug RabsonQUIET                  = NO
59*a52b6f78SDoug RabsonWARNINGS               = YES
60*a52b6f78SDoug RabsonWARN_IF_UNDOCUMENTED   = NO
61*a52b6f78SDoug RabsonWARN_IF_DOC_ERROR      = NO
62*a52b6f78SDoug RabsonWARN_FORMAT            = "$file:$line: $text"
63*a52b6f78SDoug RabsonWARN_LOGFILE           =
64*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
65*a52b6f78SDoug Rabson# configuration options related to the input files
66*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
67*a52b6f78SDoug RabsonINPUT                  =
68*a52b6f78SDoug RabsonFILE_PATTERNS          = *.c \
69*a52b6f78SDoug Rabson                         *.h
70*a52b6f78SDoug RabsonRECURSIVE              = YES
71*a52b6f78SDoug RabsonEXCLUDE                =
72*a52b6f78SDoug RabsonEXCLUDE_SYMLINKS       = NO
73*a52b6f78SDoug RabsonEXCLUDE_PATTERNS       =
74*a52b6f78SDoug RabsonEXAMPLE_PATH           =
75*a52b6f78SDoug RabsonEXAMPLE_PATTERNS       =
76*a52b6f78SDoug RabsonEXAMPLE_RECURSIVE      = NO
77*a52b6f78SDoug RabsonIMAGE_PATH             =
78*a52b6f78SDoug RabsonINPUT_FILTER           =
79*a52b6f78SDoug RabsonFILTER_SOURCE_FILES    = NO
80*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
81*a52b6f78SDoug Rabson# configuration options related to source browsing
82*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
83*a52b6f78SDoug RabsonSOURCE_BROWSER         = YES
84*a52b6f78SDoug RabsonINLINE_SOURCES         = NO
85*a52b6f78SDoug RabsonSTRIP_CODE_COMMENTS    = YES
86*a52b6f78SDoug RabsonREFERENCED_BY_RELATION = YES
87*a52b6f78SDoug RabsonREFERENCES_RELATION    = YES
88*a52b6f78SDoug RabsonVERBATIM_HEADERS       = YES
89*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
90*a52b6f78SDoug Rabson# configuration options related to the alphabetical class index
91*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
92*a52b6f78SDoug RabsonALPHABETICAL_INDEX     = YES
93*a52b6f78SDoug RabsonCOLS_IN_ALPHA_INDEX    = 5
94*a52b6f78SDoug RabsonIGNORE_PREFIX          =
95*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
96*a52b6f78SDoug Rabson# configuration options related to the HTML output
97*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
98*a52b6f78SDoug RabsonGENERATE_HTML          = YES
99*a52b6f78SDoug RabsonHTML_OUTPUT            = html
100*a52b6f78SDoug RabsonHTML_FILE_EXTENSION    = .html
101*a52b6f78SDoug RabsonHTML_HEADER            =
102*a52b6f78SDoug RabsonHTML_FOOTER            =
103*a52b6f78SDoug RabsonHTML_STYLESHEET        =
104*a52b6f78SDoug RabsonHTML_ALIGN_MEMBERS     = YES
105*a52b6f78SDoug RabsonGENERATE_HTMLHELP      = NO
106*a52b6f78SDoug RabsonCHM_FILE               =
107*a52b6f78SDoug RabsonHHC_LOCATION           =
108*a52b6f78SDoug RabsonGENERATE_CHI           = NO
109*a52b6f78SDoug RabsonBINARY_TOC             = NO
110*a52b6f78SDoug RabsonTOC_EXPAND             = NO
111*a52b6f78SDoug RabsonDISABLE_INDEX          = NO
112*a52b6f78SDoug RabsonENUM_VALUES_PER_LINE   = 4
113*a52b6f78SDoug RabsonGENERATE_TREEVIEW      = NO
114*a52b6f78SDoug RabsonTREEVIEW_WIDTH         = 250
115*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
116*a52b6f78SDoug Rabson# configuration options related to the LaTeX output
117*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
118*a52b6f78SDoug RabsonGENERATE_LATEX         = NO
119*a52b6f78SDoug RabsonLATEX_OUTPUT           = latex
120*a52b6f78SDoug RabsonLATEX_CMD_NAME         = latex
121*a52b6f78SDoug RabsonMAKEINDEX_CMD_NAME     = makeindex
122*a52b6f78SDoug RabsonCOMPACT_LATEX          = NO
123*a52b6f78SDoug RabsonPAPER_TYPE             = a4wide
124*a52b6f78SDoug RabsonEXTRA_PACKAGES         =
125*a52b6f78SDoug RabsonLATEX_HEADER           =
126*a52b6f78SDoug RabsonPDF_HYPERLINKS         = NO
127*a52b6f78SDoug RabsonUSE_PDFLATEX           = NO
128*a52b6f78SDoug RabsonLATEX_BATCHMODE        = NO
129*a52b6f78SDoug RabsonLATEX_HIDE_INDICES     = NO
130*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
131*a52b6f78SDoug Rabson# configuration options related to the RTF output
132*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
133*a52b6f78SDoug RabsonGENERATE_RTF           = NO
134*a52b6f78SDoug RabsonRTF_OUTPUT             = rtf
135*a52b6f78SDoug RabsonCOMPACT_RTF            = NO
136*a52b6f78SDoug RabsonRTF_HYPERLINKS         = NO
137*a52b6f78SDoug RabsonRTF_STYLESHEET_FILE    =
138*a52b6f78SDoug RabsonRTF_EXTENSIONS_FILE    =
139*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
140*a52b6f78SDoug Rabson# configuration options related to the man page output
141*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
142*a52b6f78SDoug RabsonGENERATE_MAN           = NO
143*a52b6f78SDoug RabsonMAN_OUTPUT             = man
144*a52b6f78SDoug RabsonMAN_EXTENSION          = .3
145*a52b6f78SDoug RabsonMAN_LINKS              = NO
146*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
147*a52b6f78SDoug Rabson# configuration options related to the XML output
148*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
149*a52b6f78SDoug RabsonGENERATE_XML           = NO
150*a52b6f78SDoug RabsonXML_OUTPUT             = xml
151*a52b6f78SDoug RabsonXML_SCHEMA             =
152*a52b6f78SDoug RabsonXML_DTD                =
153*a52b6f78SDoug RabsonXML_PROGRAMLISTING     = YES
154*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
155*a52b6f78SDoug Rabson# configuration options for the AutoGen Definitions output
156*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
157*a52b6f78SDoug RabsonGENERATE_AUTOGEN_DEF   = NO
158*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
159*a52b6f78SDoug Rabson# configuration options related to the Perl module output
160*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
161*a52b6f78SDoug RabsonGENERATE_PERLMOD       = NO
162*a52b6f78SDoug RabsonPERLMOD_LATEX          = NO
163*a52b6f78SDoug RabsonPERLMOD_PRETTY         = YES
164*a52b6f78SDoug RabsonPERLMOD_MAKEVAR_PREFIX =
165*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
166*a52b6f78SDoug Rabson# Configuration options related to the preprocessor
167*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
168*a52b6f78SDoug RabsonENABLE_PREPROCESSING   = YES
169*a52b6f78SDoug RabsonMACRO_EXPANSION        = NO
170*a52b6f78SDoug RabsonEXPAND_ONLY_PREDEF     = NO
171*a52b6f78SDoug RabsonSEARCH_INCLUDES        = YES
172*a52b6f78SDoug RabsonINCLUDE_PATH           =
173*a52b6f78SDoug RabsonINCLUDE_FILE_PATTERNS  =
174*a52b6f78SDoug RabsonPREDEFINED             = _KERNEL
175*a52b6f78SDoug RabsonEXPAND_AS_DEFINED      =
176*a52b6f78SDoug RabsonSKIP_FUNCTION_MACROS   = YES
177*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
178*a52b6f78SDoug Rabson# Configuration::additions related to external references
179*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
180*a52b6f78SDoug RabsonTAGFILES               =
181*a52b6f78SDoug RabsonGENERATE_TAGFILE       = kernel.tags
182*a52b6f78SDoug RabsonALLEXTERNALS           = NO
183*a52b6f78SDoug RabsonEXTERNAL_GROUPS        = YES
184*a52b6f78SDoug RabsonPERL_PATH              = /usr/bin/perl
185*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
186*a52b6f78SDoug Rabson# Configuration options related to the dot tool
187*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
188*a52b6f78SDoug RabsonCLASS_DIAGRAMS         = YES
189*a52b6f78SDoug RabsonHIDE_UNDOC_RELATIONS   = YES
190*a52b6f78SDoug RabsonHAVE_DOT               = NO
191*a52b6f78SDoug RabsonCLASS_GRAPH            = YES
192*a52b6f78SDoug RabsonCOLLABORATION_GRAPH    = YES
193*a52b6f78SDoug RabsonUML_LOOK               = NO
194*a52b6f78SDoug RabsonTEMPLATE_RELATIONS     = NO
195*a52b6f78SDoug RabsonINCLUDE_GRAPH          = YES
196*a52b6f78SDoug RabsonINCLUDED_BY_GRAPH      = YES
197*a52b6f78SDoug RabsonCALL_GRAPH             = NO
198*a52b6f78SDoug RabsonGRAPHICAL_HIERARCHY    = YES
199*a52b6f78SDoug RabsonDOT_IMAGE_FORMAT       = png
200*a52b6f78SDoug RabsonDOT_PATH               =
201*a52b6f78SDoug RabsonDOTFILE_DIRS           =
202*a52b6f78SDoug RabsonMAX_DOT_GRAPH_WIDTH    = 1024
203*a52b6f78SDoug RabsonMAX_DOT_GRAPH_HEIGHT   = 1024
204*a52b6f78SDoug RabsonMAX_DOT_GRAPH_DEPTH    = 0
205*a52b6f78SDoug RabsonGENERATE_LEGEND        = YES
206*a52b6f78SDoug RabsonDOT_CLEANUP            = YES
207*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
208*a52b6f78SDoug Rabson# Configuration::additions related to the search engine
209*a52b6f78SDoug Rabson#---------------------------------------------------------------------------
210*a52b6f78SDoug RabsonSEARCHENGINE           = NO
211