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