1# Doxyfile 1.5.2
2
3# $FreeBSD$
4
5#---------------------------------------------------------------------------
6# Project related configuration options
7#---------------------------------------------------------------------------
8DOXYFILE_ENCODING      = UTF-8
9PROJECT_NUMBER         =
10CREATE_SUBDIRS         = YES
11OUTPUT_LANGUAGE        = English
12BRIEF_MEMBER_DESC      = YES
13REPEAT_BRIEF           = YES
14ABBREVIATE_BRIEF       = "The $name class" \
15                         "The $name widget" \
16                         "The $name file" \
17                         is \
18                         provides \
19                         specifies \
20                         contains \
21                         represents \
22                         a \
23                         an \
24                         the
25ALWAYS_DETAILED_SEC    = NO
26INLINE_INHERITED_MEMB  = NO
27FULL_PATH_NAMES        = YES
28STRIP_FROM_PATH        = $(DOXYGEN_SRC_PATH) $(DOXYGEN_DEST_PATH)
29STRIP_FROM_INC_PATH    =
30SHORT_NAMES            = NO
31JAVADOC_AUTOBRIEF      = NO
32MULTILINE_CPP_IS_BRIEF = NO
33INHERIT_DOCS           = YES
34SEPARATE_MEMBER_PAGES  = NO
35TAB_SIZE               = 8
36ALIASES                =
37OPTIMIZE_OUTPUT_FOR_C  = YES
38OPTIMIZE_OUTPUT_JAVA   = NO
39BUILTIN_STL_SUPPORT    = NO
40CPP_CLI_SUPPORT        = NO
41DISTRIBUTE_GROUP_DOC   = NO
42SUBGROUPING            = YES
43#---------------------------------------------------------------------------
44# Build related configuration options
45#---------------------------------------------------------------------------
46EXTRACT_PRIVATE        = YES
47EXTRACT_STATIC         = YES
48EXTRACT_LOCAL_CLASSES  = YES
49EXTRACT_LOCAL_METHODS  = NO
50HIDE_UNDOC_MEMBERS     = NO
51HIDE_UNDOC_CLASSES     = NO
52HIDE_FRIEND_COMPOUNDS  = NO
53HIDE_IN_BODY_DOCS      = NO
54INTERNAL_DOCS          = YES
55CASE_SENSE_NAMES       = YES
56HIDE_SCOPE_NAMES       = NO
57SHOW_INCLUDE_FILES     = YES
58INLINE_INFO            = YES
59SORT_MEMBER_DOCS       = YES
60SORT_BRIEF_DOCS        = NO
61SORT_BY_SCOPE_NAME     = NO
62GENERATE_TODOLIST      = YES
63GENERATE_TESTLIST      = YES
64GENERATE_BUGLIST       = YES
65GENERATE_DEPRECATEDLIST= YES
66ENABLED_SECTIONS       =
67MAX_INITIALIZER_LINES  = 30
68SHOW_USED_FILES        = YES
69SHOW_DIRECTORIES       = YES
70FILE_VERSION_FILTER    =
71#---------------------------------------------------------------------------
72# configuration options related to warning and progress messages
73#---------------------------------------------------------------------------
74QUIET                  = NO
75WARNINGS               = YES
76WARN_IF_UNDOCUMENTED   = YES
77WARN_IF_DOC_ERROR      = YES
78WARN_NO_PARAMDOC       = NO
79WARN_FORMAT            = "$file:$line: $text"
80WARN_LOGFILE           =
81
82#---------------------------------------------------------------------------
83# configuration options related to the input files
84#---------------------------------------------------------------------------
85INPUT_ENCODING         = UTF-8
86FILE_PATTERNS          = *.c \
87                         *.cc \
88                         *.cxx \
89                         *.cpp \
90                         *.c++ \
91                         *.java \
92                         *.ii \
93                         *.ixx \
94                         *.ipp \
95                         *.i++ \
96                         *.inl \
97                         *.h \
98                         *.hh \
99                         *.hxx \
100                         *.hpp \
101                         *.h++ \
102                         *.idl \
103                         *.odl \
104                         *.cs \
105                         *.php \
106                         *.php3 \
107                         *.inc \
108                         *.m \
109                         *.mm \
110                         *.dox \
111                         *.C \
112                         *.CC \
113                         *.C++ \
114                         *.II \
115                         *.I++ \
116                         *.H \
117                         *.HH \
118                         *.H++ \
119                         *.CS \
120                         *.PHP \
121                         *.PHP3 \
122                         *.M \
123                         *.MM
124RECURSIVE              = YES
125EXCLUDE                =
126EXCLUDE_SYMLINKS       = NO
127EXCLUDE_PATTERNS       = */.\#* */.svn/*
128EXCLUDE_SYMBOLS        =
129EXAMPLE_PATH           =
130EXAMPLE_PATTERNS       = *
131EXAMPLE_RECURSIVE      = NO
132IMAGE_PATH             =
133INPUT_FILTER           =
134FILTER_PATTERNS        =
135FILTER_SOURCE_FILES    = NO
136#---------------------------------------------------------------------------
137# configuration options related to source browsing
138#---------------------------------------------------------------------------
139SOURCE_BROWSER         = YES
140INLINE_SOURCES         = NO
141STRIP_CODE_COMMENTS    = YES
142REFERENCED_BY_RELATION = YES
143REFERENCES_RELATION    = YES
144REFERENCES_LINK_SOURCE = YES
145USE_HTAGS              = NO
146VERBATIM_HEADERS       = YES
147#---------------------------------------------------------------------------
148# configuration options related to the alphabetical class index
149#---------------------------------------------------------------------------
150ALPHABETICAL_INDEX     = YES
151COLS_IN_ALPHA_INDEX    = 5
152IGNORE_PREFIX          =
153#---------------------------------------------------------------------------
154# configuration options related to the HTML output
155#---------------------------------------------------------------------------
156GENERATE_HTML          = YES
157HTML_OUTPUT            = html
158HTML_FILE_EXTENSION    = .html
159HTML_HEADER            =
160HTML_FOOTER            =
161HTML_STYLESHEET        =
162HTML_ALIGN_MEMBERS     = YES
163GENERATE_HTMLHELP      = NO
164CHM_FILE               =
165HHC_LOCATION           =
166GENERATE_CHI           = NO
167BINARY_TOC             = NO
168TOC_EXPAND             = NO
169DISABLE_INDEX          = NO
170ENUM_VALUES_PER_LINE   = 4
171GENERATE_TREEVIEW      = YES
172TREEVIEW_WIDTH         = 250
173#---------------------------------------------------------------------------
174# configuration options related to the LaTeX output
175#---------------------------------------------------------------------------
176GENERATE_LATEX         = YES
177LATEX_OUTPUT           = latex
178LATEX_CMD_NAME         = latex
179MAKEINDEX_CMD_NAME     = makeindex
180COMPACT_LATEX          = NO
181PAPER_TYPE             = a4wide
182EXTRA_PACKAGES         =
183LATEX_HEADER           =
184PDF_HYPERLINKS         = YES
185USE_PDFLATEX           = YES
186LATEX_BATCHMODE        = NO
187LATEX_HIDE_INDICES     = NO
188#---------------------------------------------------------------------------
189# configuration options related to the RTF output
190#---------------------------------------------------------------------------
191GENERATE_RTF           = NO
192RTF_OUTPUT             = rtf
193COMPACT_RTF            = NO
194RTF_HYPERLINKS         = NO
195RTF_STYLESHEET_FILE    =
196RTF_EXTENSIONS_FILE    =
197#---------------------------------------------------------------------------
198# configuration options related to the man page output
199#---------------------------------------------------------------------------
200GENERATE_MAN           = NO
201MAN_OUTPUT             = man
202MAN_EXTENSION          = .3
203MAN_LINKS              = NO
204#---------------------------------------------------------------------------
205# configuration options related to the XML output
206#---------------------------------------------------------------------------
207GENERATE_XML           = NO
208XML_OUTPUT             = xml
209XML_SCHEMA             =
210XML_DTD                =
211XML_PROGRAMLISTING     = YES
212#---------------------------------------------------------------------------
213# configuration options for the AutoGen Definitions output
214#---------------------------------------------------------------------------
215GENERATE_AUTOGEN_DEF   = NO
216#---------------------------------------------------------------------------
217# configuration options related to the Perl module output
218#---------------------------------------------------------------------------
219GENERATE_PERLMOD       = NO
220PERLMOD_LATEX          = NO
221PERLMOD_PRETTY         = YES
222PERLMOD_MAKEVAR_PREFIX =
223#---------------------------------------------------------------------------
224# Configuration options related to the preprocessor
225#---------------------------------------------------------------------------
226ENABLE_PREPROCESSING   = YES
227MACRO_EXPANSION        = YES
228EXPAND_ONLY_PREDEF     = YES
229SEARCH_INCLUDES        = YES
230INCLUDE_PATH           = $(DOXYGEN_SRC_INCLUDE_PATH) \
231                         .
232INCLUDE_FILE_PATTERNS  = *.h
233# __FreeBSD__ is normally defined to the major version number of
234# FreeBSD. In the kernel source it is just checked if it is defined, and
235# __FreeBSD_version is used for version dependend code.
236# To make live simple on major version bumps, just define __FreeBSD__ to 1.
237PREDEFINED             = _KERNEL \
238                         __FreeBSD__=1 \
239                         __${TARGET_ARCH}__=1 \
240                         __${TARGET_ARCH}=1
241EXPAND_AS_DEFINED      =
242SKIP_FUNCTION_MACROS   = YES
243#---------------------------------------------------------------------------
244# Configuration::additions related to external references
245#---------------------------------------------------------------------------
246ALLEXTERNALS           = NO
247EXTERNAL_GROUPS        = YES
248PERL_PATH              = /usr/bin/perl
249#---------------------------------------------------------------------------
250# Configuration options related to the dot tool
251#---------------------------------------------------------------------------
252CLASS_DIAGRAMS         = NO
253MSCGEN_PATH            =
254HIDE_UNDOC_RELATIONS   = YES
255HAVE_DOT               = YES
256CLASS_GRAPH            = YES
257COLLABORATION_GRAPH    = YES
258GROUP_GRAPHS           = YES
259UML_LOOK               = NO
260TEMPLATE_RELATIONS     = NO
261INCLUDE_GRAPH          = YES
262INCLUDED_BY_GRAPH      = YES
263CALL_GRAPH             = YES
264CALLER_GRAPH           = YES
265GRAPHICAL_HIERARCHY    = YES
266DIRECTORY_GRAPH        = YES
267DOT_IMAGE_FORMAT       = png
268DOT_PATH               =
269DOTFILE_DIRS           =
270DOT_GRAPH_MAX_NODES    = 50
271DOT_TRANSPARENT        = NO
272DOT_MULTI_TARGETS      = YES
273GENERATE_LEGEND        = YES
274DOT_CLEANUP            = YES
275#---------------------------------------------------------------------------
276# Configuration::additions related to the search engine
277#---------------------------------------------------------------------------
278SEARCHENGINE           = NO
279