xref: /freebsd/tools/kerneldoc/Doxyfile (revision b0d29bc47dba79f6f38e67eabadfb4b32ffd9390)
1# Doxyfile 1.3.6
2# $FreeBSD$
3
4#---------------------------------------------------------------------------
5# Project related configuration options
6#---------------------------------------------------------------------------
7PROJECT_NAME           = "FreeBSD Kernel"
8PROJECT_NUMBER         =
9OUTPUT_DIRECTORY       =
10OUTPUT_LANGUAGE        = English
11USE_WINDOWS_ENCODING   = NO
12BRIEF_MEMBER_DESC      = YES
13REPEAT_BRIEF           = YES
14ABBREVIATE_BRIEF       =
15ALWAYS_DETAILED_SEC    = NO
16INLINE_INHERITED_MEMB  = NO
17FULL_PATH_NAMES        = YES
18STRIP_FROM_PATH        =
19SHORT_NAMES            = NO
20JAVADOC_AUTOBRIEF      = NO
21MULTILINE_CPP_IS_BRIEF = NO
22DETAILS_AT_TOP         = NO
23INHERIT_DOCS           = YES
24DISTRIBUTE_GROUP_DOC   = NO
25TAB_SIZE               = 8
26ALIASES                =
27OPTIMIZE_OUTPUT_FOR_C  = YES
28OPTIMIZE_OUTPUT_JAVA   = NO
29SUBGROUPING            = YES
30#---------------------------------------------------------------------------
31# Build related configuration options
32#---------------------------------------------------------------------------
33EXTRACT_ALL            = YES
34EXTRACT_PRIVATE        = NO
35EXTRACT_STATIC         = YES
36EXTRACT_LOCAL_CLASSES  = YES
37HIDE_UNDOC_MEMBERS     = NO
38HIDE_UNDOC_CLASSES     = NO
39HIDE_FRIEND_COMPOUNDS  = NO
40HIDE_IN_BODY_DOCS      = NO
41INTERNAL_DOCS          = YES
42CASE_SENSE_NAMES       = YES
43HIDE_SCOPE_NAMES       = NO
44SHOW_INCLUDE_FILES     = YES
45INLINE_INFO            = YES
46SORT_MEMBER_DOCS       = YES
47SORT_BRIEF_DOCS        = NO
48SORT_BY_SCOPE_NAME     = NO
49GENERATE_TODOLIST      = YES
50GENERATE_TESTLIST      = YES
51GENERATE_BUGLIST       = YES
52GENERATE_DEPRECATEDLIST= YES
53ENABLED_SECTIONS       =
54MAX_INITIALIZER_LINES  = 30
55SHOW_USED_FILES        = YES
56#---------------------------------------------------------------------------
57# configuration options related to warning and progress messages
58#---------------------------------------------------------------------------
59QUIET                  = NO
60WARNINGS               = YES
61WARN_IF_UNDOCUMENTED   = NO
62WARN_IF_DOC_ERROR      = NO
63WARN_FORMAT            = "$file:$line: $text"
64WARN_LOGFILE           =
65#---------------------------------------------------------------------------
66# configuration options related to the input files
67#---------------------------------------------------------------------------
68INPUT                  =
69FILE_PATTERNS          = *.c \
70                         *.h
71RECURSIVE              = YES
72EXCLUDE                =
73EXCLUDE_SYMLINKS       = NO
74EXCLUDE_PATTERNS       =
75EXAMPLE_PATH           =
76EXAMPLE_PATTERNS       =
77EXAMPLE_RECURSIVE      = NO
78IMAGE_PATH             =
79INPUT_FILTER           =
80FILTER_SOURCE_FILES    = NO
81#---------------------------------------------------------------------------
82# configuration options related to source browsing
83#---------------------------------------------------------------------------
84SOURCE_BROWSER         = YES
85INLINE_SOURCES         = NO
86STRIP_CODE_COMMENTS    = YES
87REFERENCED_BY_RELATION = YES
88REFERENCES_RELATION    = YES
89VERBATIM_HEADERS       = YES
90#---------------------------------------------------------------------------
91# configuration options related to the alphabetical class index
92#---------------------------------------------------------------------------
93ALPHABETICAL_INDEX     = YES
94COLS_IN_ALPHA_INDEX    = 5
95IGNORE_PREFIX          =
96#---------------------------------------------------------------------------
97# configuration options related to the HTML output
98#---------------------------------------------------------------------------
99GENERATE_HTML          = YES
100HTML_OUTPUT            = html
101HTML_FILE_EXTENSION    = .html
102HTML_HEADER            =
103HTML_FOOTER            =
104HTML_STYLESHEET        =
105HTML_ALIGN_MEMBERS     = YES
106GENERATE_HTMLHELP      = NO
107CHM_FILE               =
108HHC_LOCATION           =
109GENERATE_CHI           = NO
110BINARY_TOC             = NO
111TOC_EXPAND             = NO
112DISABLE_INDEX          = NO
113ENUM_VALUES_PER_LINE   = 4
114GENERATE_TREEVIEW      = NO
115TREEVIEW_WIDTH         = 250
116#---------------------------------------------------------------------------
117# configuration options related to the LaTeX output
118#---------------------------------------------------------------------------
119GENERATE_LATEX         = NO
120LATEX_OUTPUT           = latex
121LATEX_CMD_NAME         = latex
122MAKEINDEX_CMD_NAME     = makeindex
123COMPACT_LATEX          = NO
124PAPER_TYPE             = a4wide
125EXTRA_PACKAGES         =
126LATEX_HEADER           =
127PDF_HYPERLINKS         = NO
128USE_PDFLATEX           = NO
129LATEX_BATCHMODE        = NO
130LATEX_HIDE_INDICES     = NO
131#---------------------------------------------------------------------------
132# configuration options related to the RTF output
133#---------------------------------------------------------------------------
134GENERATE_RTF           = NO
135RTF_OUTPUT             = rtf
136COMPACT_RTF            = NO
137RTF_HYPERLINKS         = NO
138RTF_STYLESHEET_FILE    =
139RTF_EXTENSIONS_FILE    =
140#---------------------------------------------------------------------------
141# configuration options related to the man page output
142#---------------------------------------------------------------------------
143GENERATE_MAN           = NO
144MAN_OUTPUT             = man
145MAN_EXTENSION          = .3
146MAN_LINKS              = NO
147#---------------------------------------------------------------------------
148# configuration options related to the XML output
149#---------------------------------------------------------------------------
150GENERATE_XML           = NO
151XML_OUTPUT             = xml
152XML_SCHEMA             =
153XML_DTD                =
154XML_PROGRAMLISTING     = YES
155#---------------------------------------------------------------------------
156# configuration options for the AutoGen Definitions output
157#---------------------------------------------------------------------------
158GENERATE_AUTOGEN_DEF   = NO
159#---------------------------------------------------------------------------
160# configuration options related to the Perl module output
161#---------------------------------------------------------------------------
162GENERATE_PERLMOD       = NO
163PERLMOD_LATEX          = NO
164PERLMOD_PRETTY         = YES
165PERLMOD_MAKEVAR_PREFIX =
166#---------------------------------------------------------------------------
167# Configuration options related to the preprocessor
168#---------------------------------------------------------------------------
169ENABLE_PREPROCESSING   = YES
170MACRO_EXPANSION        = NO
171EXPAND_ONLY_PREDEF     = NO
172SEARCH_INCLUDES        = YES
173INCLUDE_PATH           =
174INCLUDE_FILE_PATTERNS  =
175PREDEFINED             = _KERNEL
176EXPAND_AS_DEFINED      =
177SKIP_FUNCTION_MACROS   = YES
178#---------------------------------------------------------------------------
179# Configuration::additions related to external references
180#---------------------------------------------------------------------------
181TAGFILES               =
182GENERATE_TAGFILE       = kernel.tags
183ALLEXTERNALS           = NO
184EXTERNAL_GROUPS        = YES
185PERL_PATH              = /usr/bin/perl
186#---------------------------------------------------------------------------
187# Configuration options related to the dot tool
188#---------------------------------------------------------------------------
189CLASS_DIAGRAMS         = YES
190HIDE_UNDOC_RELATIONS   = YES
191HAVE_DOT               = NO
192CLASS_GRAPH            = YES
193COLLABORATION_GRAPH    = YES
194UML_LOOK               = NO
195TEMPLATE_RELATIONS     = NO
196INCLUDE_GRAPH          = YES
197INCLUDED_BY_GRAPH      = YES
198CALL_GRAPH             = NO
199GRAPHICAL_HIERARCHY    = YES
200DOT_IMAGE_FORMAT       = png
201DOT_PATH               =
202DOTFILE_DIRS           =
203MAX_DOT_GRAPH_WIDTH    = 1024
204MAX_DOT_GRAPH_HEIGHT   = 1024
205MAX_DOT_GRAPH_DEPTH    = 0
206GENERATE_LEGEND        = YES
207DOT_CLEANUP            = YES
208#---------------------------------------------------------------------------
209# Configuration::additions related to the search engine
210#---------------------------------------------------------------------------
211SEARCHENGINE           = NO
212