xref: /minix3/minix/lib/liblwip/dist/doc/doxygen/lwip.Doxyfile (revision 5d5fbe79c1b60734f34c69330aec5496644e8651)
1*5d5fbe79SDavid van Moolenbroek# Doxyfile 1.8.11
2*5d5fbe79SDavid van Moolenbroek
3*5d5fbe79SDavid van Moolenbroek# This file describes the settings to be used by the documentation system
4*5d5fbe79SDavid van Moolenbroek# doxygen (www.doxygen.org) for a project.
5*5d5fbe79SDavid van Moolenbroek#
6*5d5fbe79SDavid van Moolenbroek# All text after a double hash (##) is considered a comment and is placed in
7*5d5fbe79SDavid van Moolenbroek# front of the TAG it is preceding.
8*5d5fbe79SDavid van Moolenbroek#
9*5d5fbe79SDavid van Moolenbroek# All text after a single hash (#) is considered a comment and will be ignored.
10*5d5fbe79SDavid van Moolenbroek# The format is:
11*5d5fbe79SDavid van Moolenbroek# TAG = value [value, ...]
12*5d5fbe79SDavid van Moolenbroek# For lists, items can also be appended using:
13*5d5fbe79SDavid van Moolenbroek# TAG += value [value, ...]
14*5d5fbe79SDavid van Moolenbroek# Values that contain spaces should be placed between quotes (\" \").
15*5d5fbe79SDavid van Moolenbroek
16*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
17*5d5fbe79SDavid van Moolenbroek# Project related configuration options
18*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
19*5d5fbe79SDavid van Moolenbroek
20*5d5fbe79SDavid van Moolenbroek# This tag specifies the encoding used for all characters in the config file
21*5d5fbe79SDavid van Moolenbroek# that follow. The default is UTF-8 which is also the encoding used for all text
22*5d5fbe79SDavid van Moolenbroek# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23*5d5fbe79SDavid van Moolenbroek# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
24*5d5fbe79SDavid van Moolenbroek# for the list of possible encodings.
25*5d5fbe79SDavid van Moolenbroek# The default value is: UTF-8.
26*5d5fbe79SDavid van Moolenbroek
27*5d5fbe79SDavid van MoolenbroekDOXYFILE_ENCODING      = UTF-8
28*5d5fbe79SDavid van Moolenbroek
29*5d5fbe79SDavid van Moolenbroek# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30*5d5fbe79SDavid van Moolenbroek# double-quotes, unless you are using Doxywizard) that should identify the
31*5d5fbe79SDavid van Moolenbroek# project for which the documentation is generated. This name is used in the
32*5d5fbe79SDavid van Moolenbroek# title of most generated pages and in a few other places.
33*5d5fbe79SDavid van Moolenbroek# The default value is: My Project.
34*5d5fbe79SDavid van Moolenbroek
35*5d5fbe79SDavid van MoolenbroekPROJECT_NAME           = "lwIP"
36*5d5fbe79SDavid van Moolenbroek
37*5d5fbe79SDavid van Moolenbroek# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38*5d5fbe79SDavid van Moolenbroek# could be handy for archiving the generated documentation or if some version
39*5d5fbe79SDavid van Moolenbroek# control system is used.
40*5d5fbe79SDavid van Moolenbroek
41*5d5fbe79SDavid van MoolenbroekPROJECT_NUMBER         = "2.0.2"
42*5d5fbe79SDavid van Moolenbroek
43*5d5fbe79SDavid van Moolenbroek# Using the PROJECT_BRIEF tag one can provide an optional one line description
44*5d5fbe79SDavid van Moolenbroek# for a project that appears at the top of each page and should give viewer a
45*5d5fbe79SDavid van Moolenbroek# quick idea about the purpose of the project. Keep the description short.
46*5d5fbe79SDavid van Moolenbroek
47*5d5fbe79SDavid van MoolenbroekPROJECT_BRIEF          = "Lightweight IP stack"
48*5d5fbe79SDavid van Moolenbroek
49*5d5fbe79SDavid van Moolenbroek# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
50*5d5fbe79SDavid van Moolenbroek# in the documentation. The maximum height of the logo should not exceed 55
51*5d5fbe79SDavid van Moolenbroek# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
52*5d5fbe79SDavid van Moolenbroek# the logo to the output directory.
53*5d5fbe79SDavid van Moolenbroek
54*5d5fbe79SDavid van MoolenbroekPROJECT_LOGO           =
55*5d5fbe79SDavid van Moolenbroek
56*5d5fbe79SDavid van Moolenbroek# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57*5d5fbe79SDavid van Moolenbroek# into which the generated documentation will be written. If a relative path is
58*5d5fbe79SDavid van Moolenbroek# entered, it will be relative to the location where doxygen was started. If
59*5d5fbe79SDavid van Moolenbroek# left blank the current directory will be used.
60*5d5fbe79SDavid van Moolenbroek
61*5d5fbe79SDavid van MoolenbroekOUTPUT_DIRECTORY       = output
62*5d5fbe79SDavid van Moolenbroek
63*5d5fbe79SDavid van Moolenbroek# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
64*5d5fbe79SDavid van Moolenbroek# directories (in 2 levels) under the output directory of each output format and
65*5d5fbe79SDavid van Moolenbroek# will distribute the generated files over these directories. Enabling this
66*5d5fbe79SDavid van Moolenbroek# option can be useful when feeding doxygen a huge amount of source files, where
67*5d5fbe79SDavid van Moolenbroek# putting all generated files in the same directory would otherwise causes
68*5d5fbe79SDavid van Moolenbroek# performance problems for the file system.
69*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
70*5d5fbe79SDavid van Moolenbroek
71*5d5fbe79SDavid van MoolenbroekCREATE_SUBDIRS         = NO
72*5d5fbe79SDavid van Moolenbroek
73*5d5fbe79SDavid van Moolenbroek# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
74*5d5fbe79SDavid van Moolenbroek# characters to appear in the names of generated files. If set to NO, non-ASCII
75*5d5fbe79SDavid van Moolenbroek# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
76*5d5fbe79SDavid van Moolenbroek# U+3044.
77*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
78*5d5fbe79SDavid van Moolenbroek
79*5d5fbe79SDavid van MoolenbroekALLOW_UNICODE_NAMES    = NO
80*5d5fbe79SDavid van Moolenbroek
81*5d5fbe79SDavid van Moolenbroek# The OUTPUT_LANGUAGE tag is used to specify the language in which all
82*5d5fbe79SDavid van Moolenbroek# documentation generated by doxygen is written. Doxygen will use this
83*5d5fbe79SDavid van Moolenbroek# information to generate all constant output in the proper language.
84*5d5fbe79SDavid van Moolenbroek# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
85*5d5fbe79SDavid van Moolenbroek# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
86*5d5fbe79SDavid van Moolenbroek# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
87*5d5fbe79SDavid van Moolenbroek# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
88*5d5fbe79SDavid van Moolenbroek# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
89*5d5fbe79SDavid van Moolenbroek# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
90*5d5fbe79SDavid van Moolenbroek# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
91*5d5fbe79SDavid van Moolenbroek# Ukrainian and Vietnamese.
92*5d5fbe79SDavid van Moolenbroek# The default value is: English.
93*5d5fbe79SDavid van Moolenbroek
94*5d5fbe79SDavid van MoolenbroekOUTPUT_LANGUAGE        = English
95*5d5fbe79SDavid van Moolenbroek
96*5d5fbe79SDavid van Moolenbroek# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
97*5d5fbe79SDavid van Moolenbroek# descriptions after the members that are listed in the file and class
98*5d5fbe79SDavid van Moolenbroek# documentation (similar to Javadoc). Set to NO to disable this.
99*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
100*5d5fbe79SDavid van Moolenbroek
101*5d5fbe79SDavid van MoolenbroekBRIEF_MEMBER_DESC      = YES
102*5d5fbe79SDavid van Moolenbroek
103*5d5fbe79SDavid van Moolenbroek# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
104*5d5fbe79SDavid van Moolenbroek# description of a member or function before the detailed description
105*5d5fbe79SDavid van Moolenbroek#
106*5d5fbe79SDavid van Moolenbroek# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
107*5d5fbe79SDavid van Moolenbroek# brief descriptions will be completely suppressed.
108*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
109*5d5fbe79SDavid van Moolenbroek
110*5d5fbe79SDavid van MoolenbroekREPEAT_BRIEF           = YES
111*5d5fbe79SDavid van Moolenbroek
112*5d5fbe79SDavid van Moolenbroek# This tag implements a quasi-intelligent brief description abbreviator that is
113*5d5fbe79SDavid van Moolenbroek# used to form the text in various listings. Each string in this list, if found
114*5d5fbe79SDavid van Moolenbroek# as the leading text of the brief description, will be stripped from the text
115*5d5fbe79SDavid van Moolenbroek# and the result, after processing the whole list, is used as the annotated
116*5d5fbe79SDavid van Moolenbroek# text. Otherwise, the brief description is used as-is. If left blank, the
117*5d5fbe79SDavid van Moolenbroek# following values are used ($name is automatically replaced with the name of
118*5d5fbe79SDavid van Moolenbroek# the entity):The $name class, The $name widget, The $name file, is, provides,
119*5d5fbe79SDavid van Moolenbroek# specifies, contains, represents, a, an and the.
120*5d5fbe79SDavid van Moolenbroek
121*5d5fbe79SDavid van MoolenbroekABBREVIATE_BRIEF       = "The $name class       " \
122*5d5fbe79SDavid van Moolenbroek                         "The $name widget       " \
123*5d5fbe79SDavid van Moolenbroek                         "The $name file       " \
124*5d5fbe79SDavid van Moolenbroek                         is \
125*5d5fbe79SDavid van Moolenbroek                         provides \
126*5d5fbe79SDavid van Moolenbroek                         specifies \
127*5d5fbe79SDavid van Moolenbroek                         contains \
128*5d5fbe79SDavid van Moolenbroek                         represents \
129*5d5fbe79SDavid van Moolenbroek                         a \
130*5d5fbe79SDavid van Moolenbroek                         an \
131*5d5fbe79SDavid van Moolenbroek                         the
132*5d5fbe79SDavid van Moolenbroek
133*5d5fbe79SDavid van Moolenbroek# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
134*5d5fbe79SDavid van Moolenbroek# doxygen will generate a detailed section even if there is only a brief
135*5d5fbe79SDavid van Moolenbroek# description.
136*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
137*5d5fbe79SDavid van Moolenbroek
138*5d5fbe79SDavid van MoolenbroekALWAYS_DETAILED_SEC    = NO
139*5d5fbe79SDavid van Moolenbroek
140*5d5fbe79SDavid van Moolenbroek# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
141*5d5fbe79SDavid van Moolenbroek# inherited members of a class in the documentation of that class as if those
142*5d5fbe79SDavid van Moolenbroek# members were ordinary class members. Constructors, destructors and assignment
143*5d5fbe79SDavid van Moolenbroek# operators of the base classes will not be shown.
144*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
145*5d5fbe79SDavid van Moolenbroek
146*5d5fbe79SDavid van MoolenbroekINLINE_INHERITED_MEMB  = NO
147*5d5fbe79SDavid van Moolenbroek
148*5d5fbe79SDavid van Moolenbroek# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
149*5d5fbe79SDavid van Moolenbroek# before files name in the file list and in the header files. If set to NO the
150*5d5fbe79SDavid van Moolenbroek# shortest path that makes the file name unique will be used
151*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
152*5d5fbe79SDavid van Moolenbroek
153*5d5fbe79SDavid van MoolenbroekFULL_PATH_NAMES        = YES
154*5d5fbe79SDavid van Moolenbroek
155*5d5fbe79SDavid van Moolenbroek# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
156*5d5fbe79SDavid van Moolenbroek# Stripping is only done if one of the specified strings matches the left-hand
157*5d5fbe79SDavid van Moolenbroek# part of the path. The tag can be used to show relative paths in the file list.
158*5d5fbe79SDavid van Moolenbroek# If left blank the directory from which doxygen is run is used as the path to
159*5d5fbe79SDavid van Moolenbroek# strip.
160*5d5fbe79SDavid van Moolenbroek#
161*5d5fbe79SDavid van Moolenbroek# Note that you can specify absolute paths here, but also relative paths, which
162*5d5fbe79SDavid van Moolenbroek# will be relative from the directory where doxygen is started.
163*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag FULL_PATH_NAMES is set to YES.
164*5d5fbe79SDavid van Moolenbroek
165*5d5fbe79SDavid van MoolenbroekSTRIP_FROM_PATH        = ../../
166*5d5fbe79SDavid van Moolenbroek
167*5d5fbe79SDavid van Moolenbroek# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
168*5d5fbe79SDavid van Moolenbroek# path mentioned in the documentation of a class, which tells the reader which
169*5d5fbe79SDavid van Moolenbroek# header file to include in order to use a class. If left blank only the name of
170*5d5fbe79SDavid van Moolenbroek# the header file containing the class definition is used. Otherwise one should
171*5d5fbe79SDavid van Moolenbroek# specify the list of include paths that are normally passed to the compiler
172*5d5fbe79SDavid van Moolenbroek# using the -I flag.
173*5d5fbe79SDavid van Moolenbroek
174*5d5fbe79SDavid van MoolenbroekSTRIP_FROM_INC_PATH    =
175*5d5fbe79SDavid van Moolenbroek
176*5d5fbe79SDavid van Moolenbroek# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
177*5d5fbe79SDavid van Moolenbroek# less readable) file names. This can be useful is your file systems doesn't
178*5d5fbe79SDavid van Moolenbroek# support long names like on DOS, Mac, or CD-ROM.
179*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
180*5d5fbe79SDavid van Moolenbroek
181*5d5fbe79SDavid van MoolenbroekSHORT_NAMES            = NO
182*5d5fbe79SDavid van Moolenbroek
183*5d5fbe79SDavid van Moolenbroek# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
184*5d5fbe79SDavid van Moolenbroek# first line (until the first dot) of a Javadoc-style comment as the brief
185*5d5fbe79SDavid van Moolenbroek# description. If set to NO, the Javadoc-style will behave just like regular Qt-
186*5d5fbe79SDavid van Moolenbroek# style comments (thus requiring an explicit @brief command for a brief
187*5d5fbe79SDavid van Moolenbroek# description.)
188*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
189*5d5fbe79SDavid van Moolenbroek
190*5d5fbe79SDavid van MoolenbroekJAVADOC_AUTOBRIEF      = NO
191*5d5fbe79SDavid van Moolenbroek
192*5d5fbe79SDavid van Moolenbroek# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
193*5d5fbe79SDavid van Moolenbroek# line (until the first dot) of a Qt-style comment as the brief description. If
194*5d5fbe79SDavid van Moolenbroek# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
195*5d5fbe79SDavid van Moolenbroek# requiring an explicit \brief command for a brief description.)
196*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
197*5d5fbe79SDavid van Moolenbroek
198*5d5fbe79SDavid van MoolenbroekQT_AUTOBRIEF           = NO
199*5d5fbe79SDavid van Moolenbroek
200*5d5fbe79SDavid van Moolenbroek# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
201*5d5fbe79SDavid van Moolenbroek# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
202*5d5fbe79SDavid van Moolenbroek# a brief description. This used to be the default behavior. The new default is
203*5d5fbe79SDavid van Moolenbroek# to treat a multi-line C++ comment block as a detailed description. Set this
204*5d5fbe79SDavid van Moolenbroek# tag to YES if you prefer the old behavior instead.
205*5d5fbe79SDavid van Moolenbroek#
206*5d5fbe79SDavid van Moolenbroek# Note that setting this tag to YES also means that rational rose comments are
207*5d5fbe79SDavid van Moolenbroek# not recognized any more.
208*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
209*5d5fbe79SDavid van Moolenbroek
210*5d5fbe79SDavid van MoolenbroekMULTILINE_CPP_IS_BRIEF = NO
211*5d5fbe79SDavid van Moolenbroek
212*5d5fbe79SDavid van Moolenbroek# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
213*5d5fbe79SDavid van Moolenbroek# documentation from any documented member that it re-implements.
214*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
215*5d5fbe79SDavid van Moolenbroek
216*5d5fbe79SDavid van MoolenbroekINHERIT_DOCS           = YES
217*5d5fbe79SDavid van Moolenbroek
218*5d5fbe79SDavid van Moolenbroek# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
219*5d5fbe79SDavid van Moolenbroek# page for each member. If set to NO, the documentation of a member will be part
220*5d5fbe79SDavid van Moolenbroek# of the file/class/namespace that contains it.
221*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
222*5d5fbe79SDavid van Moolenbroek
223*5d5fbe79SDavid van MoolenbroekSEPARATE_MEMBER_PAGES  = NO
224*5d5fbe79SDavid van Moolenbroek
225*5d5fbe79SDavid van Moolenbroek# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
226*5d5fbe79SDavid van Moolenbroek# uses this value to replace tabs by spaces in code fragments.
227*5d5fbe79SDavid van Moolenbroek# Minimum value: 1, maximum value: 16, default value: 4.
228*5d5fbe79SDavid van Moolenbroek
229*5d5fbe79SDavid van MoolenbroekTAB_SIZE               = 8
230*5d5fbe79SDavid van Moolenbroek
231*5d5fbe79SDavid van Moolenbroek# This tag can be used to specify a number of aliases that act as commands in
232*5d5fbe79SDavid van Moolenbroek# the documentation. An alias has the form:
233*5d5fbe79SDavid van Moolenbroek# name=value
234*5d5fbe79SDavid van Moolenbroek# For example adding
235*5d5fbe79SDavid van Moolenbroek# "sideeffect=@par Side Effects:\n"
236*5d5fbe79SDavid van Moolenbroek# will allow you to put the command \sideeffect (or @sideeffect) in the
237*5d5fbe79SDavid van Moolenbroek# documentation, which will result in a user-defined paragraph with heading
238*5d5fbe79SDavid van Moolenbroek# "Side Effects:". You can put \n's in the value part of an alias to insert
239*5d5fbe79SDavid van Moolenbroek# newlines.
240*5d5fbe79SDavid van Moolenbroek
241*5d5fbe79SDavid van MoolenbroekALIASES                =
242*5d5fbe79SDavid van Moolenbroek
243*5d5fbe79SDavid van Moolenbroek# This tag can be used to specify a number of word-keyword mappings (TCL only).
244*5d5fbe79SDavid van Moolenbroek# A mapping has the form "name=value". For example adding "class=itcl::class"
245*5d5fbe79SDavid van Moolenbroek# will allow you to use the command class in the itcl::class meaning.
246*5d5fbe79SDavid van Moolenbroek
247*5d5fbe79SDavid van MoolenbroekTCL_SUBST              =
248*5d5fbe79SDavid van Moolenbroek
249*5d5fbe79SDavid van Moolenbroek# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
250*5d5fbe79SDavid van Moolenbroek# only. Doxygen will then generate output that is more tailored for C. For
251*5d5fbe79SDavid van Moolenbroek# instance, some of the names that are used will be different. The list of all
252*5d5fbe79SDavid van Moolenbroek# members will be omitted, etc.
253*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
254*5d5fbe79SDavid van Moolenbroek
255*5d5fbe79SDavid van MoolenbroekOPTIMIZE_OUTPUT_FOR_C  = YES
256*5d5fbe79SDavid van Moolenbroek
257*5d5fbe79SDavid van Moolenbroek# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
258*5d5fbe79SDavid van Moolenbroek# Python sources only. Doxygen will then generate output that is more tailored
259*5d5fbe79SDavid van Moolenbroek# for that language. For instance, namespaces will be presented as packages,
260*5d5fbe79SDavid van Moolenbroek# qualified scopes will look different, etc.
261*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
262*5d5fbe79SDavid van Moolenbroek
263*5d5fbe79SDavid van MoolenbroekOPTIMIZE_OUTPUT_JAVA   = NO
264*5d5fbe79SDavid van Moolenbroek
265*5d5fbe79SDavid van Moolenbroek# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
266*5d5fbe79SDavid van Moolenbroek# sources. Doxygen will then generate output that is tailored for Fortran.
267*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
268*5d5fbe79SDavid van Moolenbroek
269*5d5fbe79SDavid van MoolenbroekOPTIMIZE_FOR_FORTRAN   = NO
270*5d5fbe79SDavid van Moolenbroek
271*5d5fbe79SDavid van Moolenbroek# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
272*5d5fbe79SDavid van Moolenbroek# sources. Doxygen will then generate output that is tailored for VHDL.
273*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
274*5d5fbe79SDavid van Moolenbroek
275*5d5fbe79SDavid van MoolenbroekOPTIMIZE_OUTPUT_VHDL   = NO
276*5d5fbe79SDavid van Moolenbroek
277*5d5fbe79SDavid van Moolenbroek# Doxygen selects the parser to use depending on the extension of the files it
278*5d5fbe79SDavid van Moolenbroek# parses. With this tag you can assign which parser to use for a given
279*5d5fbe79SDavid van Moolenbroek# extension. Doxygen has a built-in mapping, but you can override or extend it
280*5d5fbe79SDavid van Moolenbroek# using this tag. The format is ext=language, where ext is a file extension, and
281*5d5fbe79SDavid van Moolenbroek# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
282*5d5fbe79SDavid van Moolenbroek# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
283*5d5fbe79SDavid van Moolenbroek# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
284*5d5fbe79SDavid van Moolenbroek# Fortran. In the later case the parser tries to guess whether the code is fixed
285*5d5fbe79SDavid van Moolenbroek# or free formatted code, this is the default for Fortran type files), VHDL. For
286*5d5fbe79SDavid van Moolenbroek# instance to make doxygen treat .inc files as Fortran files (default is PHP),
287*5d5fbe79SDavid van Moolenbroek# and .f files as C (default is Fortran), use: inc=Fortran f=C.
288*5d5fbe79SDavid van Moolenbroek#
289*5d5fbe79SDavid van Moolenbroek# Note: For files without extension you can use no_extension as a placeholder.
290*5d5fbe79SDavid van Moolenbroek#
291*5d5fbe79SDavid van Moolenbroek# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
292*5d5fbe79SDavid van Moolenbroek# the files are not read by doxygen.
293*5d5fbe79SDavid van Moolenbroek
294*5d5fbe79SDavid van MoolenbroekEXTENSION_MAPPING      =
295*5d5fbe79SDavid van Moolenbroek
296*5d5fbe79SDavid van Moolenbroek# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
297*5d5fbe79SDavid van Moolenbroek# according to the Markdown format, which allows for more readable
298*5d5fbe79SDavid van Moolenbroek# documentation. See http://daringfireball.net/projects/markdown/ for details.
299*5d5fbe79SDavid van Moolenbroek# The output of markdown processing is further processed by doxygen, so you can
300*5d5fbe79SDavid van Moolenbroek# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
301*5d5fbe79SDavid van Moolenbroek# case of backward compatibilities issues.
302*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
303*5d5fbe79SDavid van Moolenbroek
304*5d5fbe79SDavid van MoolenbroekMARKDOWN_SUPPORT       = YES
305*5d5fbe79SDavid van Moolenbroek
306*5d5fbe79SDavid van Moolenbroek# When enabled doxygen tries to link words that correspond to documented
307*5d5fbe79SDavid van Moolenbroek# classes, or namespaces to their corresponding documentation. Such a link can
308*5d5fbe79SDavid van Moolenbroek# be prevented in individual cases by putting a % sign in front of the word or
309*5d5fbe79SDavid van Moolenbroek# globally by setting AUTOLINK_SUPPORT to NO.
310*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
311*5d5fbe79SDavid van Moolenbroek
312*5d5fbe79SDavid van MoolenbroekAUTOLINK_SUPPORT       = YES
313*5d5fbe79SDavid van Moolenbroek
314*5d5fbe79SDavid van Moolenbroek# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
315*5d5fbe79SDavid van Moolenbroek# to include (a tag file for) the STL sources as input, then you should set this
316*5d5fbe79SDavid van Moolenbroek# tag to YES in order to let doxygen match functions declarations and
317*5d5fbe79SDavid van Moolenbroek# definitions whose arguments contain STL classes (e.g. func(std::string);
318*5d5fbe79SDavid van Moolenbroek# versus func(std::string) {}). This also make the inheritance and collaboration
319*5d5fbe79SDavid van Moolenbroek# diagrams that involve STL classes more complete and accurate.
320*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
321*5d5fbe79SDavid van Moolenbroek
322*5d5fbe79SDavid van MoolenbroekBUILTIN_STL_SUPPORT    = NO
323*5d5fbe79SDavid van Moolenbroek
324*5d5fbe79SDavid van Moolenbroek# If you use Microsoft's C++/CLI language, you should set this option to YES to
325*5d5fbe79SDavid van Moolenbroek# enable parsing support.
326*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
327*5d5fbe79SDavid van Moolenbroek
328*5d5fbe79SDavid van MoolenbroekCPP_CLI_SUPPORT        = NO
329*5d5fbe79SDavid van Moolenbroek
330*5d5fbe79SDavid van Moolenbroek# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
331*5d5fbe79SDavid van Moolenbroek# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
332*5d5fbe79SDavid van Moolenbroek# will parse them like normal C++ but will assume all classes use public instead
333*5d5fbe79SDavid van Moolenbroek# of private inheritance when no explicit protection keyword is present.
334*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
335*5d5fbe79SDavid van Moolenbroek
336*5d5fbe79SDavid van MoolenbroekSIP_SUPPORT            = NO
337*5d5fbe79SDavid van Moolenbroek
338*5d5fbe79SDavid van Moolenbroek# For Microsoft's IDL there are propget and propput attributes to indicate
339*5d5fbe79SDavid van Moolenbroek# getter and setter methods for a property. Setting this option to YES will make
340*5d5fbe79SDavid van Moolenbroek# doxygen to replace the get and set methods by a property in the documentation.
341*5d5fbe79SDavid van Moolenbroek# This will only work if the methods are indeed getting or setting a simple
342*5d5fbe79SDavid van Moolenbroek# type. If this is not the case, or you want to show the methods anyway, you
343*5d5fbe79SDavid van Moolenbroek# should set this option to NO.
344*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
345*5d5fbe79SDavid van Moolenbroek
346*5d5fbe79SDavid van MoolenbroekIDL_PROPERTY_SUPPORT   = YES
347*5d5fbe79SDavid van Moolenbroek
348*5d5fbe79SDavid van Moolenbroek# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
349*5d5fbe79SDavid van Moolenbroek# tag is set to YES then doxygen will reuse the documentation of the first
350*5d5fbe79SDavid van Moolenbroek# member in the group (if any) for the other members of the group. By default
351*5d5fbe79SDavid van Moolenbroek# all members of a group must be documented explicitly.
352*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
353*5d5fbe79SDavid van Moolenbroek
354*5d5fbe79SDavid van MoolenbroekDISTRIBUTE_GROUP_DOC   = NO
355*5d5fbe79SDavid van Moolenbroek
356*5d5fbe79SDavid van Moolenbroek# If one adds a struct or class to a group and this option is enabled, then also
357*5d5fbe79SDavid van Moolenbroek# any nested class or struct is added to the same group. By default this option
358*5d5fbe79SDavid van Moolenbroek# is disabled and one has to add nested compounds explicitly via \ingroup.
359*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
360*5d5fbe79SDavid van Moolenbroek
361*5d5fbe79SDavid van MoolenbroekGROUP_NESTED_COMPOUNDS = NO
362*5d5fbe79SDavid van Moolenbroek
363*5d5fbe79SDavid van Moolenbroek# Set the SUBGROUPING tag to YES to allow class member groups of the same type
364*5d5fbe79SDavid van Moolenbroek# (for instance a group of public functions) to be put as a subgroup of that
365*5d5fbe79SDavid van Moolenbroek# type (e.g. under the Public Functions section). Set it to NO to prevent
366*5d5fbe79SDavid van Moolenbroek# subgrouping. Alternatively, this can be done per class using the
367*5d5fbe79SDavid van Moolenbroek# \nosubgrouping command.
368*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
369*5d5fbe79SDavid van Moolenbroek
370*5d5fbe79SDavid van MoolenbroekSUBGROUPING            = YES
371*5d5fbe79SDavid van Moolenbroek
372*5d5fbe79SDavid van Moolenbroek# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
373*5d5fbe79SDavid van Moolenbroek# are shown inside the group in which they are included (e.g. using \ingroup)
374*5d5fbe79SDavid van Moolenbroek# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
375*5d5fbe79SDavid van Moolenbroek# and RTF).
376*5d5fbe79SDavid van Moolenbroek#
377*5d5fbe79SDavid van Moolenbroek# Note that this feature does not work in combination with
378*5d5fbe79SDavid van Moolenbroek# SEPARATE_MEMBER_PAGES.
379*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
380*5d5fbe79SDavid van Moolenbroek
381*5d5fbe79SDavid van MoolenbroekINLINE_GROUPED_CLASSES = NO
382*5d5fbe79SDavid van Moolenbroek
383*5d5fbe79SDavid van Moolenbroek# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
384*5d5fbe79SDavid van Moolenbroek# with only public data fields or simple typedef fields will be shown inline in
385*5d5fbe79SDavid van Moolenbroek# the documentation of the scope in which they are defined (i.e. file,
386*5d5fbe79SDavid van Moolenbroek# namespace, or group documentation), provided this scope is documented. If set
387*5d5fbe79SDavid van Moolenbroek# to NO, structs, classes, and unions are shown on a separate page (for HTML and
388*5d5fbe79SDavid van Moolenbroek# Man pages) or section (for LaTeX and RTF).
389*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
390*5d5fbe79SDavid van Moolenbroek
391*5d5fbe79SDavid van MoolenbroekINLINE_SIMPLE_STRUCTS  = NO
392*5d5fbe79SDavid van Moolenbroek
393*5d5fbe79SDavid van Moolenbroek# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
394*5d5fbe79SDavid van Moolenbroek# enum is documented as struct, union, or enum with the name of the typedef. So
395*5d5fbe79SDavid van Moolenbroek# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
396*5d5fbe79SDavid van Moolenbroek# with name TypeT. When disabled the typedef will appear as a member of a file,
397*5d5fbe79SDavid van Moolenbroek# namespace, or class. And the struct will be named TypeS. This can typically be
398*5d5fbe79SDavid van Moolenbroek# useful for C code in case the coding convention dictates that all compound
399*5d5fbe79SDavid van Moolenbroek# types are typedef'ed and only the typedef is referenced, never the tag name.
400*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
401*5d5fbe79SDavid van Moolenbroek
402*5d5fbe79SDavid van MoolenbroekTYPEDEF_HIDES_STRUCT   = NO
403*5d5fbe79SDavid van Moolenbroek
404*5d5fbe79SDavid van Moolenbroek# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
405*5d5fbe79SDavid van Moolenbroek# cache is used to resolve symbols given their name and scope. Since this can be
406*5d5fbe79SDavid van Moolenbroek# an expensive process and often the same symbol appears multiple times in the
407*5d5fbe79SDavid van Moolenbroek# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
408*5d5fbe79SDavid van Moolenbroek# doxygen will become slower. If the cache is too large, memory is wasted. The
409*5d5fbe79SDavid van Moolenbroek# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
410*5d5fbe79SDavid van Moolenbroek# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
411*5d5fbe79SDavid van Moolenbroek# symbols. At the end of a run doxygen will report the cache usage and suggest
412*5d5fbe79SDavid van Moolenbroek# the optimal cache size from a speed point of view.
413*5d5fbe79SDavid van Moolenbroek# Minimum value: 0, maximum value: 9, default value: 0.
414*5d5fbe79SDavid van Moolenbroek
415*5d5fbe79SDavid van MoolenbroekLOOKUP_CACHE_SIZE      = 0
416*5d5fbe79SDavid van Moolenbroek
417*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
418*5d5fbe79SDavid van Moolenbroek# Build related configuration options
419*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
420*5d5fbe79SDavid van Moolenbroek
421*5d5fbe79SDavid van Moolenbroek# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
422*5d5fbe79SDavid van Moolenbroek# documentation are documented, even if no documentation was available. Private
423*5d5fbe79SDavid van Moolenbroek# class members and static file members will be hidden unless the
424*5d5fbe79SDavid van Moolenbroek# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
425*5d5fbe79SDavid van Moolenbroek# Note: This will also disable the warnings about undocumented members that are
426*5d5fbe79SDavid van Moolenbroek# normally produced when WARNINGS is set to YES.
427*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
428*5d5fbe79SDavid van Moolenbroek
429*5d5fbe79SDavid van MoolenbroekEXTRACT_ALL            = NO
430*5d5fbe79SDavid van Moolenbroek
431*5d5fbe79SDavid van Moolenbroek# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
432*5d5fbe79SDavid van Moolenbroek# be included in the documentation.
433*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
434*5d5fbe79SDavid van Moolenbroek
435*5d5fbe79SDavid van MoolenbroekEXTRACT_PRIVATE        = NO
436*5d5fbe79SDavid van Moolenbroek
437*5d5fbe79SDavid van Moolenbroek# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
438*5d5fbe79SDavid van Moolenbroek# scope will be included in the documentation.
439*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
440*5d5fbe79SDavid van Moolenbroek
441*5d5fbe79SDavid van MoolenbroekEXTRACT_PACKAGE        = NO
442*5d5fbe79SDavid van Moolenbroek
443*5d5fbe79SDavid van Moolenbroek# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
444*5d5fbe79SDavid van Moolenbroek# included in the documentation.
445*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
446*5d5fbe79SDavid van Moolenbroek
447*5d5fbe79SDavid van MoolenbroekEXTRACT_STATIC         = NO
448*5d5fbe79SDavid van Moolenbroek
449*5d5fbe79SDavid van Moolenbroek# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
450*5d5fbe79SDavid van Moolenbroek# locally in source files will be included in the documentation. If set to NO,
451*5d5fbe79SDavid van Moolenbroek# only classes defined in header files are included. Does not have any effect
452*5d5fbe79SDavid van Moolenbroek# for Java sources.
453*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
454*5d5fbe79SDavid van Moolenbroek
455*5d5fbe79SDavid van MoolenbroekEXTRACT_LOCAL_CLASSES  = YES
456*5d5fbe79SDavid van Moolenbroek
457*5d5fbe79SDavid van Moolenbroek# This flag is only useful for Objective-C code. If set to YES, local methods,
458*5d5fbe79SDavid van Moolenbroek# which are defined in the implementation section but not in the interface are
459*5d5fbe79SDavid van Moolenbroek# included in the documentation. If set to NO, only methods in the interface are
460*5d5fbe79SDavid van Moolenbroek# included.
461*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
462*5d5fbe79SDavid van Moolenbroek
463*5d5fbe79SDavid van MoolenbroekEXTRACT_LOCAL_METHODS  = NO
464*5d5fbe79SDavid van Moolenbroek
465*5d5fbe79SDavid van Moolenbroek# If this flag is set to YES, the members of anonymous namespaces will be
466*5d5fbe79SDavid van Moolenbroek# extracted and appear in the documentation as a namespace called
467*5d5fbe79SDavid van Moolenbroek# 'anonymous_namespace{file}', where file will be replaced with the base name of
468*5d5fbe79SDavid van Moolenbroek# the file that contains the anonymous namespace. By default anonymous namespace
469*5d5fbe79SDavid van Moolenbroek# are hidden.
470*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
471*5d5fbe79SDavid van Moolenbroek
472*5d5fbe79SDavid van MoolenbroekEXTRACT_ANON_NSPACES   = NO
473*5d5fbe79SDavid van Moolenbroek
474*5d5fbe79SDavid van Moolenbroek# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
475*5d5fbe79SDavid van Moolenbroek# undocumented members inside documented classes or files. If set to NO these
476*5d5fbe79SDavid van Moolenbroek# members will be included in the various overviews, but no documentation
477*5d5fbe79SDavid van Moolenbroek# section is generated. This option has no effect if EXTRACT_ALL is enabled.
478*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
479*5d5fbe79SDavid van Moolenbroek
480*5d5fbe79SDavid van MoolenbroekHIDE_UNDOC_MEMBERS     = YES
481*5d5fbe79SDavid van Moolenbroek
482*5d5fbe79SDavid van Moolenbroek# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
483*5d5fbe79SDavid van Moolenbroek# undocumented classes that are normally visible in the class hierarchy. If set
484*5d5fbe79SDavid van Moolenbroek# to NO, these classes will be included in the various overviews. This option
485*5d5fbe79SDavid van Moolenbroek# has no effect if EXTRACT_ALL is enabled.
486*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
487*5d5fbe79SDavid van Moolenbroek
488*5d5fbe79SDavid van MoolenbroekHIDE_UNDOC_CLASSES     = YES
489*5d5fbe79SDavid van Moolenbroek
490*5d5fbe79SDavid van Moolenbroek# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
491*5d5fbe79SDavid van Moolenbroek# (class|struct|union) declarations. If set to NO, these declarations will be
492*5d5fbe79SDavid van Moolenbroek# included in the documentation.
493*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
494*5d5fbe79SDavid van Moolenbroek
495*5d5fbe79SDavid van MoolenbroekHIDE_FRIEND_COMPOUNDS  = NO
496*5d5fbe79SDavid van Moolenbroek
497*5d5fbe79SDavid van Moolenbroek# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
498*5d5fbe79SDavid van Moolenbroek# documentation blocks found inside the body of a function. If set to NO, these
499*5d5fbe79SDavid van Moolenbroek# blocks will be appended to the function's detailed documentation block.
500*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
501*5d5fbe79SDavid van Moolenbroek
502*5d5fbe79SDavid van MoolenbroekHIDE_IN_BODY_DOCS      = NO
503*5d5fbe79SDavid van Moolenbroek
504*5d5fbe79SDavid van Moolenbroek# The INTERNAL_DOCS tag determines if documentation that is typed after a
505*5d5fbe79SDavid van Moolenbroek# \internal command is included. If the tag is set to NO then the documentation
506*5d5fbe79SDavid van Moolenbroek# will be excluded. Set it to YES to include the internal documentation.
507*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
508*5d5fbe79SDavid van Moolenbroek
509*5d5fbe79SDavid van MoolenbroekINTERNAL_DOCS          = NO
510*5d5fbe79SDavid van Moolenbroek
511*5d5fbe79SDavid van Moolenbroek# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
512*5d5fbe79SDavid van Moolenbroek# names in lower-case letters. If set to YES, upper-case letters are also
513*5d5fbe79SDavid van Moolenbroek# allowed. This is useful if you have classes or files whose names only differ
514*5d5fbe79SDavid van Moolenbroek# in case and if your file system supports case sensitive file names. Windows
515*5d5fbe79SDavid van Moolenbroek# and Mac users are advised to set this option to NO.
516*5d5fbe79SDavid van Moolenbroek# The default value is: system dependent.
517*5d5fbe79SDavid van Moolenbroek
518*5d5fbe79SDavid van MoolenbroekCASE_SENSE_NAMES       = NO
519*5d5fbe79SDavid van Moolenbroek
520*5d5fbe79SDavid van Moolenbroek# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
521*5d5fbe79SDavid van Moolenbroek# their full class and namespace scopes in the documentation. If set to YES, the
522*5d5fbe79SDavid van Moolenbroek# scope will be hidden.
523*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
524*5d5fbe79SDavid van Moolenbroek
525*5d5fbe79SDavid van MoolenbroekHIDE_SCOPE_NAMES       = NO
526*5d5fbe79SDavid van Moolenbroek
527*5d5fbe79SDavid van Moolenbroek# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
528*5d5fbe79SDavid van Moolenbroek# append additional text to a page's title, such as Class Reference. If set to
529*5d5fbe79SDavid van Moolenbroek# YES the compound reference will be hidden.
530*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
531*5d5fbe79SDavid van Moolenbroek
532*5d5fbe79SDavid van MoolenbroekHIDE_COMPOUND_REFERENCE= NO
533*5d5fbe79SDavid van Moolenbroek
534*5d5fbe79SDavid van Moolenbroek# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
535*5d5fbe79SDavid van Moolenbroek# the files that are included by a file in the documentation of that file.
536*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
537*5d5fbe79SDavid van Moolenbroek
538*5d5fbe79SDavid van MoolenbroekSHOW_INCLUDE_FILES     = YES
539*5d5fbe79SDavid van Moolenbroek
540*5d5fbe79SDavid van Moolenbroek# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
541*5d5fbe79SDavid van Moolenbroek# grouped member an include statement to the documentation, telling the reader
542*5d5fbe79SDavid van Moolenbroek# which file to include in order to use the member.
543*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
544*5d5fbe79SDavid van Moolenbroek
545*5d5fbe79SDavid van MoolenbroekSHOW_GROUPED_MEMB_INC  = NO
546*5d5fbe79SDavid van Moolenbroek
547*5d5fbe79SDavid van Moolenbroek# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
548*5d5fbe79SDavid van Moolenbroek# files with double quotes in the documentation rather than with sharp brackets.
549*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
550*5d5fbe79SDavid van Moolenbroek
551*5d5fbe79SDavid van MoolenbroekFORCE_LOCAL_INCLUDES   = NO
552*5d5fbe79SDavid van Moolenbroek
553*5d5fbe79SDavid van Moolenbroek# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
554*5d5fbe79SDavid van Moolenbroek# documentation for inline members.
555*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
556*5d5fbe79SDavid van Moolenbroek
557*5d5fbe79SDavid van MoolenbroekINLINE_INFO            = YES
558*5d5fbe79SDavid van Moolenbroek
559*5d5fbe79SDavid van Moolenbroek# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
560*5d5fbe79SDavid van Moolenbroek# (detailed) documentation of file and class members alphabetically by member
561*5d5fbe79SDavid van Moolenbroek# name. If set to NO, the members will appear in declaration order.
562*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
563*5d5fbe79SDavid van Moolenbroek
564*5d5fbe79SDavid van MoolenbroekSORT_MEMBER_DOCS       = YES
565*5d5fbe79SDavid van Moolenbroek
566*5d5fbe79SDavid van Moolenbroek# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
567*5d5fbe79SDavid van Moolenbroek# descriptions of file, namespace and class members alphabetically by member
568*5d5fbe79SDavid van Moolenbroek# name. If set to NO, the members will appear in declaration order. Note that
569*5d5fbe79SDavid van Moolenbroek# this will also influence the order of the classes in the class list.
570*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
571*5d5fbe79SDavid van Moolenbroek
572*5d5fbe79SDavid van MoolenbroekSORT_BRIEF_DOCS        = NO
573*5d5fbe79SDavid van Moolenbroek
574*5d5fbe79SDavid van Moolenbroek# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
575*5d5fbe79SDavid van Moolenbroek# (brief and detailed) documentation of class members so that constructors and
576*5d5fbe79SDavid van Moolenbroek# destructors are listed first. If set to NO the constructors will appear in the
577*5d5fbe79SDavid van Moolenbroek# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
578*5d5fbe79SDavid van Moolenbroek# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
579*5d5fbe79SDavid van Moolenbroek# member documentation.
580*5d5fbe79SDavid van Moolenbroek# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
581*5d5fbe79SDavid van Moolenbroek# detailed member documentation.
582*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
583*5d5fbe79SDavid van Moolenbroek
584*5d5fbe79SDavid van MoolenbroekSORT_MEMBERS_CTORS_1ST = NO
585*5d5fbe79SDavid van Moolenbroek
586*5d5fbe79SDavid van Moolenbroek# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
587*5d5fbe79SDavid van Moolenbroek# of group names into alphabetical order. If set to NO the group names will
588*5d5fbe79SDavid van Moolenbroek# appear in their defined order.
589*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
590*5d5fbe79SDavid van Moolenbroek
591*5d5fbe79SDavid van MoolenbroekSORT_GROUP_NAMES       = NO
592*5d5fbe79SDavid van Moolenbroek
593*5d5fbe79SDavid van Moolenbroek# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
594*5d5fbe79SDavid van Moolenbroek# fully-qualified names, including namespaces. If set to NO, the class list will
595*5d5fbe79SDavid van Moolenbroek# be sorted only by class name, not including the namespace part.
596*5d5fbe79SDavid van Moolenbroek# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
597*5d5fbe79SDavid van Moolenbroek# Note: This option applies only to the class list, not to the alphabetical
598*5d5fbe79SDavid van Moolenbroek# list.
599*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
600*5d5fbe79SDavid van Moolenbroek
601*5d5fbe79SDavid van MoolenbroekSORT_BY_SCOPE_NAME     = NO
602*5d5fbe79SDavid van Moolenbroek
603*5d5fbe79SDavid van Moolenbroek# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
604*5d5fbe79SDavid van Moolenbroek# type resolution of all parameters of a function it will reject a match between
605*5d5fbe79SDavid van Moolenbroek# the prototype and the implementation of a member function even if there is
606*5d5fbe79SDavid van Moolenbroek# only one candidate or it is obvious which candidate to choose by doing a
607*5d5fbe79SDavid van Moolenbroek# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
608*5d5fbe79SDavid van Moolenbroek# accept a match between prototype and implementation in such cases.
609*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
610*5d5fbe79SDavid van Moolenbroek
611*5d5fbe79SDavid van MoolenbroekSTRICT_PROTO_MATCHING  = NO
612*5d5fbe79SDavid van Moolenbroek
613*5d5fbe79SDavid van Moolenbroek# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
614*5d5fbe79SDavid van Moolenbroek# list. This list is created by putting \todo commands in the documentation.
615*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
616*5d5fbe79SDavid van Moolenbroek
617*5d5fbe79SDavid van MoolenbroekGENERATE_TODOLIST      = NO
618*5d5fbe79SDavid van Moolenbroek
619*5d5fbe79SDavid van Moolenbroek# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
620*5d5fbe79SDavid van Moolenbroek# list. This list is created by putting \test commands in the documentation.
621*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
622*5d5fbe79SDavid van Moolenbroek
623*5d5fbe79SDavid van MoolenbroekGENERATE_TESTLIST      = YES
624*5d5fbe79SDavid van Moolenbroek
625*5d5fbe79SDavid van Moolenbroek# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
626*5d5fbe79SDavid van Moolenbroek# list. This list is created by putting \bug commands in the documentation.
627*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
628*5d5fbe79SDavid van Moolenbroek
629*5d5fbe79SDavid van MoolenbroekGENERATE_BUGLIST       = YES
630*5d5fbe79SDavid van Moolenbroek
631*5d5fbe79SDavid van Moolenbroek# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
632*5d5fbe79SDavid van Moolenbroek# the deprecated list. This list is created by putting \deprecated commands in
633*5d5fbe79SDavid van Moolenbroek# the documentation.
634*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
635*5d5fbe79SDavid van Moolenbroek
636*5d5fbe79SDavid van MoolenbroekGENERATE_DEPRECATEDLIST= YES
637*5d5fbe79SDavid van Moolenbroek
638*5d5fbe79SDavid van Moolenbroek# The ENABLED_SECTIONS tag can be used to enable conditional documentation
639*5d5fbe79SDavid van Moolenbroek# sections, marked by \if <section_label> ... \endif and \cond <section_label>
640*5d5fbe79SDavid van Moolenbroek# ... \endcond blocks.
641*5d5fbe79SDavid van Moolenbroek
642*5d5fbe79SDavid van MoolenbroekENABLED_SECTIONS       =
643*5d5fbe79SDavid van Moolenbroek
644*5d5fbe79SDavid van Moolenbroek# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
645*5d5fbe79SDavid van Moolenbroek# initial value of a variable or macro / define can have for it to appear in the
646*5d5fbe79SDavid van Moolenbroek# documentation. If the initializer consists of more lines than specified here
647*5d5fbe79SDavid van Moolenbroek# it will be hidden. Use a value of 0 to hide initializers completely. The
648*5d5fbe79SDavid van Moolenbroek# appearance of the value of individual variables and macros / defines can be
649*5d5fbe79SDavid van Moolenbroek# controlled using \showinitializer or \hideinitializer command in the
650*5d5fbe79SDavid van Moolenbroek# documentation regardless of this setting.
651*5d5fbe79SDavid van Moolenbroek# Minimum value: 0, maximum value: 10000, default value: 30.
652*5d5fbe79SDavid van Moolenbroek
653*5d5fbe79SDavid van MoolenbroekMAX_INITIALIZER_LINES  = 30
654*5d5fbe79SDavid van Moolenbroek
655*5d5fbe79SDavid van Moolenbroek# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
656*5d5fbe79SDavid van Moolenbroek# the bottom of the documentation of classes and structs. If set to YES, the
657*5d5fbe79SDavid van Moolenbroek# list will mention the files that were used to generate the documentation.
658*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
659*5d5fbe79SDavid van Moolenbroek
660*5d5fbe79SDavid van MoolenbroekSHOW_USED_FILES        = YES
661*5d5fbe79SDavid van Moolenbroek
662*5d5fbe79SDavid van Moolenbroek# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
663*5d5fbe79SDavid van Moolenbroek# will remove the Files entry from the Quick Index and from the Folder Tree View
664*5d5fbe79SDavid van Moolenbroek# (if specified).
665*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
666*5d5fbe79SDavid van Moolenbroek
667*5d5fbe79SDavid van MoolenbroekSHOW_FILES             = YES
668*5d5fbe79SDavid van Moolenbroek
669*5d5fbe79SDavid van Moolenbroek# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
670*5d5fbe79SDavid van Moolenbroek# page. This will remove the Namespaces entry from the Quick Index and from the
671*5d5fbe79SDavid van Moolenbroek# Folder Tree View (if specified).
672*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
673*5d5fbe79SDavid van Moolenbroek
674*5d5fbe79SDavid van MoolenbroekSHOW_NAMESPACES        = YES
675*5d5fbe79SDavid van Moolenbroek
676*5d5fbe79SDavid van Moolenbroek# The FILE_VERSION_FILTER tag can be used to specify a program or script that
677*5d5fbe79SDavid van Moolenbroek# doxygen should invoke to get the current version for each file (typically from
678*5d5fbe79SDavid van Moolenbroek# the version control system). Doxygen will invoke the program by executing (via
679*5d5fbe79SDavid van Moolenbroek# popen()) the command command input-file, where command is the value of the
680*5d5fbe79SDavid van Moolenbroek# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
681*5d5fbe79SDavid van Moolenbroek# by doxygen. Whatever the program writes to standard output is used as the file
682*5d5fbe79SDavid van Moolenbroek# version. For an example see the documentation.
683*5d5fbe79SDavid van Moolenbroek
684*5d5fbe79SDavid van MoolenbroekFILE_VERSION_FILTER    =
685*5d5fbe79SDavid van Moolenbroek
686*5d5fbe79SDavid van Moolenbroek# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
687*5d5fbe79SDavid van Moolenbroek# by doxygen. The layout file controls the global structure of the generated
688*5d5fbe79SDavid van Moolenbroek# output files in an output format independent way. To create the layout file
689*5d5fbe79SDavid van Moolenbroek# that represents doxygen's defaults, run doxygen with the -l option. You can
690*5d5fbe79SDavid van Moolenbroek# optionally specify a file name after the option, if omitted DoxygenLayout.xml
691*5d5fbe79SDavid van Moolenbroek# will be used as the name of the layout file.
692*5d5fbe79SDavid van Moolenbroek#
693*5d5fbe79SDavid van Moolenbroek# Note that if you run doxygen from a directory containing a file called
694*5d5fbe79SDavid van Moolenbroek# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
695*5d5fbe79SDavid van Moolenbroek# tag is left empty.
696*5d5fbe79SDavid van Moolenbroek
697*5d5fbe79SDavid van MoolenbroekLAYOUT_FILE            =
698*5d5fbe79SDavid van Moolenbroek
699*5d5fbe79SDavid van Moolenbroek# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
700*5d5fbe79SDavid van Moolenbroek# the reference definitions. This must be a list of .bib files. The .bib
701*5d5fbe79SDavid van Moolenbroek# extension is automatically appended if omitted. This requires the bibtex tool
702*5d5fbe79SDavid van Moolenbroek# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
703*5d5fbe79SDavid van Moolenbroek# For LaTeX the style of the bibliography can be controlled using
704*5d5fbe79SDavid van Moolenbroek# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
705*5d5fbe79SDavid van Moolenbroek# search path. See also \cite for info how to create references.
706*5d5fbe79SDavid van Moolenbroek
707*5d5fbe79SDavid van MoolenbroekCITE_BIB_FILES         =
708*5d5fbe79SDavid van Moolenbroek
709*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
710*5d5fbe79SDavid van Moolenbroek# Configuration options related to warning and progress messages
711*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
712*5d5fbe79SDavid van Moolenbroek
713*5d5fbe79SDavid van Moolenbroek# The QUIET tag can be used to turn on/off the messages that are generated to
714*5d5fbe79SDavid van Moolenbroek# standard output by doxygen. If QUIET is set to YES this implies that the
715*5d5fbe79SDavid van Moolenbroek# messages are off.
716*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
717*5d5fbe79SDavid van Moolenbroek
718*5d5fbe79SDavid van MoolenbroekQUIET                  = NO
719*5d5fbe79SDavid van Moolenbroek
720*5d5fbe79SDavid van Moolenbroek# The WARNINGS tag can be used to turn on/off the warning messages that are
721*5d5fbe79SDavid van Moolenbroek# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
722*5d5fbe79SDavid van Moolenbroek# this implies that the warnings are on.
723*5d5fbe79SDavid van Moolenbroek#
724*5d5fbe79SDavid van Moolenbroek# Tip: Turn warnings on while writing the documentation.
725*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
726*5d5fbe79SDavid van Moolenbroek
727*5d5fbe79SDavid van MoolenbroekWARNINGS               = YES
728*5d5fbe79SDavid van Moolenbroek
729*5d5fbe79SDavid van Moolenbroek# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
730*5d5fbe79SDavid van Moolenbroek# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
731*5d5fbe79SDavid van Moolenbroek# will automatically be disabled.
732*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
733*5d5fbe79SDavid van Moolenbroek
734*5d5fbe79SDavid van MoolenbroekWARN_IF_UNDOCUMENTED   = YES
735*5d5fbe79SDavid van Moolenbroek
736*5d5fbe79SDavid van Moolenbroek# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
737*5d5fbe79SDavid van Moolenbroek# potential errors in the documentation, such as not documenting some parameters
738*5d5fbe79SDavid van Moolenbroek# in a documented function, or documenting parameters that don't exist or using
739*5d5fbe79SDavid van Moolenbroek# markup commands wrongly.
740*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
741*5d5fbe79SDavid van Moolenbroek
742*5d5fbe79SDavid van MoolenbroekWARN_IF_DOC_ERROR      = YES
743*5d5fbe79SDavid van Moolenbroek
744*5d5fbe79SDavid van Moolenbroek# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
745*5d5fbe79SDavid van Moolenbroek# are documented, but have no documentation for their parameters or return
746*5d5fbe79SDavid van Moolenbroek# value. If set to NO, doxygen will only warn about wrong or incomplete
747*5d5fbe79SDavid van Moolenbroek# parameter documentation, but not about the absence of documentation.
748*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
749*5d5fbe79SDavid van Moolenbroek
750*5d5fbe79SDavid van MoolenbroekWARN_NO_PARAMDOC       = NO
751*5d5fbe79SDavid van Moolenbroek
752*5d5fbe79SDavid van Moolenbroek# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
753*5d5fbe79SDavid van Moolenbroek# a warning is encountered.
754*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
755*5d5fbe79SDavid van Moolenbroek
756*5d5fbe79SDavid van MoolenbroekWARN_AS_ERROR          = NO
757*5d5fbe79SDavid van Moolenbroek
758*5d5fbe79SDavid van Moolenbroek# The WARN_FORMAT tag determines the format of the warning messages that doxygen
759*5d5fbe79SDavid van Moolenbroek# can produce. The string should contain the $file, $line, and $text tags, which
760*5d5fbe79SDavid van Moolenbroek# will be replaced by the file and line number from which the warning originated
761*5d5fbe79SDavid van Moolenbroek# and the warning text. Optionally the format may contain $version, which will
762*5d5fbe79SDavid van Moolenbroek# be replaced by the version of the file (if it could be obtained via
763*5d5fbe79SDavid van Moolenbroek# FILE_VERSION_FILTER)
764*5d5fbe79SDavid van Moolenbroek# The default value is: $file:$line: $text.
765*5d5fbe79SDavid van Moolenbroek
766*5d5fbe79SDavid van MoolenbroekWARN_FORMAT            = "$file:$line: $text       "
767*5d5fbe79SDavid van Moolenbroek
768*5d5fbe79SDavid van Moolenbroek# The WARN_LOGFILE tag can be used to specify a file to which warning and error
769*5d5fbe79SDavid van Moolenbroek# messages should be written. If left blank the output is written to standard
770*5d5fbe79SDavid van Moolenbroek# error (stderr).
771*5d5fbe79SDavid van Moolenbroek
772*5d5fbe79SDavid van MoolenbroekWARN_LOGFILE           =
773*5d5fbe79SDavid van Moolenbroek
774*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
775*5d5fbe79SDavid van Moolenbroek# Configuration options related to the input files
776*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
777*5d5fbe79SDavid van Moolenbroek
778*5d5fbe79SDavid van Moolenbroek# The INPUT tag is used to specify the files and/or directories that contain
779*5d5fbe79SDavid van Moolenbroek# documented source files. You may enter file names like myfile.cpp or
780*5d5fbe79SDavid van Moolenbroek# directories like /usr/src/myproject. Separate the files or directories with
781*5d5fbe79SDavid van Moolenbroek# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
782*5d5fbe79SDavid van Moolenbroek# Note: If this tag is empty the current directory is searched.
783*5d5fbe79SDavid van Moolenbroek
784*5d5fbe79SDavid van MoolenbroekINPUT                  = main_page.h ../../src
785*5d5fbe79SDavid van Moolenbroek
786*5d5fbe79SDavid van Moolenbroek# This tag can be used to specify the character encoding of the source files
787*5d5fbe79SDavid van Moolenbroek# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
788*5d5fbe79SDavid van Moolenbroek# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
789*5d5fbe79SDavid van Moolenbroek# documentation (see: http://www.gnu.org/software/libiconv) for the list of
790*5d5fbe79SDavid van Moolenbroek# possible encodings.
791*5d5fbe79SDavid van Moolenbroek# The default value is: UTF-8.
792*5d5fbe79SDavid van Moolenbroek
793*5d5fbe79SDavid van MoolenbroekINPUT_ENCODING         = UTF-8
794*5d5fbe79SDavid van Moolenbroek
795*5d5fbe79SDavid van Moolenbroek# If the value of the INPUT tag contains directories, you can use the
796*5d5fbe79SDavid van Moolenbroek# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
797*5d5fbe79SDavid van Moolenbroek# *.h) to filter out the source-files in the directories.
798*5d5fbe79SDavid van Moolenbroek#
799*5d5fbe79SDavid van Moolenbroek# Note that for custom extensions or not directly supported extensions you also
800*5d5fbe79SDavid van Moolenbroek# need to set EXTENSION_MAPPING for the extension otherwise the files are not
801*5d5fbe79SDavid van Moolenbroek# read by doxygen.
802*5d5fbe79SDavid van Moolenbroek#
803*5d5fbe79SDavid van Moolenbroek# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
804*5d5fbe79SDavid van Moolenbroek# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
805*5d5fbe79SDavid van Moolenbroek# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
806*5d5fbe79SDavid van Moolenbroek# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl,
807*5d5fbe79SDavid van Moolenbroek# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js.
808*5d5fbe79SDavid van Moolenbroek
809*5d5fbe79SDavid van MoolenbroekFILE_PATTERNS          = *.c \
810*5d5fbe79SDavid van Moolenbroek                         *.cc \
811*5d5fbe79SDavid van Moolenbroek                         *.cxx \
812*5d5fbe79SDavid van Moolenbroek                         *.cpp \
813*5d5fbe79SDavid van Moolenbroek                         *.c++ \
814*5d5fbe79SDavid van Moolenbroek                         *.java \
815*5d5fbe79SDavid van Moolenbroek                         *.ii \
816*5d5fbe79SDavid van Moolenbroek                         *.ixx \
817*5d5fbe79SDavid van Moolenbroek                         *.ipp \
818*5d5fbe79SDavid van Moolenbroek                         *.i++ \
819*5d5fbe79SDavid van Moolenbroek                         *.inl \
820*5d5fbe79SDavid van Moolenbroek                         *.h \
821*5d5fbe79SDavid van Moolenbroek                         *.hh \
822*5d5fbe79SDavid van Moolenbroek                         *.hxx \
823*5d5fbe79SDavid van Moolenbroek                         *.hpp \
824*5d5fbe79SDavid van Moolenbroek                         *.h++ \
825*5d5fbe79SDavid van Moolenbroek                         *.idl \
826*5d5fbe79SDavid van Moolenbroek                         *.odl \
827*5d5fbe79SDavid van Moolenbroek                         *.inc \
828*5d5fbe79SDavid van Moolenbroek                         *.m \
829*5d5fbe79SDavid van Moolenbroek                         *.mm \
830*5d5fbe79SDavid van Moolenbroek                         *.dox
831*5d5fbe79SDavid van Moolenbroek
832*5d5fbe79SDavid van Moolenbroek# The RECURSIVE tag can be used to specify whether or not subdirectories should
833*5d5fbe79SDavid van Moolenbroek# be searched for input files as well.
834*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
835*5d5fbe79SDavid van Moolenbroek
836*5d5fbe79SDavid van MoolenbroekRECURSIVE              = YES
837*5d5fbe79SDavid van Moolenbroek
838*5d5fbe79SDavid van Moolenbroek# The EXCLUDE tag can be used to specify files and/or directories that should be
839*5d5fbe79SDavid van Moolenbroek# excluded from the INPUT source files. This way you can easily exclude a
840*5d5fbe79SDavid van Moolenbroek# subdirectory from a directory tree whose root is specified with the INPUT tag.
841*5d5fbe79SDavid van Moolenbroek#
842*5d5fbe79SDavid van Moolenbroek# Note that relative paths are relative to the directory from which doxygen is
843*5d5fbe79SDavid van Moolenbroek# run.
844*5d5fbe79SDavid van Moolenbroek
845*5d5fbe79SDavid van MoolenbroekEXCLUDE                = ../../src/include/netif/ppp/polarssl
846*5d5fbe79SDavid van Moolenbroek
847*5d5fbe79SDavid van Moolenbroek# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
848*5d5fbe79SDavid van Moolenbroek# directories that are symbolic links (a Unix file system feature) are excluded
849*5d5fbe79SDavid van Moolenbroek# from the input.
850*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
851*5d5fbe79SDavid van Moolenbroek
852*5d5fbe79SDavid van MoolenbroekEXCLUDE_SYMLINKS       = NO
853*5d5fbe79SDavid van Moolenbroek
854*5d5fbe79SDavid van Moolenbroek# If the value of the INPUT tag contains directories, you can use the
855*5d5fbe79SDavid van Moolenbroek# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
856*5d5fbe79SDavid van Moolenbroek# certain files from those directories.
857*5d5fbe79SDavid van Moolenbroek#
858*5d5fbe79SDavid van Moolenbroek# Note that the wildcards are matched against the file with absolute path, so to
859*5d5fbe79SDavid van Moolenbroek# exclude all test directories for example use the pattern */test/*
860*5d5fbe79SDavid van Moolenbroek
861*5d5fbe79SDavid van MoolenbroekEXCLUDE_PATTERNS       =
862*5d5fbe79SDavid van Moolenbroek
863*5d5fbe79SDavid van Moolenbroek# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
864*5d5fbe79SDavid van Moolenbroek# (namespaces, classes, functions, etc.) that should be excluded from the
865*5d5fbe79SDavid van Moolenbroek# output. The symbol name can be a fully qualified name, a word, or if the
866*5d5fbe79SDavid van Moolenbroek# wildcard * is used, a substring. Examples: ANamespace, AClass,
867*5d5fbe79SDavid van Moolenbroek# AClass::ANamespace, ANamespace::*Test
868*5d5fbe79SDavid van Moolenbroek#
869*5d5fbe79SDavid van Moolenbroek# Note that the wildcards are matched against the file with absolute path, so to
870*5d5fbe79SDavid van Moolenbroek# exclude all test directories use the pattern */test/*
871*5d5fbe79SDavid van Moolenbroek
872*5d5fbe79SDavid van MoolenbroekEXCLUDE_SYMBOLS        =
873*5d5fbe79SDavid van Moolenbroek
874*5d5fbe79SDavid van Moolenbroek# The EXAMPLE_PATH tag can be used to specify one or more files or directories
875*5d5fbe79SDavid van Moolenbroek# that contain example code fragments that are included (see the \include
876*5d5fbe79SDavid van Moolenbroek# command).
877*5d5fbe79SDavid van Moolenbroek
878*5d5fbe79SDavid van MoolenbroekEXAMPLE_PATH           = ../ ../../
879*5d5fbe79SDavid van Moolenbroek
880*5d5fbe79SDavid van Moolenbroek# If the value of the EXAMPLE_PATH tag contains directories, you can use the
881*5d5fbe79SDavid van Moolenbroek# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
882*5d5fbe79SDavid van Moolenbroek# *.h) to filter out the source-files in the directories. If left blank all
883*5d5fbe79SDavid van Moolenbroek# files are included.
884*5d5fbe79SDavid van Moolenbroek
885*5d5fbe79SDavid van MoolenbroekEXAMPLE_PATTERNS       = *
886*5d5fbe79SDavid van Moolenbroek
887*5d5fbe79SDavid van Moolenbroek# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
888*5d5fbe79SDavid van Moolenbroek# searched for input files to be used with the \include or \dontinclude commands
889*5d5fbe79SDavid van Moolenbroek# irrespective of the value of the RECURSIVE tag.
890*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
891*5d5fbe79SDavid van Moolenbroek
892*5d5fbe79SDavid van MoolenbroekEXAMPLE_RECURSIVE      = NO
893*5d5fbe79SDavid van Moolenbroek
894*5d5fbe79SDavid van Moolenbroek# The IMAGE_PATH tag can be used to specify one or more files or directories
895*5d5fbe79SDavid van Moolenbroek# that contain images that are to be included in the documentation (see the
896*5d5fbe79SDavid van Moolenbroek# \image command).
897*5d5fbe79SDavid van Moolenbroek
898*5d5fbe79SDavid van MoolenbroekIMAGE_PATH             =
899*5d5fbe79SDavid van Moolenbroek
900*5d5fbe79SDavid van Moolenbroek# The INPUT_FILTER tag can be used to specify a program that doxygen should
901*5d5fbe79SDavid van Moolenbroek# invoke to filter for each input file. Doxygen will invoke the filter program
902*5d5fbe79SDavid van Moolenbroek# by executing (via popen()) the command:
903*5d5fbe79SDavid van Moolenbroek#
904*5d5fbe79SDavid van Moolenbroek# <filter> <input-file>
905*5d5fbe79SDavid van Moolenbroek#
906*5d5fbe79SDavid van Moolenbroek# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
907*5d5fbe79SDavid van Moolenbroek# name of an input file. Doxygen will then use the output that the filter
908*5d5fbe79SDavid van Moolenbroek# program writes to standard output. If FILTER_PATTERNS is specified, this tag
909*5d5fbe79SDavid van Moolenbroek# will be ignored.
910*5d5fbe79SDavid van Moolenbroek#
911*5d5fbe79SDavid van Moolenbroek# Note that the filter must not add or remove lines; it is applied before the
912*5d5fbe79SDavid van Moolenbroek# code is scanned, but not when the output code is generated. If lines are added
913*5d5fbe79SDavid van Moolenbroek# or removed, the anchors will not be placed correctly.
914*5d5fbe79SDavid van Moolenbroek#
915*5d5fbe79SDavid van Moolenbroek# Note that for custom extensions or not directly supported extensions you also
916*5d5fbe79SDavid van Moolenbroek# need to set EXTENSION_MAPPING for the extension otherwise the files are not
917*5d5fbe79SDavid van Moolenbroek# properly processed by doxygen.
918*5d5fbe79SDavid van Moolenbroek
919*5d5fbe79SDavid van MoolenbroekINPUT_FILTER           =
920*5d5fbe79SDavid van Moolenbroek
921*5d5fbe79SDavid van Moolenbroek# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
922*5d5fbe79SDavid van Moolenbroek# basis. Doxygen will compare the file name with each pattern and apply the
923*5d5fbe79SDavid van Moolenbroek# filter if there is a match. The filters are a list of the form: pattern=filter
924*5d5fbe79SDavid van Moolenbroek# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
925*5d5fbe79SDavid van Moolenbroek# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
926*5d5fbe79SDavid van Moolenbroek# patterns match the file name, INPUT_FILTER is applied.
927*5d5fbe79SDavid van Moolenbroek#
928*5d5fbe79SDavid van Moolenbroek# Note that for custom extensions or not directly supported extensions you also
929*5d5fbe79SDavid van Moolenbroek# need to set EXTENSION_MAPPING for the extension otherwise the files are not
930*5d5fbe79SDavid van Moolenbroek# properly processed by doxygen.
931*5d5fbe79SDavid van Moolenbroek
932*5d5fbe79SDavid van MoolenbroekFILTER_PATTERNS        =
933*5d5fbe79SDavid van Moolenbroek
934*5d5fbe79SDavid van Moolenbroek# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
935*5d5fbe79SDavid van Moolenbroek# INPUT_FILTER) will also be used to filter the input files that are used for
936*5d5fbe79SDavid van Moolenbroek# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
937*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
938*5d5fbe79SDavid van Moolenbroek
939*5d5fbe79SDavid van MoolenbroekFILTER_SOURCE_FILES    = NO
940*5d5fbe79SDavid van Moolenbroek
941*5d5fbe79SDavid van Moolenbroek# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
942*5d5fbe79SDavid van Moolenbroek# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
943*5d5fbe79SDavid van Moolenbroek# it is also possible to disable source filtering for a specific pattern using
944*5d5fbe79SDavid van Moolenbroek# *.ext= (so without naming a filter).
945*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
946*5d5fbe79SDavid van Moolenbroek
947*5d5fbe79SDavid van MoolenbroekFILTER_SOURCE_PATTERNS =
948*5d5fbe79SDavid van Moolenbroek
949*5d5fbe79SDavid van Moolenbroek# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
950*5d5fbe79SDavid van Moolenbroek# is part of the input, its contents will be placed on the main page
951*5d5fbe79SDavid van Moolenbroek# (index.html). This can be useful if you have a project on for instance GitHub
952*5d5fbe79SDavid van Moolenbroek# and want to reuse the introduction page also for the doxygen output.
953*5d5fbe79SDavid van Moolenbroek
954*5d5fbe79SDavid van MoolenbroekUSE_MDFILE_AS_MAINPAGE = main_page.h
955*5d5fbe79SDavid van Moolenbroek
956*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
957*5d5fbe79SDavid van Moolenbroek# Configuration options related to source browsing
958*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
959*5d5fbe79SDavid van Moolenbroek
960*5d5fbe79SDavid van Moolenbroek# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
961*5d5fbe79SDavid van Moolenbroek# generated. Documented entities will be cross-referenced with these sources.
962*5d5fbe79SDavid van Moolenbroek#
963*5d5fbe79SDavid van Moolenbroek# Note: To get rid of all source code in the generated output, make sure that
964*5d5fbe79SDavid van Moolenbroek# also VERBATIM_HEADERS is set to NO.
965*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
966*5d5fbe79SDavid van Moolenbroek
967*5d5fbe79SDavid van MoolenbroekSOURCE_BROWSER         = NO
968*5d5fbe79SDavid van Moolenbroek
969*5d5fbe79SDavid van Moolenbroek# Setting the INLINE_SOURCES tag to YES will include the body of functions,
970*5d5fbe79SDavid van Moolenbroek# classes and enums directly into the documentation.
971*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
972*5d5fbe79SDavid van Moolenbroek
973*5d5fbe79SDavid van MoolenbroekINLINE_SOURCES         = NO
974*5d5fbe79SDavid van Moolenbroek
975*5d5fbe79SDavid van Moolenbroek# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
976*5d5fbe79SDavid van Moolenbroek# special comment blocks from generated source code fragments. Normal C, C++ and
977*5d5fbe79SDavid van Moolenbroek# Fortran comments will always remain visible.
978*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
979*5d5fbe79SDavid van Moolenbroek
980*5d5fbe79SDavid van MoolenbroekSTRIP_CODE_COMMENTS    = YES
981*5d5fbe79SDavid van Moolenbroek
982*5d5fbe79SDavid van Moolenbroek# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
983*5d5fbe79SDavid van Moolenbroek# function all documented functions referencing it will be listed.
984*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
985*5d5fbe79SDavid van Moolenbroek
986*5d5fbe79SDavid van MoolenbroekREFERENCED_BY_RELATION = NO
987*5d5fbe79SDavid van Moolenbroek
988*5d5fbe79SDavid van Moolenbroek# If the REFERENCES_RELATION tag is set to YES then for each documented function
989*5d5fbe79SDavid van Moolenbroek# all documented entities called/used by that function will be listed.
990*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
991*5d5fbe79SDavid van Moolenbroek
992*5d5fbe79SDavid van MoolenbroekREFERENCES_RELATION    = NO
993*5d5fbe79SDavid van Moolenbroek
994*5d5fbe79SDavid van Moolenbroek# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
995*5d5fbe79SDavid van Moolenbroek# to YES then the hyperlinks from functions in REFERENCES_RELATION and
996*5d5fbe79SDavid van Moolenbroek# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
997*5d5fbe79SDavid van Moolenbroek# link to the documentation.
998*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
999*5d5fbe79SDavid van Moolenbroek
1000*5d5fbe79SDavid van MoolenbroekREFERENCES_LINK_SOURCE = YES
1001*5d5fbe79SDavid van Moolenbroek
1002*5d5fbe79SDavid van Moolenbroek# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1003*5d5fbe79SDavid van Moolenbroek# source code will show a tooltip with additional information such as prototype,
1004*5d5fbe79SDavid van Moolenbroek# brief description and links to the definition and documentation. Since this
1005*5d5fbe79SDavid van Moolenbroek# will make the HTML file larger and loading of large files a bit slower, you
1006*5d5fbe79SDavid van Moolenbroek# can opt to disable this feature.
1007*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
1008*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag SOURCE_BROWSER is set to YES.
1009*5d5fbe79SDavid van Moolenbroek
1010*5d5fbe79SDavid van MoolenbroekSOURCE_TOOLTIPS        = YES
1011*5d5fbe79SDavid van Moolenbroek
1012*5d5fbe79SDavid van Moolenbroek# If the USE_HTAGS tag is set to YES then the references to source code will
1013*5d5fbe79SDavid van Moolenbroek# point to the HTML generated by the htags(1) tool instead of doxygen built-in
1014*5d5fbe79SDavid van Moolenbroek# source browser. The htags tool is part of GNU's global source tagging system
1015*5d5fbe79SDavid van Moolenbroek# (see http://www.gnu.org/software/global/global.html). You will need version
1016*5d5fbe79SDavid van Moolenbroek# 4.8.6 or higher.
1017*5d5fbe79SDavid van Moolenbroek#
1018*5d5fbe79SDavid van Moolenbroek# To use it do the following:
1019*5d5fbe79SDavid van Moolenbroek# - Install the latest version of global
1020*5d5fbe79SDavid van Moolenbroek# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
1021*5d5fbe79SDavid van Moolenbroek# - Make sure the INPUT points to the root of the source tree
1022*5d5fbe79SDavid van Moolenbroek# - Run doxygen as normal
1023*5d5fbe79SDavid van Moolenbroek#
1024*5d5fbe79SDavid van Moolenbroek# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1025*5d5fbe79SDavid van Moolenbroek# tools must be available from the command line (i.e. in the search path).
1026*5d5fbe79SDavid van Moolenbroek#
1027*5d5fbe79SDavid van Moolenbroek# The result: instead of the source browser generated by doxygen, the links to
1028*5d5fbe79SDavid van Moolenbroek# source code will now point to the output of htags.
1029*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1030*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag SOURCE_BROWSER is set to YES.
1031*5d5fbe79SDavid van Moolenbroek
1032*5d5fbe79SDavid van MoolenbroekUSE_HTAGS              = NO
1033*5d5fbe79SDavid van Moolenbroek
1034*5d5fbe79SDavid van Moolenbroek# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1035*5d5fbe79SDavid van Moolenbroek# verbatim copy of the header file for each class for which an include is
1036*5d5fbe79SDavid van Moolenbroek# specified. Set to NO to disable this.
1037*5d5fbe79SDavid van Moolenbroek# See also: Section \class.
1038*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
1039*5d5fbe79SDavid van Moolenbroek
1040*5d5fbe79SDavid van MoolenbroekVERBATIM_HEADERS       = NO
1041*5d5fbe79SDavid van Moolenbroek
1042*5d5fbe79SDavid van Moolenbroek# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1043*5d5fbe79SDavid van Moolenbroek# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
1044*5d5fbe79SDavid van Moolenbroek# cost of reduced performance. This can be particularly helpful with template
1045*5d5fbe79SDavid van Moolenbroek# rich C++ code for which doxygen's built-in parser lacks the necessary type
1046*5d5fbe79SDavid van Moolenbroek# information.
1047*5d5fbe79SDavid van Moolenbroek# Note: The availability of this option depends on whether or not doxygen was
1048*5d5fbe79SDavid van Moolenbroek# generated with the -Duse-libclang=ON option for CMake.
1049*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1050*5d5fbe79SDavid van Moolenbroek
1051*5d5fbe79SDavid van MoolenbroekCLANG_ASSISTED_PARSING = NO
1052*5d5fbe79SDavid van Moolenbroek
1053*5d5fbe79SDavid van Moolenbroek# If clang assisted parsing is enabled you can provide the compiler with command
1054*5d5fbe79SDavid van Moolenbroek# line options that you would normally use when invoking the compiler. Note that
1055*5d5fbe79SDavid van Moolenbroek# the include paths will already be set by doxygen for the files and directories
1056*5d5fbe79SDavid van Moolenbroek# specified with INPUT and INCLUDE_PATH.
1057*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1058*5d5fbe79SDavid van Moolenbroek
1059*5d5fbe79SDavid van MoolenbroekCLANG_OPTIONS          =
1060*5d5fbe79SDavid van Moolenbroek
1061*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
1062*5d5fbe79SDavid van Moolenbroek# Configuration options related to the alphabetical class index
1063*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
1064*5d5fbe79SDavid van Moolenbroek
1065*5d5fbe79SDavid van Moolenbroek# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1066*5d5fbe79SDavid van Moolenbroek# compounds will be generated. Enable this if the project contains a lot of
1067*5d5fbe79SDavid van Moolenbroek# classes, structs, unions or interfaces.
1068*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
1069*5d5fbe79SDavid van Moolenbroek
1070*5d5fbe79SDavid van MoolenbroekALPHABETICAL_INDEX     = NO
1071*5d5fbe79SDavid van Moolenbroek
1072*5d5fbe79SDavid van Moolenbroek# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1073*5d5fbe79SDavid van Moolenbroek# which the alphabetical index list will be split.
1074*5d5fbe79SDavid van Moolenbroek# Minimum value: 1, maximum value: 20, default value: 5.
1075*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1076*5d5fbe79SDavid van Moolenbroek
1077*5d5fbe79SDavid van MoolenbroekCOLS_IN_ALPHA_INDEX    = 5
1078*5d5fbe79SDavid van Moolenbroek
1079*5d5fbe79SDavid van Moolenbroek# In case all classes in a project start with a common prefix, all classes will
1080*5d5fbe79SDavid van Moolenbroek# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1081*5d5fbe79SDavid van Moolenbroek# can be used to specify a prefix (or a list of prefixes) that should be ignored
1082*5d5fbe79SDavid van Moolenbroek# while generating the index headers.
1083*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1084*5d5fbe79SDavid van Moolenbroek
1085*5d5fbe79SDavid van MoolenbroekIGNORE_PREFIX          =
1086*5d5fbe79SDavid van Moolenbroek
1087*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
1088*5d5fbe79SDavid van Moolenbroek# Configuration options related to the HTML output
1089*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
1090*5d5fbe79SDavid van Moolenbroek
1091*5d5fbe79SDavid van Moolenbroek# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1092*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
1093*5d5fbe79SDavid van Moolenbroek
1094*5d5fbe79SDavid van MoolenbroekGENERATE_HTML          = YES
1095*5d5fbe79SDavid van Moolenbroek
1096*5d5fbe79SDavid van Moolenbroek# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1097*5d5fbe79SDavid van Moolenbroek# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1098*5d5fbe79SDavid van Moolenbroek# it.
1099*5d5fbe79SDavid van Moolenbroek# The default directory is: html.
1100*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTML is set to YES.
1101*5d5fbe79SDavid van Moolenbroek
1102*5d5fbe79SDavid van MoolenbroekHTML_OUTPUT            = html
1103*5d5fbe79SDavid van Moolenbroek
1104*5d5fbe79SDavid van Moolenbroek# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1105*5d5fbe79SDavid van Moolenbroek# generated HTML page (for example: .htm, .php, .asp).
1106*5d5fbe79SDavid van Moolenbroek# The default value is: .html.
1107*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTML is set to YES.
1108*5d5fbe79SDavid van Moolenbroek
1109*5d5fbe79SDavid van MoolenbroekHTML_FILE_EXTENSION    = .html
1110*5d5fbe79SDavid van Moolenbroek
1111*5d5fbe79SDavid van Moolenbroek# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1112*5d5fbe79SDavid van Moolenbroek# each generated HTML page. If the tag is left blank doxygen will generate a
1113*5d5fbe79SDavid van Moolenbroek# standard header.
1114*5d5fbe79SDavid van Moolenbroek#
1115*5d5fbe79SDavid van Moolenbroek# To get valid HTML the header file that includes any scripts and style sheets
1116*5d5fbe79SDavid van Moolenbroek# that doxygen needs, which is dependent on the configuration options used (e.g.
1117*5d5fbe79SDavid van Moolenbroek# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1118*5d5fbe79SDavid van Moolenbroek# default header using
1119*5d5fbe79SDavid van Moolenbroek# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1120*5d5fbe79SDavid van Moolenbroek# YourConfigFile
1121*5d5fbe79SDavid van Moolenbroek# and then modify the file new_header.html. See also section "Doxygen usage"
1122*5d5fbe79SDavid van Moolenbroek# for information on how to generate the default header that doxygen normally
1123*5d5fbe79SDavid van Moolenbroek# uses.
1124*5d5fbe79SDavid van Moolenbroek# Note: The header is subject to change so you typically have to regenerate the
1125*5d5fbe79SDavid van Moolenbroek# default header when upgrading to a newer version of doxygen. For a description
1126*5d5fbe79SDavid van Moolenbroek# of the possible markers and block names see the documentation.
1127*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTML is set to YES.
1128*5d5fbe79SDavid van Moolenbroek
1129*5d5fbe79SDavid van MoolenbroekHTML_HEADER            =
1130*5d5fbe79SDavid van Moolenbroek
1131*5d5fbe79SDavid van Moolenbroek# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1132*5d5fbe79SDavid van Moolenbroek# generated HTML page. If the tag is left blank doxygen will generate a standard
1133*5d5fbe79SDavid van Moolenbroek# footer. See HTML_HEADER for more information on how to generate a default
1134*5d5fbe79SDavid van Moolenbroek# footer and what special commands can be used inside the footer. See also
1135*5d5fbe79SDavid van Moolenbroek# section "Doxygen usage" for information on how to generate the default footer
1136*5d5fbe79SDavid van Moolenbroek# that doxygen normally uses.
1137*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTML is set to YES.
1138*5d5fbe79SDavid van Moolenbroek
1139*5d5fbe79SDavid van MoolenbroekHTML_FOOTER            =
1140*5d5fbe79SDavid van Moolenbroek
1141*5d5fbe79SDavid van Moolenbroek# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1142*5d5fbe79SDavid van Moolenbroek# sheet that is used by each HTML page. It can be used to fine-tune the look of
1143*5d5fbe79SDavid van Moolenbroek# the HTML output. If left blank doxygen will generate a default style sheet.
1144*5d5fbe79SDavid van Moolenbroek# See also section "Doxygen usage" for information on how to generate the style
1145*5d5fbe79SDavid van Moolenbroek# sheet that doxygen normally uses.
1146*5d5fbe79SDavid van Moolenbroek# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1147*5d5fbe79SDavid van Moolenbroek# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1148*5d5fbe79SDavid van Moolenbroek# obsolete.
1149*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTML is set to YES.
1150*5d5fbe79SDavid van Moolenbroek
1151*5d5fbe79SDavid van MoolenbroekHTML_STYLESHEET        =
1152*5d5fbe79SDavid van Moolenbroek
1153*5d5fbe79SDavid van Moolenbroek# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1154*5d5fbe79SDavid van Moolenbroek# cascading style sheets that are included after the standard style sheets
1155*5d5fbe79SDavid van Moolenbroek# created by doxygen. Using this option one can overrule certain style aspects.
1156*5d5fbe79SDavid van Moolenbroek# This is preferred over using HTML_STYLESHEET since it does not replace the
1157*5d5fbe79SDavid van Moolenbroek# standard style sheet and is therefore more robust against future updates.
1158*5d5fbe79SDavid van Moolenbroek# Doxygen will copy the style sheet files to the output directory.
1159*5d5fbe79SDavid van Moolenbroek# Note: The order of the extra style sheet files is of importance (e.g. the last
1160*5d5fbe79SDavid van Moolenbroek# style sheet in the list overrules the setting of the previous ones in the
1161*5d5fbe79SDavid van Moolenbroek# list). For an example see the documentation.
1162*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTML is set to YES.
1163*5d5fbe79SDavid van Moolenbroek
1164*5d5fbe79SDavid van MoolenbroekHTML_EXTRA_STYLESHEET  =
1165*5d5fbe79SDavid van Moolenbroek
1166*5d5fbe79SDavid van Moolenbroek# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1167*5d5fbe79SDavid van Moolenbroek# other source files which should be copied to the HTML output directory. Note
1168*5d5fbe79SDavid van Moolenbroek# that these files will be copied to the base HTML output directory. Use the
1169*5d5fbe79SDavid van Moolenbroek# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1170*5d5fbe79SDavid van Moolenbroek# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1171*5d5fbe79SDavid van Moolenbroek# files will be copied as-is; there are no commands or markers available.
1172*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTML is set to YES.
1173*5d5fbe79SDavid van Moolenbroek
1174*5d5fbe79SDavid van MoolenbroekHTML_EXTRA_FILES       =
1175*5d5fbe79SDavid van Moolenbroek
1176*5d5fbe79SDavid van Moolenbroek# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1177*5d5fbe79SDavid van Moolenbroek# will adjust the colors in the style sheet and background images according to
1178*5d5fbe79SDavid van Moolenbroek# this color. Hue is specified as an angle on a colorwheel, see
1179*5d5fbe79SDavid van Moolenbroek# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1180*5d5fbe79SDavid van Moolenbroek# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1181*5d5fbe79SDavid van Moolenbroek# purple, and 360 is red again.
1182*5d5fbe79SDavid van Moolenbroek# Minimum value: 0, maximum value: 359, default value: 220.
1183*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTML is set to YES.
1184*5d5fbe79SDavid van Moolenbroek
1185*5d5fbe79SDavid van MoolenbroekHTML_COLORSTYLE_HUE    = 220
1186*5d5fbe79SDavid van Moolenbroek
1187*5d5fbe79SDavid van Moolenbroek# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1188*5d5fbe79SDavid van Moolenbroek# in the HTML output. For a value of 0 the output will use grayscales only. A
1189*5d5fbe79SDavid van Moolenbroek# value of 255 will produce the most vivid colors.
1190*5d5fbe79SDavid van Moolenbroek# Minimum value: 0, maximum value: 255, default value: 100.
1191*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTML is set to YES.
1192*5d5fbe79SDavid van Moolenbroek
1193*5d5fbe79SDavid van MoolenbroekHTML_COLORSTYLE_SAT    = 100
1194*5d5fbe79SDavid van Moolenbroek
1195*5d5fbe79SDavid van Moolenbroek# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1196*5d5fbe79SDavid van Moolenbroek# luminance component of the colors in the HTML output. Values below 100
1197*5d5fbe79SDavid van Moolenbroek# gradually make the output lighter, whereas values above 100 make the output
1198*5d5fbe79SDavid van Moolenbroek# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1199*5d5fbe79SDavid van Moolenbroek# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1200*5d5fbe79SDavid van Moolenbroek# change the gamma.
1201*5d5fbe79SDavid van Moolenbroek# Minimum value: 40, maximum value: 240, default value: 80.
1202*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTML is set to YES.
1203*5d5fbe79SDavid van Moolenbroek
1204*5d5fbe79SDavid van MoolenbroekHTML_COLORSTYLE_GAMMA  = 80
1205*5d5fbe79SDavid van Moolenbroek
1206*5d5fbe79SDavid van Moolenbroek# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1207*5d5fbe79SDavid van Moolenbroek# page will contain the date and time when the page was generated. Setting this
1208*5d5fbe79SDavid van Moolenbroek# to YES can help to show when doxygen was last run and thus if the
1209*5d5fbe79SDavid van Moolenbroek# documentation is up to date.
1210*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1211*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTML is set to YES.
1212*5d5fbe79SDavid van Moolenbroek
1213*5d5fbe79SDavid van MoolenbroekHTML_TIMESTAMP         = NO
1214*5d5fbe79SDavid van Moolenbroek
1215*5d5fbe79SDavid van Moolenbroek# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1216*5d5fbe79SDavid van Moolenbroek# documentation will contain sections that can be hidden and shown after the
1217*5d5fbe79SDavid van Moolenbroek# page has loaded.
1218*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1219*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTML is set to YES.
1220*5d5fbe79SDavid van Moolenbroek
1221*5d5fbe79SDavid van MoolenbroekHTML_DYNAMIC_SECTIONS  = NO
1222*5d5fbe79SDavid van Moolenbroek
1223*5d5fbe79SDavid van Moolenbroek# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1224*5d5fbe79SDavid van Moolenbroek# shown in the various tree structured indices initially; the user can expand
1225*5d5fbe79SDavid van Moolenbroek# and collapse entries dynamically later on. Doxygen will expand the tree to
1226*5d5fbe79SDavid van Moolenbroek# such a level that at most the specified number of entries are visible (unless
1227*5d5fbe79SDavid van Moolenbroek# a fully collapsed tree already exceeds this amount). So setting the number of
1228*5d5fbe79SDavid van Moolenbroek# entries 1 will produce a full collapsed tree by default. 0 is a special value
1229*5d5fbe79SDavid van Moolenbroek# representing an infinite number of entries and will result in a full expanded
1230*5d5fbe79SDavid van Moolenbroek# tree by default.
1231*5d5fbe79SDavid van Moolenbroek# Minimum value: 0, maximum value: 9999, default value: 100.
1232*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTML is set to YES.
1233*5d5fbe79SDavid van Moolenbroek
1234*5d5fbe79SDavid van MoolenbroekHTML_INDEX_NUM_ENTRIES = 100
1235*5d5fbe79SDavid van Moolenbroek
1236*5d5fbe79SDavid van Moolenbroek# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1237*5d5fbe79SDavid van Moolenbroek# generated that can be used as input for Apple's Xcode 3 integrated development
1238*5d5fbe79SDavid van Moolenbroek# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1239*5d5fbe79SDavid van Moolenbroek# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1240*5d5fbe79SDavid van Moolenbroek# Makefile in the HTML output directory. Running make will produce the docset in
1241*5d5fbe79SDavid van Moolenbroek# that directory and running make install will install the docset in
1242*5d5fbe79SDavid van Moolenbroek# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1243*5d5fbe79SDavid van Moolenbroek# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1244*5d5fbe79SDavid van Moolenbroek# for more information.
1245*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1246*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTML is set to YES.
1247*5d5fbe79SDavid van Moolenbroek
1248*5d5fbe79SDavid van MoolenbroekGENERATE_DOCSET        = NO
1249*5d5fbe79SDavid van Moolenbroek
1250*5d5fbe79SDavid van Moolenbroek# This tag determines the name of the docset feed. A documentation feed provides
1251*5d5fbe79SDavid van Moolenbroek# an umbrella under which multiple documentation sets from a single provider
1252*5d5fbe79SDavid van Moolenbroek# (such as a company or product suite) can be grouped.
1253*5d5fbe79SDavid van Moolenbroek# The default value is: Doxygen generated docs.
1254*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_DOCSET is set to YES.
1255*5d5fbe79SDavid van Moolenbroek
1256*5d5fbe79SDavid van MoolenbroekDOCSET_FEEDNAME        = "Doxygen generated docs"
1257*5d5fbe79SDavid van Moolenbroek
1258*5d5fbe79SDavid van Moolenbroek# This tag specifies a string that should uniquely identify the documentation
1259*5d5fbe79SDavid van Moolenbroek# set bundle. This should be a reverse domain-name style string, e.g.
1260*5d5fbe79SDavid van Moolenbroek# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1261*5d5fbe79SDavid van Moolenbroek# The default value is: org.doxygen.Project.
1262*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_DOCSET is set to YES.
1263*5d5fbe79SDavid van Moolenbroek
1264*5d5fbe79SDavid van MoolenbroekDOCSET_BUNDLE_ID       = org.doxygen.Project
1265*5d5fbe79SDavid van Moolenbroek
1266*5d5fbe79SDavid van Moolenbroek# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1267*5d5fbe79SDavid van Moolenbroek# the documentation publisher. This should be a reverse domain-name style
1268*5d5fbe79SDavid van Moolenbroek# string, e.g. com.mycompany.MyDocSet.documentation.
1269*5d5fbe79SDavid van Moolenbroek# The default value is: org.doxygen.Publisher.
1270*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_DOCSET is set to YES.
1271*5d5fbe79SDavid van Moolenbroek
1272*5d5fbe79SDavid van MoolenbroekDOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1273*5d5fbe79SDavid van Moolenbroek
1274*5d5fbe79SDavid van Moolenbroek# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1275*5d5fbe79SDavid van Moolenbroek# The default value is: Publisher.
1276*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_DOCSET is set to YES.
1277*5d5fbe79SDavid van Moolenbroek
1278*5d5fbe79SDavid van MoolenbroekDOCSET_PUBLISHER_NAME  = Publisher
1279*5d5fbe79SDavid van Moolenbroek
1280*5d5fbe79SDavid van Moolenbroek# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1281*5d5fbe79SDavid van Moolenbroek# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1282*5d5fbe79SDavid van Moolenbroek# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1283*5d5fbe79SDavid van Moolenbroek# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1284*5d5fbe79SDavid van Moolenbroek# Windows.
1285*5d5fbe79SDavid van Moolenbroek#
1286*5d5fbe79SDavid van Moolenbroek# The HTML Help Workshop contains a compiler that can convert all HTML output
1287*5d5fbe79SDavid van Moolenbroek# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1288*5d5fbe79SDavid van Moolenbroek# files are now used as the Windows 98 help format, and will replace the old
1289*5d5fbe79SDavid van Moolenbroek# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1290*5d5fbe79SDavid van Moolenbroek# HTML files also contain an index, a table of contents, and you can search for
1291*5d5fbe79SDavid van Moolenbroek# words in the documentation. The HTML workshop also contains a viewer for
1292*5d5fbe79SDavid van Moolenbroek# compressed HTML files.
1293*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1294*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTML is set to YES.
1295*5d5fbe79SDavid van Moolenbroek
1296*5d5fbe79SDavid van MoolenbroekGENERATE_HTMLHELP      = NO
1297*5d5fbe79SDavid van Moolenbroek
1298*5d5fbe79SDavid van Moolenbroek# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1299*5d5fbe79SDavid van Moolenbroek# file. You can add a path in front of the file if the result should not be
1300*5d5fbe79SDavid van Moolenbroek# written to the html output directory.
1301*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1302*5d5fbe79SDavid van Moolenbroek
1303*5d5fbe79SDavid van MoolenbroekCHM_FILE               = lwip.chm
1304*5d5fbe79SDavid van Moolenbroek
1305*5d5fbe79SDavid van Moolenbroek# The HHC_LOCATION tag can be used to specify the location (absolute path
1306*5d5fbe79SDavid van Moolenbroek# including file name) of the HTML help compiler (hhc.exe). If non-empty,
1307*5d5fbe79SDavid van Moolenbroek# doxygen will try to run the HTML help compiler on the generated index.hhp.
1308*5d5fbe79SDavid van Moolenbroek# The file has to be specified with full path.
1309*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1310*5d5fbe79SDavid van Moolenbroek
1311*5d5fbe79SDavid van MoolenbroekHHC_LOCATION           =
1312*5d5fbe79SDavid van Moolenbroek
1313*5d5fbe79SDavid van Moolenbroek# The GENERATE_CHI flag controls if a separate .chi index file is generated
1314*5d5fbe79SDavid van Moolenbroek# (YES) or that it should be included in the master .chm file (NO).
1315*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1316*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1317*5d5fbe79SDavid van Moolenbroek
1318*5d5fbe79SDavid van MoolenbroekGENERATE_CHI           = NO
1319*5d5fbe79SDavid van Moolenbroek
1320*5d5fbe79SDavid van Moolenbroek# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1321*5d5fbe79SDavid van Moolenbroek# and project file content.
1322*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1323*5d5fbe79SDavid van Moolenbroek
1324*5d5fbe79SDavid van MoolenbroekCHM_INDEX_ENCODING     =
1325*5d5fbe79SDavid van Moolenbroek
1326*5d5fbe79SDavid van Moolenbroek# The BINARY_TOC flag controls whether a binary table of contents is generated
1327*5d5fbe79SDavid van Moolenbroek# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1328*5d5fbe79SDavid van Moolenbroek# enables the Previous and Next buttons.
1329*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1330*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1331*5d5fbe79SDavid van Moolenbroek
1332*5d5fbe79SDavid van MoolenbroekBINARY_TOC             = NO
1333*5d5fbe79SDavid van Moolenbroek
1334*5d5fbe79SDavid van Moolenbroek# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1335*5d5fbe79SDavid van Moolenbroek# the table of contents of the HTML help documentation and to the tree view.
1336*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1337*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1338*5d5fbe79SDavid van Moolenbroek
1339*5d5fbe79SDavid van MoolenbroekTOC_EXPAND             = NO
1340*5d5fbe79SDavid van Moolenbroek
1341*5d5fbe79SDavid van Moolenbroek# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1342*5d5fbe79SDavid van Moolenbroek# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1343*5d5fbe79SDavid van Moolenbroek# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1344*5d5fbe79SDavid van Moolenbroek# (.qch) of the generated HTML documentation.
1345*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1346*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTML is set to YES.
1347*5d5fbe79SDavid van Moolenbroek
1348*5d5fbe79SDavid van MoolenbroekGENERATE_QHP           = NO
1349*5d5fbe79SDavid van Moolenbroek
1350*5d5fbe79SDavid van Moolenbroek# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1351*5d5fbe79SDavid van Moolenbroek# the file name of the resulting .qch file. The path specified is relative to
1352*5d5fbe79SDavid van Moolenbroek# the HTML output folder.
1353*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_QHP is set to YES.
1354*5d5fbe79SDavid van Moolenbroek
1355*5d5fbe79SDavid van MoolenbroekQCH_FILE               =
1356*5d5fbe79SDavid van Moolenbroek
1357*5d5fbe79SDavid van Moolenbroek# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1358*5d5fbe79SDavid van Moolenbroek# Project output. For more information please see Qt Help Project / Namespace
1359*5d5fbe79SDavid van Moolenbroek# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1360*5d5fbe79SDavid van Moolenbroek# The default value is: org.doxygen.Project.
1361*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_QHP is set to YES.
1362*5d5fbe79SDavid van Moolenbroek
1363*5d5fbe79SDavid van MoolenbroekQHP_NAMESPACE          = org.doxygen.Project
1364*5d5fbe79SDavid van Moolenbroek
1365*5d5fbe79SDavid van Moolenbroek# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1366*5d5fbe79SDavid van Moolenbroek# Help Project output. For more information please see Qt Help Project / Virtual
1367*5d5fbe79SDavid van Moolenbroek# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1368*5d5fbe79SDavid van Moolenbroek# folders).
1369*5d5fbe79SDavid van Moolenbroek# The default value is: doc.
1370*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_QHP is set to YES.
1371*5d5fbe79SDavid van Moolenbroek
1372*5d5fbe79SDavid van MoolenbroekQHP_VIRTUAL_FOLDER     = doc
1373*5d5fbe79SDavid van Moolenbroek
1374*5d5fbe79SDavid van Moolenbroek# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1375*5d5fbe79SDavid van Moolenbroek# filter to add. For more information please see Qt Help Project / Custom
1376*5d5fbe79SDavid van Moolenbroek# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1377*5d5fbe79SDavid van Moolenbroek# filters).
1378*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_QHP is set to YES.
1379*5d5fbe79SDavid van Moolenbroek
1380*5d5fbe79SDavid van MoolenbroekQHP_CUST_FILTER_NAME   =
1381*5d5fbe79SDavid van Moolenbroek
1382*5d5fbe79SDavid van Moolenbroek# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1383*5d5fbe79SDavid van Moolenbroek# custom filter to add. For more information please see Qt Help Project / Custom
1384*5d5fbe79SDavid van Moolenbroek# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1385*5d5fbe79SDavid van Moolenbroek# filters).
1386*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_QHP is set to YES.
1387*5d5fbe79SDavid van Moolenbroek
1388*5d5fbe79SDavid van MoolenbroekQHP_CUST_FILTER_ATTRS  =
1389*5d5fbe79SDavid van Moolenbroek
1390*5d5fbe79SDavid van Moolenbroek# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1391*5d5fbe79SDavid van Moolenbroek# project's filter section matches. Qt Help Project / Filter Attributes (see:
1392*5d5fbe79SDavid van Moolenbroek# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1393*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_QHP is set to YES.
1394*5d5fbe79SDavid van Moolenbroek
1395*5d5fbe79SDavid van MoolenbroekQHP_SECT_FILTER_ATTRS  =
1396*5d5fbe79SDavid van Moolenbroek
1397*5d5fbe79SDavid van Moolenbroek# The QHG_LOCATION tag can be used to specify the location of Qt's
1398*5d5fbe79SDavid van Moolenbroek# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1399*5d5fbe79SDavid van Moolenbroek# generated .qhp file.
1400*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_QHP is set to YES.
1401*5d5fbe79SDavid van Moolenbroek
1402*5d5fbe79SDavid van MoolenbroekQHG_LOCATION           =
1403*5d5fbe79SDavid van Moolenbroek
1404*5d5fbe79SDavid van Moolenbroek# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1405*5d5fbe79SDavid van Moolenbroek# generated, together with the HTML files, they form an Eclipse help plugin. To
1406*5d5fbe79SDavid van Moolenbroek# install this plugin and make it available under the help contents menu in
1407*5d5fbe79SDavid van Moolenbroek# Eclipse, the contents of the directory containing the HTML and XML files needs
1408*5d5fbe79SDavid van Moolenbroek# to be copied into the plugins directory of eclipse. The name of the directory
1409*5d5fbe79SDavid van Moolenbroek# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1410*5d5fbe79SDavid van Moolenbroek# After copying Eclipse needs to be restarted before the help appears.
1411*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1412*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTML is set to YES.
1413*5d5fbe79SDavid van Moolenbroek
1414*5d5fbe79SDavid van MoolenbroekGENERATE_ECLIPSEHELP   = NO
1415*5d5fbe79SDavid van Moolenbroek
1416*5d5fbe79SDavid van Moolenbroek# A unique identifier for the Eclipse help plugin. When installing the plugin
1417*5d5fbe79SDavid van Moolenbroek# the directory name containing the HTML and XML files should also have this
1418*5d5fbe79SDavid van Moolenbroek# name. Each documentation set should have its own identifier.
1419*5d5fbe79SDavid van Moolenbroek# The default value is: org.doxygen.Project.
1420*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1421*5d5fbe79SDavid van Moolenbroek
1422*5d5fbe79SDavid van MoolenbroekECLIPSE_DOC_ID         = org.doxygen.Project
1423*5d5fbe79SDavid van Moolenbroek
1424*5d5fbe79SDavid van Moolenbroek# If you want full control over the layout of the generated HTML pages it might
1425*5d5fbe79SDavid van Moolenbroek# be necessary to disable the index and replace it with your own. The
1426*5d5fbe79SDavid van Moolenbroek# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1427*5d5fbe79SDavid van Moolenbroek# of each HTML page. A value of NO enables the index and the value YES disables
1428*5d5fbe79SDavid van Moolenbroek# it. Since the tabs in the index contain the same information as the navigation
1429*5d5fbe79SDavid van Moolenbroek# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1430*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1431*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTML is set to YES.
1432*5d5fbe79SDavid van Moolenbroek
1433*5d5fbe79SDavid van MoolenbroekDISABLE_INDEX          = NO
1434*5d5fbe79SDavid van Moolenbroek
1435*5d5fbe79SDavid van Moolenbroek# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1436*5d5fbe79SDavid van Moolenbroek# structure should be generated to display hierarchical information. If the tag
1437*5d5fbe79SDavid van Moolenbroek# value is set to YES, a side panel will be generated containing a tree-like
1438*5d5fbe79SDavid van Moolenbroek# index structure (just like the one that is generated for HTML Help). For this
1439*5d5fbe79SDavid van Moolenbroek# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1440*5d5fbe79SDavid van Moolenbroek# (i.e. any modern browser). Windows users are probably better off using the
1441*5d5fbe79SDavid van Moolenbroek# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1442*5d5fbe79SDavid van Moolenbroek# further fine-tune the look of the index. As an example, the default style
1443*5d5fbe79SDavid van Moolenbroek# sheet generated by doxygen has an example that shows how to put an image at
1444*5d5fbe79SDavid van Moolenbroek# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1445*5d5fbe79SDavid van Moolenbroek# the same information as the tab index, you could consider setting
1446*5d5fbe79SDavid van Moolenbroek# DISABLE_INDEX to YES when enabling this option.
1447*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1448*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTML is set to YES.
1449*5d5fbe79SDavid van Moolenbroek
1450*5d5fbe79SDavid van MoolenbroekGENERATE_TREEVIEW      = YES
1451*5d5fbe79SDavid van Moolenbroek
1452*5d5fbe79SDavid van Moolenbroek# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1453*5d5fbe79SDavid van Moolenbroek# doxygen will group on one line in the generated HTML documentation.
1454*5d5fbe79SDavid van Moolenbroek#
1455*5d5fbe79SDavid van Moolenbroek# Note that a value of 0 will completely suppress the enum values from appearing
1456*5d5fbe79SDavid van Moolenbroek# in the overview section.
1457*5d5fbe79SDavid van Moolenbroek# Minimum value: 0, maximum value: 20, default value: 4.
1458*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTML is set to YES.
1459*5d5fbe79SDavid van Moolenbroek
1460*5d5fbe79SDavid van MoolenbroekENUM_VALUES_PER_LINE   = 4
1461*5d5fbe79SDavid van Moolenbroek
1462*5d5fbe79SDavid van Moolenbroek# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1463*5d5fbe79SDavid van Moolenbroek# to set the initial width (in pixels) of the frame in which the tree is shown.
1464*5d5fbe79SDavid van Moolenbroek# Minimum value: 0, maximum value: 1500, default value: 250.
1465*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTML is set to YES.
1466*5d5fbe79SDavid van Moolenbroek
1467*5d5fbe79SDavid van MoolenbroekTREEVIEW_WIDTH         = 250
1468*5d5fbe79SDavid van Moolenbroek
1469*5d5fbe79SDavid van Moolenbroek# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1470*5d5fbe79SDavid van Moolenbroek# external symbols imported via tag files in a separate window.
1471*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1472*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTML is set to YES.
1473*5d5fbe79SDavid van Moolenbroek
1474*5d5fbe79SDavid van MoolenbroekEXT_LINKS_IN_WINDOW    = NO
1475*5d5fbe79SDavid van Moolenbroek
1476*5d5fbe79SDavid van Moolenbroek# Use this tag to change the font size of LaTeX formulas included as images in
1477*5d5fbe79SDavid van Moolenbroek# the HTML documentation. When you change the font size after a successful
1478*5d5fbe79SDavid van Moolenbroek# doxygen run you need to manually remove any form_*.png images from the HTML
1479*5d5fbe79SDavid van Moolenbroek# output directory to force them to be regenerated.
1480*5d5fbe79SDavid van Moolenbroek# Minimum value: 8, maximum value: 50, default value: 10.
1481*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTML is set to YES.
1482*5d5fbe79SDavid van Moolenbroek
1483*5d5fbe79SDavid van MoolenbroekFORMULA_FONTSIZE       = 10
1484*5d5fbe79SDavid van Moolenbroek
1485*5d5fbe79SDavid van Moolenbroek# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1486*5d5fbe79SDavid van Moolenbroek# generated for formulas are transparent PNGs. Transparent PNGs are not
1487*5d5fbe79SDavid van Moolenbroek# supported properly for IE 6.0, but are supported on all modern browsers.
1488*5d5fbe79SDavid van Moolenbroek#
1489*5d5fbe79SDavid van Moolenbroek# Note that when changing this option you need to delete any form_*.png files in
1490*5d5fbe79SDavid van Moolenbroek# the HTML output directory before the changes have effect.
1491*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
1492*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTML is set to YES.
1493*5d5fbe79SDavid van Moolenbroek
1494*5d5fbe79SDavid van MoolenbroekFORMULA_TRANSPARENT    = YES
1495*5d5fbe79SDavid van Moolenbroek
1496*5d5fbe79SDavid van Moolenbroek# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1497*5d5fbe79SDavid van Moolenbroek# http://www.mathjax.org) which uses client side Javascript for the rendering
1498*5d5fbe79SDavid van Moolenbroek# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1499*5d5fbe79SDavid van Moolenbroek# installed or if you want to formulas look prettier in the HTML output. When
1500*5d5fbe79SDavid van Moolenbroek# enabled you may also need to install MathJax separately and configure the path
1501*5d5fbe79SDavid van Moolenbroek# to it using the MATHJAX_RELPATH option.
1502*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1503*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTML is set to YES.
1504*5d5fbe79SDavid van Moolenbroek
1505*5d5fbe79SDavid van MoolenbroekUSE_MATHJAX            = NO
1506*5d5fbe79SDavid van Moolenbroek
1507*5d5fbe79SDavid van Moolenbroek# When MathJax is enabled you can set the default output format to be used for
1508*5d5fbe79SDavid van Moolenbroek# the MathJax output. See the MathJax site (see:
1509*5d5fbe79SDavid van Moolenbroek# http://docs.mathjax.org/en/latest/output.html) for more details.
1510*5d5fbe79SDavid van Moolenbroek# Possible values are: HTML-CSS (which is slower, but has the best
1511*5d5fbe79SDavid van Moolenbroek# compatibility), NativeMML (i.e. MathML) and SVG.
1512*5d5fbe79SDavid van Moolenbroek# The default value is: HTML-CSS.
1513*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag USE_MATHJAX is set to YES.
1514*5d5fbe79SDavid van Moolenbroek
1515*5d5fbe79SDavid van MoolenbroekMATHJAX_FORMAT         = HTML-CSS
1516*5d5fbe79SDavid van Moolenbroek
1517*5d5fbe79SDavid van Moolenbroek# When MathJax is enabled you need to specify the location relative to the HTML
1518*5d5fbe79SDavid van Moolenbroek# output directory using the MATHJAX_RELPATH option. The destination directory
1519*5d5fbe79SDavid van Moolenbroek# should contain the MathJax.js script. For instance, if the mathjax directory
1520*5d5fbe79SDavid van Moolenbroek# is located at the same level as the HTML output directory, then
1521*5d5fbe79SDavid van Moolenbroek# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1522*5d5fbe79SDavid van Moolenbroek# Content Delivery Network so you can quickly see the result without installing
1523*5d5fbe79SDavid van Moolenbroek# MathJax. However, it is strongly recommended to install a local copy of
1524*5d5fbe79SDavid van Moolenbroek# MathJax from http://www.mathjax.org before deployment.
1525*5d5fbe79SDavid van Moolenbroek# The default value is: http://cdn.mathjax.org/mathjax/latest.
1526*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag USE_MATHJAX is set to YES.
1527*5d5fbe79SDavid van Moolenbroek
1528*5d5fbe79SDavid van MoolenbroekMATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
1529*5d5fbe79SDavid van Moolenbroek
1530*5d5fbe79SDavid van Moolenbroek# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1531*5d5fbe79SDavid van Moolenbroek# extension names that should be enabled during MathJax rendering. For example
1532*5d5fbe79SDavid van Moolenbroek# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1533*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag USE_MATHJAX is set to YES.
1534*5d5fbe79SDavid van Moolenbroek
1535*5d5fbe79SDavid van MoolenbroekMATHJAX_EXTENSIONS     =
1536*5d5fbe79SDavid van Moolenbroek
1537*5d5fbe79SDavid van Moolenbroek# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1538*5d5fbe79SDavid van Moolenbroek# of code that will be used on startup of the MathJax code. See the MathJax site
1539*5d5fbe79SDavid van Moolenbroek# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1540*5d5fbe79SDavid van Moolenbroek# example see the documentation.
1541*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag USE_MATHJAX is set to YES.
1542*5d5fbe79SDavid van Moolenbroek
1543*5d5fbe79SDavid van MoolenbroekMATHJAX_CODEFILE       =
1544*5d5fbe79SDavid van Moolenbroek
1545*5d5fbe79SDavid van Moolenbroek# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1546*5d5fbe79SDavid van Moolenbroek# the HTML output. The underlying search engine uses javascript and DHTML and
1547*5d5fbe79SDavid van Moolenbroek# should work on any modern browser. Note that when using HTML help
1548*5d5fbe79SDavid van Moolenbroek# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1549*5d5fbe79SDavid van Moolenbroek# there is already a search function so this one should typically be disabled.
1550*5d5fbe79SDavid van Moolenbroek# For large projects the javascript based search engine can be slow, then
1551*5d5fbe79SDavid van Moolenbroek# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1552*5d5fbe79SDavid van Moolenbroek# search using the keyboard; to jump to the search box use <access key> + S
1553*5d5fbe79SDavid van Moolenbroek# (what the <access key> is depends on the OS and browser, but it is typically
1554*5d5fbe79SDavid van Moolenbroek# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1555*5d5fbe79SDavid van Moolenbroek# key> to jump into the search results window, the results can be navigated
1556*5d5fbe79SDavid van Moolenbroek# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1557*5d5fbe79SDavid van Moolenbroek# the search. The filter options can be selected when the cursor is inside the
1558*5d5fbe79SDavid van Moolenbroek# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1559*5d5fbe79SDavid van Moolenbroek# to select a filter and <Enter> or <escape> to activate or cancel the filter
1560*5d5fbe79SDavid van Moolenbroek# option.
1561*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
1562*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_HTML is set to YES.
1563*5d5fbe79SDavid van Moolenbroek
1564*5d5fbe79SDavid van MoolenbroekSEARCHENGINE           = YES
1565*5d5fbe79SDavid van Moolenbroek
1566*5d5fbe79SDavid van Moolenbroek# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1567*5d5fbe79SDavid van Moolenbroek# implemented using a web server instead of a web client using Javascript. There
1568*5d5fbe79SDavid van Moolenbroek# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1569*5d5fbe79SDavid van Moolenbroek# setting. When disabled, doxygen will generate a PHP script for searching and
1570*5d5fbe79SDavid van Moolenbroek# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1571*5d5fbe79SDavid van Moolenbroek# and searching needs to be provided by external tools. See the section
1572*5d5fbe79SDavid van Moolenbroek# "External Indexing and Searching" for details.
1573*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1574*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag SEARCHENGINE is set to YES.
1575*5d5fbe79SDavid van Moolenbroek
1576*5d5fbe79SDavid van MoolenbroekSERVER_BASED_SEARCH    = NO
1577*5d5fbe79SDavid van Moolenbroek
1578*5d5fbe79SDavid van Moolenbroek# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1579*5d5fbe79SDavid van Moolenbroek# script for searching. Instead the search results are written to an XML file
1580*5d5fbe79SDavid van Moolenbroek# which needs to be processed by an external indexer. Doxygen will invoke an
1581*5d5fbe79SDavid van Moolenbroek# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1582*5d5fbe79SDavid van Moolenbroek# search results.
1583*5d5fbe79SDavid van Moolenbroek#
1584*5d5fbe79SDavid van Moolenbroek# Doxygen ships with an example indexer (doxyindexer) and search engine
1585*5d5fbe79SDavid van Moolenbroek# (doxysearch.cgi) which are based on the open source search engine library
1586*5d5fbe79SDavid van Moolenbroek# Xapian (see: http://xapian.org/).
1587*5d5fbe79SDavid van Moolenbroek#
1588*5d5fbe79SDavid van Moolenbroek# See the section "External Indexing and Searching" for details.
1589*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1590*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag SEARCHENGINE is set to YES.
1591*5d5fbe79SDavid van Moolenbroek
1592*5d5fbe79SDavid van MoolenbroekEXTERNAL_SEARCH        = NO
1593*5d5fbe79SDavid van Moolenbroek
1594*5d5fbe79SDavid van Moolenbroek# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1595*5d5fbe79SDavid van Moolenbroek# which will return the search results when EXTERNAL_SEARCH is enabled.
1596*5d5fbe79SDavid van Moolenbroek#
1597*5d5fbe79SDavid van Moolenbroek# Doxygen ships with an example indexer (doxyindexer) and search engine
1598*5d5fbe79SDavid van Moolenbroek# (doxysearch.cgi) which are based on the open source search engine library
1599*5d5fbe79SDavid van Moolenbroek# Xapian (see: http://xapian.org/). See the section "External Indexing and
1600*5d5fbe79SDavid van Moolenbroek# Searching" for details.
1601*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag SEARCHENGINE is set to YES.
1602*5d5fbe79SDavid van Moolenbroek
1603*5d5fbe79SDavid van MoolenbroekSEARCHENGINE_URL       =
1604*5d5fbe79SDavid van Moolenbroek
1605*5d5fbe79SDavid van Moolenbroek# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1606*5d5fbe79SDavid van Moolenbroek# search data is written to a file for indexing by an external tool. With the
1607*5d5fbe79SDavid van Moolenbroek# SEARCHDATA_FILE tag the name of this file can be specified.
1608*5d5fbe79SDavid van Moolenbroek# The default file is: searchdata.xml.
1609*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag SEARCHENGINE is set to YES.
1610*5d5fbe79SDavid van Moolenbroek
1611*5d5fbe79SDavid van MoolenbroekSEARCHDATA_FILE        = searchdata.xml
1612*5d5fbe79SDavid van Moolenbroek
1613*5d5fbe79SDavid van Moolenbroek# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1614*5d5fbe79SDavid van Moolenbroek# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1615*5d5fbe79SDavid van Moolenbroek# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1616*5d5fbe79SDavid van Moolenbroek# projects and redirect the results back to the right project.
1617*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag SEARCHENGINE is set to YES.
1618*5d5fbe79SDavid van Moolenbroek
1619*5d5fbe79SDavid van MoolenbroekEXTERNAL_SEARCH_ID     =
1620*5d5fbe79SDavid van Moolenbroek
1621*5d5fbe79SDavid van Moolenbroek# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1622*5d5fbe79SDavid van Moolenbroek# projects other than the one defined by this configuration file, but that are
1623*5d5fbe79SDavid van Moolenbroek# all added to the same external search index. Each project needs to have a
1624*5d5fbe79SDavid van Moolenbroek# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1625*5d5fbe79SDavid van Moolenbroek# to a relative location where the documentation can be found. The format is:
1626*5d5fbe79SDavid van Moolenbroek# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1627*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag SEARCHENGINE is set to YES.
1628*5d5fbe79SDavid van Moolenbroek
1629*5d5fbe79SDavid van MoolenbroekEXTRA_SEARCH_MAPPINGS  =
1630*5d5fbe79SDavid van Moolenbroek
1631*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
1632*5d5fbe79SDavid van Moolenbroek# Configuration options related to the LaTeX output
1633*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
1634*5d5fbe79SDavid van Moolenbroek
1635*5d5fbe79SDavid van Moolenbroek# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1636*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
1637*5d5fbe79SDavid van Moolenbroek
1638*5d5fbe79SDavid van MoolenbroekGENERATE_LATEX         = NO
1639*5d5fbe79SDavid van Moolenbroek
1640*5d5fbe79SDavid van Moolenbroek# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1641*5d5fbe79SDavid van Moolenbroek# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1642*5d5fbe79SDavid van Moolenbroek# it.
1643*5d5fbe79SDavid van Moolenbroek# The default directory is: latex.
1644*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_LATEX is set to YES.
1645*5d5fbe79SDavid van Moolenbroek
1646*5d5fbe79SDavid van MoolenbroekLATEX_OUTPUT           = latex
1647*5d5fbe79SDavid van Moolenbroek
1648*5d5fbe79SDavid van Moolenbroek# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1649*5d5fbe79SDavid van Moolenbroek# invoked.
1650*5d5fbe79SDavid van Moolenbroek#
1651*5d5fbe79SDavid van Moolenbroek# Note that when enabling USE_PDFLATEX this option is only used for generating
1652*5d5fbe79SDavid van Moolenbroek# bitmaps for formulas in the HTML output, but not in the Makefile that is
1653*5d5fbe79SDavid van Moolenbroek# written to the output directory.
1654*5d5fbe79SDavid van Moolenbroek# The default file is: latex.
1655*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_LATEX is set to YES.
1656*5d5fbe79SDavid van Moolenbroek
1657*5d5fbe79SDavid van MoolenbroekLATEX_CMD_NAME         = latex
1658*5d5fbe79SDavid van Moolenbroek
1659*5d5fbe79SDavid van Moolenbroek# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1660*5d5fbe79SDavid van Moolenbroek# index for LaTeX.
1661*5d5fbe79SDavid van Moolenbroek# The default file is: makeindex.
1662*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_LATEX is set to YES.
1663*5d5fbe79SDavid van Moolenbroek
1664*5d5fbe79SDavid van MoolenbroekMAKEINDEX_CMD_NAME     = makeindex
1665*5d5fbe79SDavid van Moolenbroek
1666*5d5fbe79SDavid van Moolenbroek# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1667*5d5fbe79SDavid van Moolenbroek# documents. This may be useful for small projects and may help to save some
1668*5d5fbe79SDavid van Moolenbroek# trees in general.
1669*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1670*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_LATEX is set to YES.
1671*5d5fbe79SDavid van Moolenbroek
1672*5d5fbe79SDavid van MoolenbroekCOMPACT_LATEX          = NO
1673*5d5fbe79SDavid van Moolenbroek
1674*5d5fbe79SDavid van Moolenbroek# The PAPER_TYPE tag can be used to set the paper type that is used by the
1675*5d5fbe79SDavid van Moolenbroek# printer.
1676*5d5fbe79SDavid van Moolenbroek# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1677*5d5fbe79SDavid van Moolenbroek# 14 inches) and executive (7.25 x 10.5 inches).
1678*5d5fbe79SDavid van Moolenbroek# The default value is: a4.
1679*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_LATEX is set to YES.
1680*5d5fbe79SDavid van Moolenbroek
1681*5d5fbe79SDavid van MoolenbroekPAPER_TYPE             = a4wide
1682*5d5fbe79SDavid van Moolenbroek
1683*5d5fbe79SDavid van Moolenbroek# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1684*5d5fbe79SDavid van Moolenbroek# that should be included in the LaTeX output. The package can be specified just
1685*5d5fbe79SDavid van Moolenbroek# by its name or with the correct syntax as to be used with the LaTeX
1686*5d5fbe79SDavid van Moolenbroek# \usepackage command. To get the times font for instance you can specify :
1687*5d5fbe79SDavid van Moolenbroek# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1688*5d5fbe79SDavid van Moolenbroek# To use the option intlimits with the amsmath package you can specify:
1689*5d5fbe79SDavid van Moolenbroek# EXTRA_PACKAGES=[intlimits]{amsmath}
1690*5d5fbe79SDavid van Moolenbroek# If left blank no extra packages will be included.
1691*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_LATEX is set to YES.
1692*5d5fbe79SDavid van Moolenbroek
1693*5d5fbe79SDavid van MoolenbroekEXTRA_PACKAGES         =
1694*5d5fbe79SDavid van Moolenbroek
1695*5d5fbe79SDavid van Moolenbroek# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1696*5d5fbe79SDavid van Moolenbroek# generated LaTeX document. The header should contain everything until the first
1697*5d5fbe79SDavid van Moolenbroek# chapter. If it is left blank doxygen will generate a standard header. See
1698*5d5fbe79SDavid van Moolenbroek# section "Doxygen usage" for information on how to let doxygen write the
1699*5d5fbe79SDavid van Moolenbroek# default header to a separate file.
1700*5d5fbe79SDavid van Moolenbroek#
1701*5d5fbe79SDavid van Moolenbroek# Note: Only use a user-defined header if you know what you are doing! The
1702*5d5fbe79SDavid van Moolenbroek# following commands have a special meaning inside the header: $title,
1703*5d5fbe79SDavid van Moolenbroek# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1704*5d5fbe79SDavid van Moolenbroek# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1705*5d5fbe79SDavid van Moolenbroek# string, for the replacement values of the other commands the user is referred
1706*5d5fbe79SDavid van Moolenbroek# to HTML_HEADER.
1707*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_LATEX is set to YES.
1708*5d5fbe79SDavid van Moolenbroek
1709*5d5fbe79SDavid van MoolenbroekLATEX_HEADER           =
1710*5d5fbe79SDavid van Moolenbroek
1711*5d5fbe79SDavid van Moolenbroek# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1712*5d5fbe79SDavid van Moolenbroek# generated LaTeX document. The footer should contain everything after the last
1713*5d5fbe79SDavid van Moolenbroek# chapter. If it is left blank doxygen will generate a standard footer. See
1714*5d5fbe79SDavid van Moolenbroek# LATEX_HEADER for more information on how to generate a default footer and what
1715*5d5fbe79SDavid van Moolenbroek# special commands can be used inside the footer.
1716*5d5fbe79SDavid van Moolenbroek#
1717*5d5fbe79SDavid van Moolenbroek# Note: Only use a user-defined footer if you know what you are doing!
1718*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_LATEX is set to YES.
1719*5d5fbe79SDavid van Moolenbroek
1720*5d5fbe79SDavid van MoolenbroekLATEX_FOOTER           =
1721*5d5fbe79SDavid van Moolenbroek
1722*5d5fbe79SDavid van Moolenbroek# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1723*5d5fbe79SDavid van Moolenbroek# LaTeX style sheets that are included after the standard style sheets created
1724*5d5fbe79SDavid van Moolenbroek# by doxygen. Using this option one can overrule certain style aspects. Doxygen
1725*5d5fbe79SDavid van Moolenbroek# will copy the style sheet files to the output directory.
1726*5d5fbe79SDavid van Moolenbroek# Note: The order of the extra style sheet files is of importance (e.g. the last
1727*5d5fbe79SDavid van Moolenbroek# style sheet in the list overrules the setting of the previous ones in the
1728*5d5fbe79SDavid van Moolenbroek# list).
1729*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_LATEX is set to YES.
1730*5d5fbe79SDavid van Moolenbroek
1731*5d5fbe79SDavid van MoolenbroekLATEX_EXTRA_STYLESHEET =
1732*5d5fbe79SDavid van Moolenbroek
1733*5d5fbe79SDavid van Moolenbroek# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1734*5d5fbe79SDavid van Moolenbroek# other source files which should be copied to the LATEX_OUTPUT output
1735*5d5fbe79SDavid van Moolenbroek# directory. Note that the files will be copied as-is; there are no commands or
1736*5d5fbe79SDavid van Moolenbroek# markers available.
1737*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_LATEX is set to YES.
1738*5d5fbe79SDavid van Moolenbroek
1739*5d5fbe79SDavid van MoolenbroekLATEX_EXTRA_FILES      =
1740*5d5fbe79SDavid van Moolenbroek
1741*5d5fbe79SDavid van Moolenbroek# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1742*5d5fbe79SDavid van Moolenbroek# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1743*5d5fbe79SDavid van Moolenbroek# contain links (just like the HTML output) instead of page references. This
1744*5d5fbe79SDavid van Moolenbroek# makes the output suitable for online browsing using a PDF viewer.
1745*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
1746*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_LATEX is set to YES.
1747*5d5fbe79SDavid van Moolenbroek
1748*5d5fbe79SDavid van MoolenbroekPDF_HYPERLINKS         = NO
1749*5d5fbe79SDavid van Moolenbroek
1750*5d5fbe79SDavid van Moolenbroek# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1751*5d5fbe79SDavid van Moolenbroek# the PDF file directly from the LaTeX files. Set this option to YES, to get a
1752*5d5fbe79SDavid van Moolenbroek# higher quality PDF documentation.
1753*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
1754*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_LATEX is set to YES.
1755*5d5fbe79SDavid van Moolenbroek
1756*5d5fbe79SDavid van MoolenbroekUSE_PDFLATEX           = NO
1757*5d5fbe79SDavid van Moolenbroek
1758*5d5fbe79SDavid van Moolenbroek# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1759*5d5fbe79SDavid van Moolenbroek# command to the generated LaTeX files. This will instruct LaTeX to keep running
1760*5d5fbe79SDavid van Moolenbroek# if errors occur, instead of asking the user for help. This option is also used
1761*5d5fbe79SDavid van Moolenbroek# when generating formulas in HTML.
1762*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1763*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_LATEX is set to YES.
1764*5d5fbe79SDavid van Moolenbroek
1765*5d5fbe79SDavid van MoolenbroekLATEX_BATCHMODE        = NO
1766*5d5fbe79SDavid van Moolenbroek
1767*5d5fbe79SDavid van Moolenbroek# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1768*5d5fbe79SDavid van Moolenbroek# index chapters (such as File Index, Compound Index, etc.) in the output.
1769*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1770*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_LATEX is set to YES.
1771*5d5fbe79SDavid van Moolenbroek
1772*5d5fbe79SDavid van MoolenbroekLATEX_HIDE_INDICES     = NO
1773*5d5fbe79SDavid van Moolenbroek
1774*5d5fbe79SDavid van Moolenbroek# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1775*5d5fbe79SDavid van Moolenbroek# code with syntax highlighting in the LaTeX output.
1776*5d5fbe79SDavid van Moolenbroek#
1777*5d5fbe79SDavid van Moolenbroek# Note that which sources are shown also depends on other settings such as
1778*5d5fbe79SDavid van Moolenbroek# SOURCE_BROWSER.
1779*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1780*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_LATEX is set to YES.
1781*5d5fbe79SDavid van Moolenbroek
1782*5d5fbe79SDavid van MoolenbroekLATEX_SOURCE_CODE      = NO
1783*5d5fbe79SDavid van Moolenbroek
1784*5d5fbe79SDavid van Moolenbroek# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1785*5d5fbe79SDavid van Moolenbroek# bibliography, e.g. plainnat, or ieeetr. See
1786*5d5fbe79SDavid van Moolenbroek# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1787*5d5fbe79SDavid van Moolenbroek# The default value is: plain.
1788*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_LATEX is set to YES.
1789*5d5fbe79SDavid van Moolenbroek
1790*5d5fbe79SDavid van MoolenbroekLATEX_BIB_STYLE        = plain
1791*5d5fbe79SDavid van Moolenbroek
1792*5d5fbe79SDavid van Moolenbroek# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1793*5d5fbe79SDavid van Moolenbroek# page will contain the date and time when the page was generated. Setting this
1794*5d5fbe79SDavid van Moolenbroek# to NO can help when comparing the output of multiple runs.
1795*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1796*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_LATEX is set to YES.
1797*5d5fbe79SDavid van Moolenbroek
1798*5d5fbe79SDavid van MoolenbroekLATEX_TIMESTAMP        = NO
1799*5d5fbe79SDavid van Moolenbroek
1800*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
1801*5d5fbe79SDavid van Moolenbroek# Configuration options related to the RTF output
1802*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
1803*5d5fbe79SDavid van Moolenbroek
1804*5d5fbe79SDavid van Moolenbroek# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1805*5d5fbe79SDavid van Moolenbroek# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1806*5d5fbe79SDavid van Moolenbroek# readers/editors.
1807*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1808*5d5fbe79SDavid van Moolenbroek
1809*5d5fbe79SDavid van MoolenbroekGENERATE_RTF           = NO
1810*5d5fbe79SDavid van Moolenbroek
1811*5d5fbe79SDavid van Moolenbroek# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1812*5d5fbe79SDavid van Moolenbroek# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1813*5d5fbe79SDavid van Moolenbroek# it.
1814*5d5fbe79SDavid van Moolenbroek# The default directory is: rtf.
1815*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_RTF is set to YES.
1816*5d5fbe79SDavid van Moolenbroek
1817*5d5fbe79SDavid van MoolenbroekRTF_OUTPUT             = rtf
1818*5d5fbe79SDavid van Moolenbroek
1819*5d5fbe79SDavid van Moolenbroek# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1820*5d5fbe79SDavid van Moolenbroek# documents. This may be useful for small projects and may help to save some
1821*5d5fbe79SDavid van Moolenbroek# trees in general.
1822*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1823*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_RTF is set to YES.
1824*5d5fbe79SDavid van Moolenbroek
1825*5d5fbe79SDavid van MoolenbroekCOMPACT_RTF            = NO
1826*5d5fbe79SDavid van Moolenbroek
1827*5d5fbe79SDavid van Moolenbroek# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1828*5d5fbe79SDavid van Moolenbroek# contain hyperlink fields. The RTF file will contain links (just like the HTML
1829*5d5fbe79SDavid van Moolenbroek# output) instead of page references. This makes the output suitable for online
1830*5d5fbe79SDavid van Moolenbroek# browsing using Word or some other Word compatible readers that support those
1831*5d5fbe79SDavid van Moolenbroek# fields.
1832*5d5fbe79SDavid van Moolenbroek#
1833*5d5fbe79SDavid van Moolenbroek# Note: WordPad (write) and others do not support links.
1834*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1835*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_RTF is set to YES.
1836*5d5fbe79SDavid van Moolenbroek
1837*5d5fbe79SDavid van MoolenbroekRTF_HYPERLINKS         = NO
1838*5d5fbe79SDavid van Moolenbroek
1839*5d5fbe79SDavid van Moolenbroek# Load stylesheet definitions from file. Syntax is similar to doxygen's config
1840*5d5fbe79SDavid van Moolenbroek# file, i.e. a series of assignments. You only have to provide replacements,
1841*5d5fbe79SDavid van Moolenbroek# missing definitions are set to their default value.
1842*5d5fbe79SDavid van Moolenbroek#
1843*5d5fbe79SDavid van Moolenbroek# See also section "Doxygen usage" for information on how to generate the
1844*5d5fbe79SDavid van Moolenbroek# default style sheet that doxygen normally uses.
1845*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_RTF is set to YES.
1846*5d5fbe79SDavid van Moolenbroek
1847*5d5fbe79SDavid van MoolenbroekRTF_STYLESHEET_FILE    =
1848*5d5fbe79SDavid van Moolenbroek
1849*5d5fbe79SDavid van Moolenbroek# Set optional variables used in the generation of an RTF document. Syntax is
1850*5d5fbe79SDavid van Moolenbroek# similar to doxygen's config file. A template extensions file can be generated
1851*5d5fbe79SDavid van Moolenbroek# using doxygen -e rtf extensionFile.
1852*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_RTF is set to YES.
1853*5d5fbe79SDavid van Moolenbroek
1854*5d5fbe79SDavid van MoolenbroekRTF_EXTENSIONS_FILE    =
1855*5d5fbe79SDavid van Moolenbroek
1856*5d5fbe79SDavid van Moolenbroek# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1857*5d5fbe79SDavid van Moolenbroek# with syntax highlighting in the RTF output.
1858*5d5fbe79SDavid van Moolenbroek#
1859*5d5fbe79SDavid van Moolenbroek# Note that which sources are shown also depends on other settings such as
1860*5d5fbe79SDavid van Moolenbroek# SOURCE_BROWSER.
1861*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1862*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_RTF is set to YES.
1863*5d5fbe79SDavid van Moolenbroek
1864*5d5fbe79SDavid van MoolenbroekRTF_SOURCE_CODE        = NO
1865*5d5fbe79SDavid van Moolenbroek
1866*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
1867*5d5fbe79SDavid van Moolenbroek# Configuration options related to the man page output
1868*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
1869*5d5fbe79SDavid van Moolenbroek
1870*5d5fbe79SDavid van Moolenbroek# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1871*5d5fbe79SDavid van Moolenbroek# classes and files.
1872*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1873*5d5fbe79SDavid van Moolenbroek
1874*5d5fbe79SDavid van MoolenbroekGENERATE_MAN           = NO
1875*5d5fbe79SDavid van Moolenbroek
1876*5d5fbe79SDavid van Moolenbroek# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1877*5d5fbe79SDavid van Moolenbroek# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1878*5d5fbe79SDavid van Moolenbroek# it. A directory man3 will be created inside the directory specified by
1879*5d5fbe79SDavid van Moolenbroek# MAN_OUTPUT.
1880*5d5fbe79SDavid van Moolenbroek# The default directory is: man.
1881*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_MAN is set to YES.
1882*5d5fbe79SDavid van Moolenbroek
1883*5d5fbe79SDavid van MoolenbroekMAN_OUTPUT             = man
1884*5d5fbe79SDavid van Moolenbroek
1885*5d5fbe79SDavid van Moolenbroek# The MAN_EXTENSION tag determines the extension that is added to the generated
1886*5d5fbe79SDavid van Moolenbroek# man pages. In case the manual section does not start with a number, the number
1887*5d5fbe79SDavid van Moolenbroek# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1888*5d5fbe79SDavid van Moolenbroek# optional.
1889*5d5fbe79SDavid van Moolenbroek# The default value is: .3.
1890*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_MAN is set to YES.
1891*5d5fbe79SDavid van Moolenbroek
1892*5d5fbe79SDavid van MoolenbroekMAN_EXTENSION          = .3
1893*5d5fbe79SDavid van Moolenbroek
1894*5d5fbe79SDavid van Moolenbroek# The MAN_SUBDIR tag determines the name of the directory created within
1895*5d5fbe79SDavid van Moolenbroek# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1896*5d5fbe79SDavid van Moolenbroek# MAN_EXTENSION with the initial . removed.
1897*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_MAN is set to YES.
1898*5d5fbe79SDavid van Moolenbroek
1899*5d5fbe79SDavid van MoolenbroekMAN_SUBDIR             =
1900*5d5fbe79SDavid van Moolenbroek
1901*5d5fbe79SDavid van Moolenbroek# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1902*5d5fbe79SDavid van Moolenbroek# will generate one additional man file for each entity documented in the real
1903*5d5fbe79SDavid van Moolenbroek# man page(s). These additional files only source the real man page, but without
1904*5d5fbe79SDavid van Moolenbroek# them the man command would be unable to find the correct page.
1905*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1906*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_MAN is set to YES.
1907*5d5fbe79SDavid van Moolenbroek
1908*5d5fbe79SDavid van MoolenbroekMAN_LINKS              = NO
1909*5d5fbe79SDavid van Moolenbroek
1910*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
1911*5d5fbe79SDavid van Moolenbroek# Configuration options related to the XML output
1912*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
1913*5d5fbe79SDavid van Moolenbroek
1914*5d5fbe79SDavid van Moolenbroek# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1915*5d5fbe79SDavid van Moolenbroek# captures the structure of the code including all documentation.
1916*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1917*5d5fbe79SDavid van Moolenbroek
1918*5d5fbe79SDavid van MoolenbroekGENERATE_XML           = NO
1919*5d5fbe79SDavid van Moolenbroek
1920*5d5fbe79SDavid van Moolenbroek# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1921*5d5fbe79SDavid van Moolenbroek# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1922*5d5fbe79SDavid van Moolenbroek# it.
1923*5d5fbe79SDavid van Moolenbroek# The default directory is: xml.
1924*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_XML is set to YES.
1925*5d5fbe79SDavid van Moolenbroek
1926*5d5fbe79SDavid van MoolenbroekXML_OUTPUT             = xml
1927*5d5fbe79SDavid van Moolenbroek
1928*5d5fbe79SDavid van Moolenbroek# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1929*5d5fbe79SDavid van Moolenbroek# listings (including syntax highlighting and cross-referencing information) to
1930*5d5fbe79SDavid van Moolenbroek# the XML output. Note that enabling this will significantly increase the size
1931*5d5fbe79SDavid van Moolenbroek# of the XML output.
1932*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
1933*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_XML is set to YES.
1934*5d5fbe79SDavid van Moolenbroek
1935*5d5fbe79SDavid van MoolenbroekXML_PROGRAMLISTING     = YES
1936*5d5fbe79SDavid van Moolenbroek
1937*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
1938*5d5fbe79SDavid van Moolenbroek# Configuration options related to the DOCBOOK output
1939*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
1940*5d5fbe79SDavid van Moolenbroek
1941*5d5fbe79SDavid van Moolenbroek# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1942*5d5fbe79SDavid van Moolenbroek# that can be used to generate PDF.
1943*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1944*5d5fbe79SDavid van Moolenbroek
1945*5d5fbe79SDavid van MoolenbroekGENERATE_DOCBOOK       = NO
1946*5d5fbe79SDavid van Moolenbroek
1947*5d5fbe79SDavid van Moolenbroek# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1948*5d5fbe79SDavid van Moolenbroek# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1949*5d5fbe79SDavid van Moolenbroek# front of it.
1950*5d5fbe79SDavid van Moolenbroek# The default directory is: docbook.
1951*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1952*5d5fbe79SDavid van Moolenbroek
1953*5d5fbe79SDavid van MoolenbroekDOCBOOK_OUTPUT         = docbook
1954*5d5fbe79SDavid van Moolenbroek
1955*5d5fbe79SDavid van Moolenbroek# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1956*5d5fbe79SDavid van Moolenbroek# program listings (including syntax highlighting and cross-referencing
1957*5d5fbe79SDavid van Moolenbroek# information) to the DOCBOOK output. Note that enabling this will significantly
1958*5d5fbe79SDavid van Moolenbroek# increase the size of the DOCBOOK output.
1959*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1960*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1961*5d5fbe79SDavid van Moolenbroek
1962*5d5fbe79SDavid van MoolenbroekDOCBOOK_PROGRAMLISTING = NO
1963*5d5fbe79SDavid van Moolenbroek
1964*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
1965*5d5fbe79SDavid van Moolenbroek# Configuration options for the AutoGen Definitions output
1966*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
1967*5d5fbe79SDavid van Moolenbroek
1968*5d5fbe79SDavid van Moolenbroek# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1969*5d5fbe79SDavid van Moolenbroek# AutoGen Definitions (see http://autogen.sf.net) file that captures the
1970*5d5fbe79SDavid van Moolenbroek# structure of the code including all documentation. Note that this feature is
1971*5d5fbe79SDavid van Moolenbroek# still experimental and incomplete at the moment.
1972*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1973*5d5fbe79SDavid van Moolenbroek
1974*5d5fbe79SDavid van MoolenbroekGENERATE_AUTOGEN_DEF   = NO
1975*5d5fbe79SDavid van Moolenbroek
1976*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
1977*5d5fbe79SDavid van Moolenbroek# Configuration options related to the Perl module output
1978*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
1979*5d5fbe79SDavid van Moolenbroek
1980*5d5fbe79SDavid van Moolenbroek# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1981*5d5fbe79SDavid van Moolenbroek# file that captures the structure of the code including all documentation.
1982*5d5fbe79SDavid van Moolenbroek#
1983*5d5fbe79SDavid van Moolenbroek# Note that this feature is still experimental and incomplete at the moment.
1984*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1985*5d5fbe79SDavid van Moolenbroek
1986*5d5fbe79SDavid van MoolenbroekGENERATE_PERLMOD       = NO
1987*5d5fbe79SDavid van Moolenbroek
1988*5d5fbe79SDavid van Moolenbroek# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
1989*5d5fbe79SDavid van Moolenbroek# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1990*5d5fbe79SDavid van Moolenbroek# output from the Perl module output.
1991*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
1992*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1993*5d5fbe79SDavid van Moolenbroek
1994*5d5fbe79SDavid van MoolenbroekPERLMOD_LATEX          = NO
1995*5d5fbe79SDavid van Moolenbroek
1996*5d5fbe79SDavid van Moolenbroek# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
1997*5d5fbe79SDavid van Moolenbroek# formatted so it can be parsed by a human reader. This is useful if you want to
1998*5d5fbe79SDavid van Moolenbroek# understand what is going on. On the other hand, if this tag is set to NO, the
1999*5d5fbe79SDavid van Moolenbroek# size of the Perl module output will be much smaller and Perl will parse it
2000*5d5fbe79SDavid van Moolenbroek# just the same.
2001*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
2002*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2003*5d5fbe79SDavid van Moolenbroek
2004*5d5fbe79SDavid van MoolenbroekPERLMOD_PRETTY         = YES
2005*5d5fbe79SDavid van Moolenbroek
2006*5d5fbe79SDavid van Moolenbroek# The names of the make variables in the generated doxyrules.make file are
2007*5d5fbe79SDavid van Moolenbroek# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2008*5d5fbe79SDavid van Moolenbroek# so different doxyrules.make files included by the same Makefile don't
2009*5d5fbe79SDavid van Moolenbroek# overwrite each other's variables.
2010*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2011*5d5fbe79SDavid van Moolenbroek
2012*5d5fbe79SDavid van MoolenbroekPERLMOD_MAKEVAR_PREFIX =
2013*5d5fbe79SDavid van Moolenbroek
2014*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
2015*5d5fbe79SDavid van Moolenbroek# Configuration options related to the preprocessor
2016*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
2017*5d5fbe79SDavid van Moolenbroek
2018*5d5fbe79SDavid van Moolenbroek# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2019*5d5fbe79SDavid van Moolenbroek# C-preprocessor directives found in the sources and include files.
2020*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
2021*5d5fbe79SDavid van Moolenbroek
2022*5d5fbe79SDavid van MoolenbroekENABLE_PREPROCESSING   = YES
2023*5d5fbe79SDavid van Moolenbroek
2024*5d5fbe79SDavid van Moolenbroek# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2025*5d5fbe79SDavid van Moolenbroek# in the source code. If set to NO, only conditional compilation will be
2026*5d5fbe79SDavid van Moolenbroek# performed. Macro expansion can be done in a controlled way by setting
2027*5d5fbe79SDavid van Moolenbroek# EXPAND_ONLY_PREDEF to YES.
2028*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
2029*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2030*5d5fbe79SDavid van Moolenbroek
2031*5d5fbe79SDavid van MoolenbroekMACRO_EXPANSION        = YES
2032*5d5fbe79SDavid van Moolenbroek
2033*5d5fbe79SDavid van Moolenbroek# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2034*5d5fbe79SDavid van Moolenbroek# the macro expansion is limited to the macros specified with the PREDEFINED and
2035*5d5fbe79SDavid van Moolenbroek# EXPAND_AS_DEFINED tags.
2036*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
2037*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2038*5d5fbe79SDavid van Moolenbroek
2039*5d5fbe79SDavid van MoolenbroekEXPAND_ONLY_PREDEF     = NO
2040*5d5fbe79SDavid van Moolenbroek
2041*5d5fbe79SDavid van Moolenbroek# If the SEARCH_INCLUDES tag is set to YES, the include files in the
2042*5d5fbe79SDavid van Moolenbroek# INCLUDE_PATH will be searched if a #include is found.
2043*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
2044*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2045*5d5fbe79SDavid van Moolenbroek
2046*5d5fbe79SDavid van MoolenbroekSEARCH_INCLUDES        = YES
2047*5d5fbe79SDavid van Moolenbroek
2048*5d5fbe79SDavid van Moolenbroek# The INCLUDE_PATH tag can be used to specify one or more directories that
2049*5d5fbe79SDavid van Moolenbroek# contain include files that are not input files but should be processed by the
2050*5d5fbe79SDavid van Moolenbroek# preprocessor.
2051*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag SEARCH_INCLUDES is set to YES.
2052*5d5fbe79SDavid van Moolenbroek
2053*5d5fbe79SDavid van MoolenbroekINCLUDE_PATH           = ../../src/include
2054*5d5fbe79SDavid van Moolenbroek
2055*5d5fbe79SDavid van Moolenbroek# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2056*5d5fbe79SDavid van Moolenbroek# patterns (like *.h and *.hpp) to filter out the header-files in the
2057*5d5fbe79SDavid van Moolenbroek# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2058*5d5fbe79SDavid van Moolenbroek# used.
2059*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2060*5d5fbe79SDavid van Moolenbroek
2061*5d5fbe79SDavid van MoolenbroekINCLUDE_FILE_PATTERNS  = *.h
2062*5d5fbe79SDavid van Moolenbroek
2063*5d5fbe79SDavid van Moolenbroek# The PREDEFINED tag can be used to specify one or more macro names that are
2064*5d5fbe79SDavid van Moolenbroek# defined before the preprocessor is started (similar to the -D option of e.g.
2065*5d5fbe79SDavid van Moolenbroek# gcc). The argument of the tag is a list of macros of the form: name or
2066*5d5fbe79SDavid van Moolenbroek# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2067*5d5fbe79SDavid van Moolenbroek# is assumed. To prevent a macro definition from being undefined via #undef or
2068*5d5fbe79SDavid van Moolenbroek# recursively expanded use the := operator instead of the = operator.
2069*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2070*5d5fbe79SDavid van Moolenbroek
2071*5d5fbe79SDavid van MoolenbroekPREDEFINED             = __DOXYGEN__=1 \
2072*5d5fbe79SDavid van Moolenbroek                         NO_SYS=0 \
2073*5d5fbe79SDavid van Moolenbroek                         SYS_LIGHTWEIGHT_PROT=1 \
2074*5d5fbe79SDavid van Moolenbroek                         LWIP_TCPIP_CORE_LOCKING=1 \
2075*5d5fbe79SDavid van Moolenbroek                         LWIP_IPV4=1 \
2076*5d5fbe79SDavid van Moolenbroek                         LWIP_IPV6=1 \
2077*5d5fbe79SDavid van Moolenbroek                         LWIP_ICMP=1 \
2078*5d5fbe79SDavid van Moolenbroek                         LWIP_RAW=1 \
2079*5d5fbe79SDavid van Moolenbroek                         LWIP_DHCP=1 \
2080*5d5fbe79SDavid van Moolenbroek                         LWIP_UDPLITE=1 \
2081*5d5fbe79SDavid van Moolenbroek                         LWIP_UDP=1 \
2082*5d5fbe79SDavid van Moolenbroek                         LWIP_IGMP=1 \
2083*5d5fbe79SDavid van Moolenbroek                         LWIP_TCP=1 \
2084*5d5fbe79SDavid van Moolenbroek                         LWIP_IPV6_SCOPES=1 \
2085*5d5fbe79SDavid van Moolenbroek                         TCP_LISTEN_BACKLOG=1 \
2086*5d5fbe79SDavid van Moolenbroek                         LWIP_SNMP=1 \
2087*5d5fbe79SDavid van Moolenbroek                         SNMP_USE_NETCONN=1 \
2088*5d5fbe79SDavid van Moolenbroek                         SNMP_USE_RAW=1 \
2089*5d5fbe79SDavid van Moolenbroek                         MIB2_STATS=1 \
2090*5d5fbe79SDavid van Moolenbroek                         LWIP_MDNS_RESPONDER=1 \
2091*5d5fbe79SDavid van Moolenbroek                         MEMP_OVERFLOW_CHECK=0 \
2092*5d5fbe79SDavid van Moolenbroek                         MEMP_SANITY_CHECK=1 \
2093*5d5fbe79SDavid van Moolenbroek                         LWIP_ARP=1 \
2094*5d5fbe79SDavid van Moolenbroek                         LWIP_HAVE_LOOPIF=1 \
2095*5d5fbe79SDavid van Moolenbroek                         LWIP_NETIF_HOSTNAME=1 \
2096*5d5fbe79SDavid van Moolenbroek                         LWIP_NETIF_API=1 \
2097*5d5fbe79SDavid van Moolenbroek                         LWIP_NETIF_CALLBACK=1 \
2098*5d5fbe79SDavid van Moolenbroek                         LWIP_NETIF_STATUS_CALLBACK=1 \
2099*5d5fbe79SDavid van Moolenbroek                         LWIP_NETIF_REMOVE_CALLBACK=1 \
2100*5d5fbe79SDavid van Moolenbroek                         LWIP_NETIF_LINK_CALLBACK=1 \
2101*5d5fbe79SDavid van Moolenbroek                         LWIP_NETIF_EXT_STATUS_CALLBACK = 1 \
2102*5d5fbe79SDavid van Moolenbroek                         LWIP_NUM_NETIF_CLIENT_DATA=1 \
2103*5d5fbe79SDavid van Moolenbroek                         ENABLE_LOOPBACK=1 \
2104*5d5fbe79SDavid van Moolenbroek                         LWIP_AUTOIP=1 \
2105*5d5fbe79SDavid van Moolenbroek                         ARP_QUEUEING=1 \
2106*5d5fbe79SDavid van Moolenbroek                         LWIP_STATS=1 \
2107*5d5fbe79SDavid van Moolenbroek                         MEM_USE_POOLS=0 \
2108*5d5fbe79SDavid van Moolenbroek                         LWIP_DNS=1 \
2109*5d5fbe79SDavid van Moolenbroek                         LWIP_SOCKET=1 \
2110*5d5fbe79SDavid van Moolenbroek                         LWIP_NETCONN=1 \
2111*5d5fbe79SDavid van Moolenbroek                         IP_SOF_BROADCAST=1 \
2112*5d5fbe79SDavid van Moolenbroek                         IP_SOF_BROADCAST_RECV=1 \
2113*5d5fbe79SDavid van Moolenbroek                         LWIP_NETIF_API=1 \
2114*5d5fbe79SDavid van Moolenbroek                         LWIP_SO_SNDTIMEO=1 \
2115*5d5fbe79SDavid van Moolenbroek                         LWIP_SO_RCVBUF=1 \
2116*5d5fbe79SDavid van Moolenbroek                         LWIP_SO_LINGER=1 \
2117*5d5fbe79SDavid van Moolenbroek                         SO_REUSE=1 \
2118*5d5fbe79SDavid van Moolenbroek                         SO_REUSE_RXTOALL=1 \
2119*5d5fbe79SDavid van Moolenbroek                         LWIP_HAVE_SLIPIF=1 \
2120*5d5fbe79SDavid van Moolenbroek                         LWIP_6LOWPAN=1
2121*5d5fbe79SDavid van Moolenbroek
2122*5d5fbe79SDavid van Moolenbroek# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2123*5d5fbe79SDavid van Moolenbroek# tag can be used to specify a list of macro names that should be expanded. The
2124*5d5fbe79SDavid van Moolenbroek# macro definition that is found in the sources will be used. Use the PREDEFINED
2125*5d5fbe79SDavid van Moolenbroek# tag if you want to use a different macro definition that overrules the
2126*5d5fbe79SDavid van Moolenbroek# definition found in the source code.
2127*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2128*5d5fbe79SDavid van Moolenbroek
2129*5d5fbe79SDavid van MoolenbroekEXPAND_AS_DEFINED      =
2130*5d5fbe79SDavid van Moolenbroek
2131*5d5fbe79SDavid van Moolenbroek# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2132*5d5fbe79SDavid van Moolenbroek# remove all references to function-like macros that are alone on a line, have
2133*5d5fbe79SDavid van Moolenbroek# an all uppercase name, and do not end with a semicolon. Such function macros
2134*5d5fbe79SDavid van Moolenbroek# are typically used for boiler-plate code, and will confuse the parser if not
2135*5d5fbe79SDavid van Moolenbroek# removed.
2136*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
2137*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2138*5d5fbe79SDavid van Moolenbroek
2139*5d5fbe79SDavid van MoolenbroekSKIP_FUNCTION_MACROS   = NO
2140*5d5fbe79SDavid van Moolenbroek
2141*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
2142*5d5fbe79SDavid van Moolenbroek# Configuration options related to external references
2143*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
2144*5d5fbe79SDavid van Moolenbroek
2145*5d5fbe79SDavid van Moolenbroek# The TAGFILES tag can be used to specify one or more tag files. For each tag
2146*5d5fbe79SDavid van Moolenbroek# file the location of the external documentation should be added. The format of
2147*5d5fbe79SDavid van Moolenbroek# a tag file without this location is as follows:
2148*5d5fbe79SDavid van Moolenbroek# TAGFILES = file1 file2 ...
2149*5d5fbe79SDavid van Moolenbroek# Adding location for the tag files is done as follows:
2150*5d5fbe79SDavid van Moolenbroek# TAGFILES = file1=loc1 "file2 = loc2" ...
2151*5d5fbe79SDavid van Moolenbroek# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2152*5d5fbe79SDavid van Moolenbroek# section "Linking to external documentation" for more information about the use
2153*5d5fbe79SDavid van Moolenbroek# of tag files.
2154*5d5fbe79SDavid van Moolenbroek# Note: Each tag file must have a unique name (where the name does NOT include
2155*5d5fbe79SDavid van Moolenbroek# the path). If a tag file is not located in the directory in which doxygen is
2156*5d5fbe79SDavid van Moolenbroek# run, you must also specify the path to the tagfile here.
2157*5d5fbe79SDavid van Moolenbroek
2158*5d5fbe79SDavid van MoolenbroekTAGFILES               =
2159*5d5fbe79SDavid van Moolenbroek
2160*5d5fbe79SDavid van Moolenbroek# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2161*5d5fbe79SDavid van Moolenbroek# tag file that is based on the input files it reads. See section "Linking to
2162*5d5fbe79SDavid van Moolenbroek# external documentation" for more information about the usage of tag files.
2163*5d5fbe79SDavid van Moolenbroek
2164*5d5fbe79SDavid van MoolenbroekGENERATE_TAGFILE       =
2165*5d5fbe79SDavid van Moolenbroek
2166*5d5fbe79SDavid van Moolenbroek# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2167*5d5fbe79SDavid van Moolenbroek# the class index. If set to NO, only the inherited external classes will be
2168*5d5fbe79SDavid van Moolenbroek# listed.
2169*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
2170*5d5fbe79SDavid van Moolenbroek
2171*5d5fbe79SDavid van MoolenbroekALLEXTERNALS           = NO
2172*5d5fbe79SDavid van Moolenbroek
2173*5d5fbe79SDavid van Moolenbroek# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2174*5d5fbe79SDavid van Moolenbroek# in the modules index. If set to NO, only the current project's groups will be
2175*5d5fbe79SDavid van Moolenbroek# listed.
2176*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
2177*5d5fbe79SDavid van Moolenbroek
2178*5d5fbe79SDavid van MoolenbroekEXTERNAL_GROUPS        = YES
2179*5d5fbe79SDavid van Moolenbroek
2180*5d5fbe79SDavid van Moolenbroek# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2181*5d5fbe79SDavid van Moolenbroek# the related pages index. If set to NO, only the current project's pages will
2182*5d5fbe79SDavid van Moolenbroek# be listed.
2183*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
2184*5d5fbe79SDavid van Moolenbroek
2185*5d5fbe79SDavid van MoolenbroekEXTERNAL_PAGES         = YES
2186*5d5fbe79SDavid van Moolenbroek
2187*5d5fbe79SDavid van Moolenbroek# The PERL_PATH should be the absolute path and name of the perl script
2188*5d5fbe79SDavid van Moolenbroek# interpreter (i.e. the result of 'which perl').
2189*5d5fbe79SDavid van Moolenbroek# The default file (with absolute path) is: /usr/bin/perl.
2190*5d5fbe79SDavid van Moolenbroek
2191*5d5fbe79SDavid van MoolenbroekPERL_PATH              = /usr/bin/perl
2192*5d5fbe79SDavid van Moolenbroek
2193*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
2194*5d5fbe79SDavid van Moolenbroek# Configuration options related to the dot tool
2195*5d5fbe79SDavid van Moolenbroek#---------------------------------------------------------------------------
2196*5d5fbe79SDavid van Moolenbroek
2197*5d5fbe79SDavid van Moolenbroek# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2198*5d5fbe79SDavid van Moolenbroek# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2199*5d5fbe79SDavid van Moolenbroek# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2200*5d5fbe79SDavid van Moolenbroek# disabled, but it is recommended to install and use dot, since it yields more
2201*5d5fbe79SDavid van Moolenbroek# powerful graphs.
2202*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
2203*5d5fbe79SDavid van Moolenbroek
2204*5d5fbe79SDavid van MoolenbroekCLASS_DIAGRAMS         = YES
2205*5d5fbe79SDavid van Moolenbroek
2206*5d5fbe79SDavid van Moolenbroek# You can define message sequence charts within doxygen comments using the \msc
2207*5d5fbe79SDavid van Moolenbroek# command. Doxygen will then run the mscgen tool (see:
2208*5d5fbe79SDavid van Moolenbroek# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2209*5d5fbe79SDavid van Moolenbroek# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2210*5d5fbe79SDavid van Moolenbroek# the mscgen tool resides. If left empty the tool is assumed to be found in the
2211*5d5fbe79SDavid van Moolenbroek# default search path.
2212*5d5fbe79SDavid van Moolenbroek
2213*5d5fbe79SDavid van MoolenbroekMSCGEN_PATH            =
2214*5d5fbe79SDavid van Moolenbroek
2215*5d5fbe79SDavid van Moolenbroek# You can include diagrams made with dia in doxygen documentation. Doxygen will
2216*5d5fbe79SDavid van Moolenbroek# then run dia to produce the diagram and insert it in the documentation. The
2217*5d5fbe79SDavid van Moolenbroek# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2218*5d5fbe79SDavid van Moolenbroek# If left empty dia is assumed to be found in the default search path.
2219*5d5fbe79SDavid van Moolenbroek
2220*5d5fbe79SDavid van MoolenbroekDIA_PATH               =
2221*5d5fbe79SDavid van Moolenbroek
2222*5d5fbe79SDavid van Moolenbroek# If set to YES the inheritance and collaboration graphs will hide inheritance
2223*5d5fbe79SDavid van Moolenbroek# and usage relations if the target is undocumented or is not a class.
2224*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
2225*5d5fbe79SDavid van Moolenbroek
2226*5d5fbe79SDavid van MoolenbroekHIDE_UNDOC_RELATIONS   = YES
2227*5d5fbe79SDavid van Moolenbroek
2228*5d5fbe79SDavid van Moolenbroek# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2229*5d5fbe79SDavid van Moolenbroek# available from the path. This tool is part of Graphviz (see:
2230*5d5fbe79SDavid van Moolenbroek# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2231*5d5fbe79SDavid van Moolenbroek# Bell Labs. The other options in this section have no effect if this option is
2232*5d5fbe79SDavid van Moolenbroek# set to NO
2233*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
2234*5d5fbe79SDavid van Moolenbroek
2235*5d5fbe79SDavid van MoolenbroekHAVE_DOT               = NO
2236*5d5fbe79SDavid van Moolenbroek
2237*5d5fbe79SDavid van Moolenbroek# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2238*5d5fbe79SDavid van Moolenbroek# to run in parallel. When set to 0 doxygen will base this on the number of
2239*5d5fbe79SDavid van Moolenbroek# processors available in the system. You can set it explicitly to a value
2240*5d5fbe79SDavid van Moolenbroek# larger than 0 to get control over the balance between CPU load and processing
2241*5d5fbe79SDavid van Moolenbroek# speed.
2242*5d5fbe79SDavid van Moolenbroek# Minimum value: 0, maximum value: 32, default value: 0.
2243*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag HAVE_DOT is set to YES.
2244*5d5fbe79SDavid van Moolenbroek
2245*5d5fbe79SDavid van MoolenbroekDOT_NUM_THREADS        = 0
2246*5d5fbe79SDavid van Moolenbroek
2247*5d5fbe79SDavid van Moolenbroek# When you want a differently looking font in the dot files that doxygen
2248*5d5fbe79SDavid van Moolenbroek# generates you can specify the font name using DOT_FONTNAME. You need to make
2249*5d5fbe79SDavid van Moolenbroek# sure dot is able to find the font, which can be done by putting it in a
2250*5d5fbe79SDavid van Moolenbroek# standard location or by setting the DOTFONTPATH environment variable or by
2251*5d5fbe79SDavid van Moolenbroek# setting DOT_FONTPATH to the directory containing the font.
2252*5d5fbe79SDavid van Moolenbroek# The default value is: Helvetica.
2253*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag HAVE_DOT is set to YES.
2254*5d5fbe79SDavid van Moolenbroek
2255*5d5fbe79SDavid van MoolenbroekDOT_FONTNAME           = Helvetica
2256*5d5fbe79SDavid van Moolenbroek
2257*5d5fbe79SDavid van Moolenbroek# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2258*5d5fbe79SDavid van Moolenbroek# dot graphs.
2259*5d5fbe79SDavid van Moolenbroek# Minimum value: 4, maximum value: 24, default value: 10.
2260*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag HAVE_DOT is set to YES.
2261*5d5fbe79SDavid van Moolenbroek
2262*5d5fbe79SDavid van MoolenbroekDOT_FONTSIZE           = 10
2263*5d5fbe79SDavid van Moolenbroek
2264*5d5fbe79SDavid van Moolenbroek# By default doxygen will tell dot to use the default font as specified with
2265*5d5fbe79SDavid van Moolenbroek# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2266*5d5fbe79SDavid van Moolenbroek# the path where dot can find it using this tag.
2267*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag HAVE_DOT is set to YES.
2268*5d5fbe79SDavid van Moolenbroek
2269*5d5fbe79SDavid van MoolenbroekDOT_FONTPATH           =
2270*5d5fbe79SDavid van Moolenbroek
2271*5d5fbe79SDavid van Moolenbroek# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2272*5d5fbe79SDavid van Moolenbroek# each documented class showing the direct and indirect inheritance relations.
2273*5d5fbe79SDavid van Moolenbroek# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2274*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
2275*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag HAVE_DOT is set to YES.
2276*5d5fbe79SDavid van Moolenbroek
2277*5d5fbe79SDavid van MoolenbroekCLASS_GRAPH            = YES
2278*5d5fbe79SDavid van Moolenbroek
2279*5d5fbe79SDavid van Moolenbroek# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2280*5d5fbe79SDavid van Moolenbroek# graph for each documented class showing the direct and indirect implementation
2281*5d5fbe79SDavid van Moolenbroek# dependencies (inheritance, containment, and class references variables) of the
2282*5d5fbe79SDavid van Moolenbroek# class with other documented classes.
2283*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
2284*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag HAVE_DOT is set to YES.
2285*5d5fbe79SDavid van Moolenbroek
2286*5d5fbe79SDavid van MoolenbroekCOLLABORATION_GRAPH    = YES
2287*5d5fbe79SDavid van Moolenbroek
2288*5d5fbe79SDavid van Moolenbroek# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2289*5d5fbe79SDavid van Moolenbroek# groups, showing the direct groups dependencies.
2290*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
2291*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag HAVE_DOT is set to YES.
2292*5d5fbe79SDavid van Moolenbroek
2293*5d5fbe79SDavid van MoolenbroekGROUP_GRAPHS           = YES
2294*5d5fbe79SDavid van Moolenbroek
2295*5d5fbe79SDavid van Moolenbroek# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2296*5d5fbe79SDavid van Moolenbroek# collaboration diagrams in a style similar to the OMG's Unified Modeling
2297*5d5fbe79SDavid van Moolenbroek# Language.
2298*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
2299*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag HAVE_DOT is set to YES.
2300*5d5fbe79SDavid van Moolenbroek
2301*5d5fbe79SDavid van MoolenbroekUML_LOOK               = NO
2302*5d5fbe79SDavid van Moolenbroek
2303*5d5fbe79SDavid van Moolenbroek# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2304*5d5fbe79SDavid van Moolenbroek# class node. If there are many fields or methods and many nodes the graph may
2305*5d5fbe79SDavid van Moolenbroek# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2306*5d5fbe79SDavid van Moolenbroek# number of items for each type to make the size more manageable. Set this to 0
2307*5d5fbe79SDavid van Moolenbroek# for no limit. Note that the threshold may be exceeded by 50% before the limit
2308*5d5fbe79SDavid van Moolenbroek# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2309*5d5fbe79SDavid van Moolenbroek# but if the number exceeds 15, the total amount of fields shown is limited to
2310*5d5fbe79SDavid van Moolenbroek# 10.
2311*5d5fbe79SDavid van Moolenbroek# Minimum value: 0, maximum value: 100, default value: 10.
2312*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag HAVE_DOT is set to YES.
2313*5d5fbe79SDavid van Moolenbroek
2314*5d5fbe79SDavid van MoolenbroekUML_LIMIT_NUM_FIELDS   = 10
2315*5d5fbe79SDavid van Moolenbroek
2316*5d5fbe79SDavid van Moolenbroek# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2317*5d5fbe79SDavid van Moolenbroek# collaboration graphs will show the relations between templates and their
2318*5d5fbe79SDavid van Moolenbroek# instances.
2319*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
2320*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag HAVE_DOT is set to YES.
2321*5d5fbe79SDavid van Moolenbroek
2322*5d5fbe79SDavid van MoolenbroekTEMPLATE_RELATIONS     = NO
2323*5d5fbe79SDavid van Moolenbroek
2324*5d5fbe79SDavid van Moolenbroek# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2325*5d5fbe79SDavid van Moolenbroek# YES then doxygen will generate a graph for each documented file showing the
2326*5d5fbe79SDavid van Moolenbroek# direct and indirect include dependencies of the file with other documented
2327*5d5fbe79SDavid van Moolenbroek# files.
2328*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
2329*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag HAVE_DOT is set to YES.
2330*5d5fbe79SDavid van Moolenbroek
2331*5d5fbe79SDavid van MoolenbroekINCLUDE_GRAPH          = YES
2332*5d5fbe79SDavid van Moolenbroek
2333*5d5fbe79SDavid van Moolenbroek# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2334*5d5fbe79SDavid van Moolenbroek# set to YES then doxygen will generate a graph for each documented file showing
2335*5d5fbe79SDavid van Moolenbroek# the direct and indirect include dependencies of the file with other documented
2336*5d5fbe79SDavid van Moolenbroek# files.
2337*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
2338*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag HAVE_DOT is set to YES.
2339*5d5fbe79SDavid van Moolenbroek
2340*5d5fbe79SDavid van MoolenbroekINCLUDED_BY_GRAPH      = YES
2341*5d5fbe79SDavid van Moolenbroek
2342*5d5fbe79SDavid van Moolenbroek# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2343*5d5fbe79SDavid van Moolenbroek# dependency graph for every global function or class method.
2344*5d5fbe79SDavid van Moolenbroek#
2345*5d5fbe79SDavid van Moolenbroek# Note that enabling this option will significantly increase the time of a run.
2346*5d5fbe79SDavid van Moolenbroek# So in most cases it will be better to enable call graphs for selected
2347*5d5fbe79SDavid van Moolenbroek# functions only using the \callgraph command. Disabling a call graph can be
2348*5d5fbe79SDavid van Moolenbroek# accomplished by means of the command \hidecallgraph.
2349*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
2350*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag HAVE_DOT is set to YES.
2351*5d5fbe79SDavid van Moolenbroek
2352*5d5fbe79SDavid van MoolenbroekCALL_GRAPH             = NO
2353*5d5fbe79SDavid van Moolenbroek
2354*5d5fbe79SDavid van Moolenbroek# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2355*5d5fbe79SDavid van Moolenbroek# dependency graph for every global function or class method.
2356*5d5fbe79SDavid van Moolenbroek#
2357*5d5fbe79SDavid van Moolenbroek# Note that enabling this option will significantly increase the time of a run.
2358*5d5fbe79SDavid van Moolenbroek# So in most cases it will be better to enable caller graphs for selected
2359*5d5fbe79SDavid van Moolenbroek# functions only using the \callergraph command. Disabling a caller graph can be
2360*5d5fbe79SDavid van Moolenbroek# accomplished by means of the command \hidecallergraph.
2361*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
2362*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag HAVE_DOT is set to YES.
2363*5d5fbe79SDavid van Moolenbroek
2364*5d5fbe79SDavid van MoolenbroekCALLER_GRAPH           = NO
2365*5d5fbe79SDavid van Moolenbroek
2366*5d5fbe79SDavid van Moolenbroek# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2367*5d5fbe79SDavid van Moolenbroek# hierarchy of all classes instead of a textual one.
2368*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
2369*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag HAVE_DOT is set to YES.
2370*5d5fbe79SDavid van Moolenbroek
2371*5d5fbe79SDavid van MoolenbroekGRAPHICAL_HIERARCHY    = YES
2372*5d5fbe79SDavid van Moolenbroek
2373*5d5fbe79SDavid van Moolenbroek# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2374*5d5fbe79SDavid van Moolenbroek# dependencies a directory has on other directories in a graphical way. The
2375*5d5fbe79SDavid van Moolenbroek# dependency relations are determined by the #include relations between the
2376*5d5fbe79SDavid van Moolenbroek# files in the directories.
2377*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
2378*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag HAVE_DOT is set to YES.
2379*5d5fbe79SDavid van Moolenbroek
2380*5d5fbe79SDavid van MoolenbroekDIRECTORY_GRAPH        = YES
2381*5d5fbe79SDavid van Moolenbroek
2382*5d5fbe79SDavid van Moolenbroek# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2383*5d5fbe79SDavid van Moolenbroek# generated by dot. For an explanation of the image formats see the section
2384*5d5fbe79SDavid van Moolenbroek# output formats in the documentation of the dot tool (Graphviz (see:
2385*5d5fbe79SDavid van Moolenbroek# http://www.graphviz.org/)).
2386*5d5fbe79SDavid van Moolenbroek# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2387*5d5fbe79SDavid van Moolenbroek# to make the SVG files visible in IE 9+ (other browsers do not have this
2388*5d5fbe79SDavid van Moolenbroek# requirement).
2389*5d5fbe79SDavid van Moolenbroek# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2390*5d5fbe79SDavid van Moolenbroek# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2391*5d5fbe79SDavid van Moolenbroek# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
2392*5d5fbe79SDavid van Moolenbroek# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2393*5d5fbe79SDavid van Moolenbroek# png:gdiplus:gdiplus.
2394*5d5fbe79SDavid van Moolenbroek# The default value is: png.
2395*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag HAVE_DOT is set to YES.
2396*5d5fbe79SDavid van Moolenbroek
2397*5d5fbe79SDavid van MoolenbroekDOT_IMAGE_FORMAT       = png
2398*5d5fbe79SDavid van Moolenbroek
2399*5d5fbe79SDavid van Moolenbroek# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2400*5d5fbe79SDavid van Moolenbroek# enable generation of interactive SVG images that allow zooming and panning.
2401*5d5fbe79SDavid van Moolenbroek#
2402*5d5fbe79SDavid van Moolenbroek# Note that this requires a modern browser other than Internet Explorer. Tested
2403*5d5fbe79SDavid van Moolenbroek# and working are Firefox, Chrome, Safari, and Opera.
2404*5d5fbe79SDavid van Moolenbroek# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2405*5d5fbe79SDavid van Moolenbroek# the SVG files visible. Older versions of IE do not have SVG support.
2406*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
2407*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag HAVE_DOT is set to YES.
2408*5d5fbe79SDavid van Moolenbroek
2409*5d5fbe79SDavid van MoolenbroekINTERACTIVE_SVG        = NO
2410*5d5fbe79SDavid van Moolenbroek
2411*5d5fbe79SDavid van Moolenbroek# The DOT_PATH tag can be used to specify the path where the dot tool can be
2412*5d5fbe79SDavid van Moolenbroek# found. If left blank, it is assumed the dot tool can be found in the path.
2413*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag HAVE_DOT is set to YES.
2414*5d5fbe79SDavid van Moolenbroek
2415*5d5fbe79SDavid van MoolenbroekDOT_PATH               =
2416*5d5fbe79SDavid van Moolenbroek
2417*5d5fbe79SDavid van Moolenbroek# The DOTFILE_DIRS tag can be used to specify one or more directories that
2418*5d5fbe79SDavid van Moolenbroek# contain dot files that are included in the documentation (see the \dotfile
2419*5d5fbe79SDavid van Moolenbroek# command).
2420*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag HAVE_DOT is set to YES.
2421*5d5fbe79SDavid van Moolenbroek
2422*5d5fbe79SDavid van MoolenbroekDOTFILE_DIRS           =
2423*5d5fbe79SDavid van Moolenbroek
2424*5d5fbe79SDavid van Moolenbroek# The MSCFILE_DIRS tag can be used to specify one or more directories that
2425*5d5fbe79SDavid van Moolenbroek# contain msc files that are included in the documentation (see the \mscfile
2426*5d5fbe79SDavid van Moolenbroek# command).
2427*5d5fbe79SDavid van Moolenbroek
2428*5d5fbe79SDavid van MoolenbroekMSCFILE_DIRS           =
2429*5d5fbe79SDavid van Moolenbroek
2430*5d5fbe79SDavid van Moolenbroek# The DIAFILE_DIRS tag can be used to specify one or more directories that
2431*5d5fbe79SDavid van Moolenbroek# contain dia files that are included in the documentation (see the \diafile
2432*5d5fbe79SDavid van Moolenbroek# command).
2433*5d5fbe79SDavid van Moolenbroek
2434*5d5fbe79SDavid van MoolenbroekDIAFILE_DIRS           =
2435*5d5fbe79SDavid van Moolenbroek
2436*5d5fbe79SDavid van Moolenbroek# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2437*5d5fbe79SDavid van Moolenbroek# path where java can find the plantuml.jar file. If left blank, it is assumed
2438*5d5fbe79SDavid van Moolenbroek# PlantUML is not used or called during a preprocessing step. Doxygen will
2439*5d5fbe79SDavid van Moolenbroek# generate a warning when it encounters a \startuml command in this case and
2440*5d5fbe79SDavid van Moolenbroek# will not generate output for the diagram.
2441*5d5fbe79SDavid van Moolenbroek
2442*5d5fbe79SDavid van MoolenbroekPLANTUML_JAR_PATH      =
2443*5d5fbe79SDavid van Moolenbroek
2444*5d5fbe79SDavid van Moolenbroek# When using plantuml, the specified paths are searched for files specified by
2445*5d5fbe79SDavid van Moolenbroek# the !include statement in a plantuml block.
2446*5d5fbe79SDavid van Moolenbroek
2447*5d5fbe79SDavid van MoolenbroekPLANTUML_INCLUDE_PATH  =
2448*5d5fbe79SDavid van Moolenbroek
2449*5d5fbe79SDavid van Moolenbroek# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2450*5d5fbe79SDavid van Moolenbroek# that will be shown in the graph. If the number of nodes in a graph becomes
2451*5d5fbe79SDavid van Moolenbroek# larger than this value, doxygen will truncate the graph, which is visualized
2452*5d5fbe79SDavid van Moolenbroek# by representing a node as a red box. Note that doxygen if the number of direct
2453*5d5fbe79SDavid van Moolenbroek# children of the root node in a graph is already larger than
2454*5d5fbe79SDavid van Moolenbroek# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2455*5d5fbe79SDavid van Moolenbroek# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2456*5d5fbe79SDavid van Moolenbroek# Minimum value: 0, maximum value: 10000, default value: 50.
2457*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag HAVE_DOT is set to YES.
2458*5d5fbe79SDavid van Moolenbroek
2459*5d5fbe79SDavid van MoolenbroekDOT_GRAPH_MAX_NODES    = 50
2460*5d5fbe79SDavid van Moolenbroek
2461*5d5fbe79SDavid van Moolenbroek# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2462*5d5fbe79SDavid van Moolenbroek# generated by dot. A depth value of 3 means that only nodes reachable from the
2463*5d5fbe79SDavid van Moolenbroek# root by following a path via at most 3 edges will be shown. Nodes that lay
2464*5d5fbe79SDavid van Moolenbroek# further from the root node will be omitted. Note that setting this option to 1
2465*5d5fbe79SDavid van Moolenbroek# or 2 may greatly reduce the computation time needed for large code bases. Also
2466*5d5fbe79SDavid van Moolenbroek# note that the size of a graph can be further restricted by
2467*5d5fbe79SDavid van Moolenbroek# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2468*5d5fbe79SDavid van Moolenbroek# Minimum value: 0, maximum value: 1000, default value: 0.
2469*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag HAVE_DOT is set to YES.
2470*5d5fbe79SDavid van Moolenbroek
2471*5d5fbe79SDavid van MoolenbroekMAX_DOT_GRAPH_DEPTH    = 1000
2472*5d5fbe79SDavid van Moolenbroek
2473*5d5fbe79SDavid van Moolenbroek# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2474*5d5fbe79SDavid van Moolenbroek# background. This is disabled by default, because dot on Windows does not seem
2475*5d5fbe79SDavid van Moolenbroek# to support this out of the box.
2476*5d5fbe79SDavid van Moolenbroek#
2477*5d5fbe79SDavid van Moolenbroek# Warning: Depending on the platform used, enabling this option may lead to
2478*5d5fbe79SDavid van Moolenbroek# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2479*5d5fbe79SDavid van Moolenbroek# read).
2480*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
2481*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag HAVE_DOT is set to YES.
2482*5d5fbe79SDavid van Moolenbroek
2483*5d5fbe79SDavid van MoolenbroekDOT_TRANSPARENT        = NO
2484*5d5fbe79SDavid van Moolenbroek
2485*5d5fbe79SDavid van Moolenbroek# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2486*5d5fbe79SDavid van Moolenbroek# files in one run (i.e. multiple -o and -T options on the command line). This
2487*5d5fbe79SDavid van Moolenbroek# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2488*5d5fbe79SDavid van Moolenbroek# this, this feature is disabled by default.
2489*5d5fbe79SDavid van Moolenbroek# The default value is: NO.
2490*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag HAVE_DOT is set to YES.
2491*5d5fbe79SDavid van Moolenbroek
2492*5d5fbe79SDavid van MoolenbroekDOT_MULTI_TARGETS      = NO
2493*5d5fbe79SDavid van Moolenbroek
2494*5d5fbe79SDavid van Moolenbroek# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2495*5d5fbe79SDavid van Moolenbroek# explaining the meaning of the various boxes and arrows in the dot generated
2496*5d5fbe79SDavid van Moolenbroek# graphs.
2497*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
2498*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag HAVE_DOT is set to YES.
2499*5d5fbe79SDavid van Moolenbroek
2500*5d5fbe79SDavid van MoolenbroekGENERATE_LEGEND        = YES
2501*5d5fbe79SDavid van Moolenbroek
2502*5d5fbe79SDavid van Moolenbroek# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2503*5d5fbe79SDavid van Moolenbroek# files that are used to generate the various graphs.
2504*5d5fbe79SDavid van Moolenbroek# The default value is: YES.
2505*5d5fbe79SDavid van Moolenbroek# This tag requires that the tag HAVE_DOT is set to YES.
2506*5d5fbe79SDavid van Moolenbroek
2507*5d5fbe79SDavid van MoolenbroekDOT_CLEANUP            = YES
2508