1196511Snetchild# Doxyfile 1.5.2
2158961Snetchild
3158961Snetchild# $FreeBSD: releng/11.0/tools/kerneldoc/subsys/common-Doxyfile 240518 2012-09-14 21:28:56Z eadler $
4158961Snetchild
5158961Snetchild#---------------------------------------------------------------------------
6158961Snetchild# Project related configuration options
7158961Snetchild#---------------------------------------------------------------------------
8196511SnetchildDOXYFILE_ENCODING      = UTF-8
9158961SnetchildPROJECT_NUMBER         = 
10158961SnetchildCREATE_SUBDIRS         = YES
11158961SnetchildOUTPUT_LANGUAGE        = English
12158961SnetchildBRIEF_MEMBER_DESC      = YES
13158961SnetchildREPEAT_BRIEF           = YES
14158961SnetchildABBREVIATE_BRIEF       = "The $name class" \
15158961Snetchild                         "The $name widget" \
16158961Snetchild                         "The $name file" \
17158961Snetchild                         is \
18158961Snetchild                         provides \
19158961Snetchild                         specifies \
20158961Snetchild                         contains \
21158961Snetchild                         represents \
22158961Snetchild                         a \
23158961Snetchild                         an \
24158961Snetchild                         the
25158961SnetchildALWAYS_DETAILED_SEC    = NO
26158961SnetchildINLINE_INHERITED_MEMB  = NO
27158961SnetchildFULL_PATH_NAMES        = YES
28196511SnetchildSTRIP_FROM_PATH        = $(DOXYGEN_SRC_PATH) $(DOXYGEN_DEST_PATH)
29158961SnetchildSTRIP_FROM_INC_PATH    = 
30158961SnetchildSHORT_NAMES            = NO
31158961SnetchildJAVADOC_AUTOBRIEF      = NO
32158961SnetchildMULTILINE_CPP_IS_BRIEF = NO
33158961SnetchildINHERIT_DOCS           = YES
34196511SnetchildSEPARATE_MEMBER_PAGES  = NO
35158961SnetchildTAB_SIZE               = 8
36158961SnetchildALIASES                = 
37158961SnetchildOPTIMIZE_OUTPUT_FOR_C  = YES
38158961SnetchildOPTIMIZE_OUTPUT_JAVA   = NO
39196511SnetchildBUILTIN_STL_SUPPORT    = NO
40196511SnetchildCPP_CLI_SUPPORT        = NO
41196511SnetchildDISTRIBUTE_GROUP_DOC   = NO
42158961SnetchildSUBGROUPING            = YES
43158961Snetchild#---------------------------------------------------------------------------
44158961Snetchild# Build related configuration options
45158961Snetchild#---------------------------------------------------------------------------
46158961SnetchildEXTRACT_PRIVATE        = YES
47158961SnetchildEXTRACT_STATIC         = YES
48158961SnetchildEXTRACT_LOCAL_CLASSES  = YES
49158961SnetchildEXTRACT_LOCAL_METHODS  = NO
50158961SnetchildHIDE_UNDOC_MEMBERS     = NO
51158961SnetchildHIDE_UNDOC_CLASSES     = NO
52158961SnetchildHIDE_FRIEND_COMPOUNDS  = NO
53158961SnetchildHIDE_IN_BODY_DOCS      = NO
54158961SnetchildINTERNAL_DOCS          = YES
55158961SnetchildCASE_SENSE_NAMES       = YES
56158961SnetchildHIDE_SCOPE_NAMES       = NO
57158961SnetchildSHOW_INCLUDE_FILES     = YES
58158961SnetchildINLINE_INFO            = YES
59158961SnetchildSORT_MEMBER_DOCS       = YES
60158961SnetchildSORT_BRIEF_DOCS        = NO
61158961SnetchildSORT_BY_SCOPE_NAME     = NO
62158961SnetchildGENERATE_TODOLIST      = YES
63158961SnetchildGENERATE_TESTLIST      = YES
64158961SnetchildGENERATE_BUGLIST       = YES
65158961SnetchildGENERATE_DEPRECATEDLIST= YES
66158961SnetchildENABLED_SECTIONS       = 
67158961SnetchildMAX_INITIALIZER_LINES  = 30
68158961SnetchildSHOW_USED_FILES        = YES
69158961SnetchildSHOW_DIRECTORIES       = YES
70158961SnetchildFILE_VERSION_FILTER    = 
71158961Snetchild#---------------------------------------------------------------------------
72158961Snetchild# configuration options related to warning and progress messages
73158961Snetchild#---------------------------------------------------------------------------
74158961SnetchildQUIET                  = NO
75158961SnetchildWARNINGS               = YES
76158961SnetchildWARN_IF_UNDOCUMENTED   = YES
77158961SnetchildWARN_IF_DOC_ERROR      = YES
78158961SnetchildWARN_NO_PARAMDOC       = NO
79158961SnetchildWARN_FORMAT            = "$file:$line: $text"
80158961SnetchildWARN_LOGFILE           = 
81196511Snetchild
82158961Snetchild#---------------------------------------------------------------------------
83158961Snetchild# configuration options related to the input files
84158961Snetchild#---------------------------------------------------------------------------
85196511SnetchildINPUT_ENCODING         = UTF-8
86158961SnetchildFILE_PATTERNS          = *.c \
87158961Snetchild                         *.cc \
88158961Snetchild                         *.cxx \
89158961Snetchild                         *.cpp \
90158961Snetchild                         *.c++ \
91158961Snetchild                         *.java \
92158961Snetchild                         *.ii \
93158961Snetchild                         *.ixx \
94158961Snetchild                         *.ipp \
95158961Snetchild                         *.i++ \
96158961Snetchild                         *.inl \
97158961Snetchild                         *.h \
98158961Snetchild                         *.hh \
99158961Snetchild                         *.hxx \
100158961Snetchild                         *.hpp \
101158961Snetchild                         *.h++ \
102158961Snetchild                         *.idl \
103158961Snetchild                         *.odl \
104158961Snetchild                         *.cs \
105158961Snetchild                         *.php \
106158961Snetchild                         *.php3 \
107158961Snetchild                         *.inc \
108158961Snetchild                         *.m \
109158961Snetchild                         *.mm \
110158961Snetchild                         *.dox \
111158961Snetchild                         *.C \
112158961Snetchild                         *.CC \
113158961Snetchild                         *.C++ \
114158961Snetchild                         *.II \
115158961Snetchild                         *.I++ \
116158961Snetchild                         *.H \
117158961Snetchild                         *.HH \
118158961Snetchild                         *.H++ \
119158961Snetchild                         *.CS \
120158961Snetchild                         *.PHP \
121158961Snetchild                         *.PHP3 \
122158961Snetchild                         *.M \
123158961Snetchild                         *.MM
124158961SnetchildRECURSIVE              = YES
125158961SnetchildEXCLUDE                = 
126158961SnetchildEXCLUDE_SYMLINKS       = NO
127196511SnetchildEXCLUDE_PATTERNS       = */.\#* */.svn/*
128196511SnetchildEXCLUDE_SYMBOLS        = 
129158961SnetchildEXAMPLE_PATH           = 
130158961SnetchildEXAMPLE_PATTERNS       = *
131158961SnetchildEXAMPLE_RECURSIVE      = NO
132158961SnetchildIMAGE_PATH             = 
133158961SnetchildINPUT_FILTER           = 
134158961SnetchildFILTER_PATTERNS        = 
135158961SnetchildFILTER_SOURCE_FILES    = NO
136158961Snetchild#---------------------------------------------------------------------------
137158961Snetchild# configuration options related to source browsing
138158961Snetchild#---------------------------------------------------------------------------
139158961SnetchildSOURCE_BROWSER         = YES
140158961SnetchildINLINE_SOURCES         = NO
141158961SnetchildSTRIP_CODE_COMMENTS    = YES
142158961SnetchildREFERENCED_BY_RELATION = YES
143158961SnetchildREFERENCES_RELATION    = YES
144196511SnetchildREFERENCES_LINK_SOURCE = YES
145196511SnetchildUSE_HTAGS              = NO
146158961SnetchildVERBATIM_HEADERS       = YES
147158961Snetchild#---------------------------------------------------------------------------
148158961Snetchild# configuration options related to the alphabetical class index
149158961Snetchild#---------------------------------------------------------------------------
150196511SnetchildALPHABETICAL_INDEX     = YES
151158961SnetchildCOLS_IN_ALPHA_INDEX    = 5
152158961SnetchildIGNORE_PREFIX          = 
153158961Snetchild#---------------------------------------------------------------------------
154158961Snetchild# configuration options related to the HTML output
155158961Snetchild#---------------------------------------------------------------------------
156158961SnetchildGENERATE_HTML          = YES
157158961SnetchildHTML_OUTPUT            = html
158158961SnetchildHTML_FILE_EXTENSION    = .html
159158961SnetchildHTML_HEADER            = 
160158961SnetchildHTML_FOOTER            = 
161158961SnetchildHTML_STYLESHEET        = 
162158961SnetchildHTML_ALIGN_MEMBERS     = YES
163158961SnetchildGENERATE_HTMLHELP      = NO
164158961SnetchildCHM_FILE               = 
165158961SnetchildHHC_LOCATION           = 
166158961SnetchildGENERATE_CHI           = NO
167158961SnetchildBINARY_TOC             = NO
168158961SnetchildTOC_EXPAND             = NO
169158961SnetchildDISABLE_INDEX          = NO
170158961SnetchildENUM_VALUES_PER_LINE   = 4
171158961SnetchildGENERATE_TREEVIEW      = YES
172158961SnetchildTREEVIEW_WIDTH         = 250
173158961Snetchild#---------------------------------------------------------------------------
174158961Snetchild# configuration options related to the LaTeX output
175158961Snetchild#---------------------------------------------------------------------------
176158961SnetchildGENERATE_LATEX         = YES
177158961SnetchildLATEX_OUTPUT           = latex
178158961SnetchildLATEX_CMD_NAME         = latex
179158961SnetchildMAKEINDEX_CMD_NAME     = makeindex
180158961SnetchildCOMPACT_LATEX          = NO
181158961SnetchildPAPER_TYPE             = a4wide
182158961SnetchildEXTRA_PACKAGES         = 
183158961SnetchildLATEX_HEADER           = 
184158961SnetchildPDF_HYPERLINKS         = YES
185158961SnetchildUSE_PDFLATEX           = YES
186158961SnetchildLATEX_BATCHMODE        = NO
187158961SnetchildLATEX_HIDE_INDICES     = NO
188158961Snetchild#---------------------------------------------------------------------------
189158961Snetchild# configuration options related to the RTF output
190158961Snetchild#---------------------------------------------------------------------------
191158961SnetchildGENERATE_RTF           = NO
192158961SnetchildRTF_OUTPUT             = rtf
193158961SnetchildCOMPACT_RTF            = NO
194158961SnetchildRTF_HYPERLINKS         = NO
195158961SnetchildRTF_STYLESHEET_FILE    = 
196158961SnetchildRTF_EXTENSIONS_FILE    = 
197158961Snetchild#---------------------------------------------------------------------------
198158961Snetchild# configuration options related to the man page output
199158961Snetchild#---------------------------------------------------------------------------
200158961SnetchildGENERATE_MAN           = NO
201158961SnetchildMAN_OUTPUT             = man
202158961SnetchildMAN_EXTENSION          = .3
203158961SnetchildMAN_LINKS              = NO
204158961Snetchild#---------------------------------------------------------------------------
205158961Snetchild# configuration options related to the XML output
206158961Snetchild#---------------------------------------------------------------------------
207158961SnetchildGENERATE_XML           = NO
208158961SnetchildXML_OUTPUT             = xml
209158961SnetchildXML_SCHEMA             = 
210158961SnetchildXML_DTD                = 
211158961SnetchildXML_PROGRAMLISTING     = YES
212158961Snetchild#---------------------------------------------------------------------------
213158961Snetchild# configuration options for the AutoGen Definitions output
214158961Snetchild#---------------------------------------------------------------------------
215158961SnetchildGENERATE_AUTOGEN_DEF   = NO
216158961Snetchild#---------------------------------------------------------------------------
217158961Snetchild# configuration options related to the Perl module output
218158961Snetchild#---------------------------------------------------------------------------
219158961SnetchildGENERATE_PERLMOD       = NO
220158961SnetchildPERLMOD_LATEX          = NO
221158961SnetchildPERLMOD_PRETTY         = YES
222158961SnetchildPERLMOD_MAKEVAR_PREFIX = 
223158961Snetchild#---------------------------------------------------------------------------
224158961Snetchild# Configuration options related to the preprocessor   
225158961Snetchild#---------------------------------------------------------------------------
226158961SnetchildENABLE_PREPROCESSING   = YES
227158961SnetchildMACRO_EXPANSION        = YES
228158961SnetchildEXPAND_ONLY_PREDEF     = YES
229158961SnetchildSEARCH_INCLUDES        = YES
230196511SnetchildINCLUDE_PATH           = $(DOXYGEN_SRC_INCLUDE_PATH) \
231196511Snetchild                         .
232158961SnetchildINCLUDE_FILE_PATTERNS  = *.h
233240518Seadler# __FreeBSD__ is normally defined to the major version number of
234230862Snetchild# FreeBSD. In the kernel source it is just checked if it is defined, and
235230509Snetchild# __FreeBSD_version is used for version dependend code.
236230509Snetchild# To make live simple on major version bumps, just define __FreeBSD__ to 1.
237196511SnetchildPREDEFINED             = _KERNEL \
238230509Snetchild                         __FreeBSD__=1 \
239196511Snetchild                         __${TARGET_ARCH}__=1 \
240196511Snetchild                         __${TARGET_ARCH}=1
241158961SnetchildEXPAND_AS_DEFINED      = 
242158961SnetchildSKIP_FUNCTION_MACROS   = YES
243158961Snetchild#---------------------------------------------------------------------------
244158961Snetchild# Configuration::additions related to external references   
245158961Snetchild#---------------------------------------------------------------------------
246158961SnetchildALLEXTERNALS           = NO
247158961SnetchildEXTERNAL_GROUPS        = YES
248158961SnetchildPERL_PATH              = /usr/bin/perl
249158961Snetchild#---------------------------------------------------------------------------
250158961Snetchild# Configuration options related to the dot tool   
251158961Snetchild#---------------------------------------------------------------------------
252158961SnetchildCLASS_DIAGRAMS         = NO
253196511SnetchildMSCGEN_PATH            = 
254158961SnetchildHIDE_UNDOC_RELATIONS   = YES
255158961SnetchildHAVE_DOT               = YES
256158961SnetchildCLASS_GRAPH            = YES
257158961SnetchildCOLLABORATION_GRAPH    = YES
258158961SnetchildGROUP_GRAPHS           = YES
259158961SnetchildUML_LOOK               = NO
260158961SnetchildTEMPLATE_RELATIONS     = NO
261158961SnetchildINCLUDE_GRAPH          = YES
262158961SnetchildINCLUDED_BY_GRAPH      = YES
263158961SnetchildCALL_GRAPH             = YES
264196511SnetchildCALLER_GRAPH           = YES
265158961SnetchildGRAPHICAL_HIERARCHY    = YES
266158961SnetchildDIRECTORY_GRAPH        = YES
267158961SnetchildDOT_IMAGE_FORMAT       = png
268158961SnetchildDOT_PATH               = 
269158961SnetchildDOTFILE_DIRS           = 
270196511SnetchildDOT_GRAPH_MAX_NODES    = 50
271158961SnetchildDOT_TRANSPARENT        = NO
272158961SnetchildDOT_MULTI_TARGETS      = YES
273158961SnetchildGENERATE_LEGEND        = YES
274158961SnetchildDOT_CLEANUP            = YES
275158961Snetchild#---------------------------------------------------------------------------
276158961Snetchild# Configuration::additions related to the search engine   
277158961Snetchild#---------------------------------------------------------------------------
278158961SnetchildSEARCHENGINE           = NO
279