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