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