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