blob: 7265a2267fc76e2f28e3c335c95c8e2f48f9672c [file] [log] [blame]
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001# Doxyfile 1.8.5
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002
3# This file describes the settings to be used by the documentation system
Christopher Dunn0973f2e2014-07-05 14:15:24 -07004# doxygen (www.doxygen.org) for a project.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00005#
Christopher Dunn0973f2e2014-07-05 14:15:24 -07006# All text after a double hash (##) is considered a comment and is placed in
7# front of the TAG it is preceding.
8#
9# All text after a single hash (#) is considered a comment and will be ignored.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +000010# The format is:
Christopher Dunn0973f2e2014-07-05 14:15:24 -070011# TAG = value [value, ...]
12# For lists, items can also be appended using:
13# TAG += value [value, ...]
14# Values that contain spaces should be placed between quotes (\" \").
Christopher Dunne0d72242007-06-14 17:58:59 +000015
16#---------------------------------------------------------------------------
17# Project related configuration options
18#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +000019
Christopher Dunn0973f2e2014-07-05 14:15:24 -070020# This tag specifies the encoding used for all characters in the config file
21# that follow. The default is UTF-8 which is also the encoding used for all text
22# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
24# for the list of possible encodings.
25# The default value is: UTF-8.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +000026
27DOXYFILE_ENCODING = UTF-8
28
Christopher Dunn0973f2e2014-07-05 14:15:24 -070029# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30# double-quotes, unless you are using Doxywizard) that should identify the
31# project for which the documentation is generated. This name is used in the
32# title of most generated pages and in a few other places.
33# The default value is: My Project.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +000034
Baptiste Lepilleur35503e52010-02-22 04:37:31 +000035PROJECT_NAME = "JsonCpp"
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +000036
Christopher Dunn0973f2e2014-07-05 14:15:24 -070037# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38# could be handy for archiving the generated documentation or if some version
39# control system is used.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +000040
Baptiste Lepilleur35503e52010-02-22 04:37:31 +000041PROJECT_NUMBER = %JSONCPP_VERSION%
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +000042
Christopher Dunn0973f2e2014-07-05 14:15:24 -070043# Using the PROJECT_BRIEF tag one can provide an optional one line description
44# for a project that appears at the top of each page and should give viewer a
45# quick idea about the purpose of the project. Keep the description short.
46
47PROJECT_BRIEF =
48
49# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
50# the documentation. The maximum height of the logo should not exceed 55 pixels
51# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
52# to the output directory.
53
54PROJECT_LOGO =
55
56# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57# into which the generated documentation will be written. If a relative path is
58# entered, it will be relative to the location where doxygen was started. If
59# left blank the current directory will be used.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +000060
Christopher Dunne0d72242007-06-14 17:58:59 +000061OUTPUT_DIRECTORY = %DOC_TOPDIR%
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +000062
Christopher Dunn0973f2e2014-07-05 14:15:24 -070063# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
64# directories (in 2 levels) under the output directory of each output format and
65# will distribute the generated files over these directories. Enabling this
66# option can be useful when feeding doxygen a huge amount of source files, where
67# putting all generated files in the same directory would otherwise causes
68# performance problems for the file system.
69# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +000070
Christopher Dunne0d72242007-06-14 17:58:59 +000071CREATE_SUBDIRS = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +000072
Christopher Dunn0973f2e2014-07-05 14:15:24 -070073# The OUTPUT_LANGUAGE tag is used to specify the language in which all
74# documentation generated by doxygen is written. Doxygen will use this
75# information to generate all constant output in the proper language.
76# Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-
77# Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi,
78# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en,
79# Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish,
80# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
81# Turkish, Ukrainian and Vietnamese.
82# The default value is: English.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +000083
Christopher Dunne0d72242007-06-14 17:58:59 +000084OUTPUT_LANGUAGE = English
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +000085
Christopher Dunn0973f2e2014-07-05 14:15:24 -070086# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
87# descriptions after the members that are listed in the file and class
88# documentation (similar to Javadoc). Set to NO to disable this.
89# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +000090
Christopher Dunne0d72242007-06-14 17:58:59 +000091BRIEF_MEMBER_DESC = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +000092
Christopher Dunn0973f2e2014-07-05 14:15:24 -070093# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
94# description of a member or function before the detailed description
95#
96# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +000097# brief descriptions will be completely suppressed.
Christopher Dunn0973f2e2014-07-05 14:15:24 -070098# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +000099
Christopher Dunne0d72242007-06-14 17:58:59 +0000100REPEAT_BRIEF = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000101
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700102# This tag implements a quasi-intelligent brief description abbreviator that is
103# used to form the text in various listings. Each string in this list, if found
104# as the leading text of the brief description, will be stripped from the text
105# and the result, after processing the whole list, is used as the annotated
106# text. Otherwise, the brief description is used as-is. If left blank, the
107# following values are used ($name is automatically replaced with the name of
108# the entity):The $name class, The $name widget, The $name file, is, provides,
109# specifies, contains, represents, a, an and the.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000110
Christopher Dunne0d72242007-06-14 17:58:59 +0000111ABBREVIATE_BRIEF = "The $name class" \
112 "The $name widget" \
113 "The $name file" \
114 is \
115 provides \
116 specifies \
117 contains \
118 represents \
119 a \
120 an \
121 the
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000122
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700123# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
124# doxygen will generate a detailed section even if there is only a brief
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000125# description.
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700126# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000127
Christopher Dunne0d72242007-06-14 17:58:59 +0000128ALWAYS_DETAILED_SEC = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000129
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700130# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
131# inherited members of a class in the documentation of that class as if those
132# members were ordinary class members. Constructors, destructors and assignment
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000133# operators of the base classes will not be shown.
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700134# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000135
Christopher Dunne0d72242007-06-14 17:58:59 +0000136INLINE_INHERITED_MEMB = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000137
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700138# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
139# before files name in the file list and in the header files. If set to NO the
140# shortest path that makes the file name unique will be used
141# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000142
Christopher Dunne0d72242007-06-14 17:58:59 +0000143FULL_PATH_NAMES = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000144
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700145# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
146# Stripping is only done if one of the specified strings matches the left-hand
147# part of the path. The tag can be used to show relative paths in the file list.
148# If left blank the directory from which doxygen is run is used as the path to
149# strip.
150#
151# Note that you can specify absolute paths here, but also relative paths, which
152# will be relative from the directory where doxygen is started.
153# This tag requires that the tag FULL_PATH_NAMES is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000154
Christopher Dunne0d72242007-06-14 17:58:59 +0000155STRIP_FROM_PATH = %TOPDIR%
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000156
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700157# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
158# path mentioned in the documentation of a class, which tells the reader which
159# header file to include in order to use a class. If left blank only the name of
160# the header file containing the class definition is used. Otherwise one should
161# specify the list of include paths that are normally passed to the compiler
162# using the -I flag.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000163
Christopher Dunne0d72242007-06-14 17:58:59 +0000164STRIP_FROM_INC_PATH = %TOPDIR%/include
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000165
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700166# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
167# less readable) file names. This can be useful is your file systems doesn't
168# support long names like on DOS, Mac, or CD-ROM.
169# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000170
Christopher Dunne0d72242007-06-14 17:58:59 +0000171SHORT_NAMES = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000172
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700173# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
174# first line (until the first dot) of a Javadoc-style comment as the brief
175# description. If set to NO, the Javadoc-style will behave just like regular Qt-
176# style comments (thus requiring an explicit @brief command for a brief
177# description.)
178# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000179
180JAVADOC_AUTOBRIEF = YES
181
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700182# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
183# line (until the first dot) of a Qt-style comment as the brief description. If
184# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
185# requiring an explicit \brief command for a brief description.)
186# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000187
188QT_AUTOBRIEF = NO
189
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700190# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
191# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
192# a brief description. This used to be the default behavior. The new default is
193# to treat a multi-line C++ comment block as a detailed description. Set this
194# tag to YES if you prefer the old behavior instead.
195#
196# Note that setting this tag to YES also means that rational rose comments are
197# not recognized any more.
198# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000199
Christopher Dunne0d72242007-06-14 17:58:59 +0000200MULTILINE_CPP_IS_BRIEF = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000201
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700202# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
203# documentation from any documented member that it re-implements.
204# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000205
Christopher Dunne0d72242007-06-14 17:58:59 +0000206INHERIT_DOCS = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000207
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700208# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
209# new page for each member. If set to NO, the documentation of a member will be
210# part of the file/class/namespace that contains it.
211# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000212
Christopher Dunne0d72242007-06-14 17:58:59 +0000213SEPARATE_MEMBER_PAGES = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000214
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700215# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
216# uses this value to replace tabs by spaces in code fragments.
217# Minimum value: 1, maximum value: 16, default value: 4.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000218
Christopher Dunne0d72242007-06-14 17:58:59 +0000219TAB_SIZE = 3
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000220
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700221# This tag can be used to specify a number of aliases that act as commands in
222# the documentation. An alias has the form:
223# name=value
224# For example adding
225# "sideeffect=@par Side Effects:\n"
226# will allow you to put the command \sideeffect (or @sideeffect) in the
227# documentation, which will result in a user-defined paragraph with heading
228# "Side Effects:". You can put \n's in the value part of an alias to insert
229# newlines.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000230
231ALIASES = "testCaseSetup=\link CppUT::TestCase::setUp() setUp()\endlink" \
232 "testCaseRun=\link CppUT::TestCase::run() run()\endlink" \
233 "testCaseTearDown=\link CppUT::TestCase::tearDown() tearDown()\endlink" \
234 "json_ref=<a HREF='http://www.json.org/'>JSON (JavaScript Object Notation)</a>"
235
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700236# This tag can be used to specify a number of word-keyword mappings (TCL only).
237# A mapping has the form "name=value". For example adding "class=itcl::class"
238# will allow you to use the command class in the itcl::class meaning.
239
240TCL_SUBST =
241
242# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
243# only. Doxygen will then generate output that is more tailored for C. For
244# instance, some of the names that are used will be different. The list of all
245# members will be omitted, etc.
246# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000247
Christopher Dunne0d72242007-06-14 17:58:59 +0000248OPTIMIZE_OUTPUT_FOR_C = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000249
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700250# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
251# Python sources only. Doxygen will then generate output that is more tailored
252# for that language. For instance, namespaces will be presented as packages,
253# qualified scopes will look different, etc.
254# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000255
Christopher Dunne0d72242007-06-14 17:58:59 +0000256OPTIMIZE_OUTPUT_JAVA = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000257
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700258# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
259# sources. Doxygen will then generate output that is tailored for Fortran.
260# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000261
262OPTIMIZE_FOR_FORTRAN = NO
263
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700264# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
265# sources. Doxygen will then generate output that is tailored for VHDL.
266# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000267
268OPTIMIZE_OUTPUT_VHDL = NO
269
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700270# Doxygen selects the parser to use depending on the extension of the files it
271# parses. With this tag you can assign which parser to use for a given
272# extension. Doxygen has a built-in mapping, but you can override or extend it
273# using this tag. The format is ext=language, where ext is a file extension, and
274# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
275# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
276# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
277# (default is Fortran), use: inc=Fortran f=C.
278#
279# Note For files without extension you can use no_extension as a placeholder.
280#
281# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
282# the files are not read by doxygen.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000283
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700284EXTENSION_MAPPING =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000285
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700286# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
287# according to the Markdown format, which allows for more readable
288# documentation. See http://daringfireball.net/projects/markdown/ for details.
289# The output of markdown processing is further processed by doxygen, so you can
290# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
291# case of backward compatibilities issues.
292# The default value is: YES.
293
294MARKDOWN_SUPPORT = YES
295
296# When enabled doxygen tries to link words that correspond to documented
297# classes, or namespaces to their corresponding documentation. Such a link can
298# be prevented in individual cases by by putting a % sign in front of the word
299# or globally by setting AUTOLINK_SUPPORT to NO.
300# The default value is: YES.
301
302AUTOLINK_SUPPORT = YES
303
304# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
305# to include (a tag file for) the STL sources as input, then you should set this
306# tag to YES in order to let doxygen match functions declarations and
307# definitions whose arguments contain STL classes (e.g. func(std::string);
308# versus func(std::string) {}). This also make the inheritance and collaboration
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000309# diagrams that involve STL classes more complete and accurate.
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700310# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000311
312BUILTIN_STL_SUPPORT = YES
313
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700314# If you use Microsoft's C++/CLI language, you should set this option to YES to
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000315# enable parsing support.
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700316# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000317
318CPP_CLI_SUPPORT = NO
319
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700320# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
321# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
322# will parse them like normal C++ but will assume all classes use public instead
323# of private inheritance when no explicit protection keyword is present.
324# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000325
326SIP_SUPPORT = NO
327
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700328# For Microsoft's IDL there are propget and propput attributes to indicate
329# getter and setter methods for a property. Setting this option to YES will make
330# doxygen to replace the get and set methods by a property in the documentation.
331# This will only work if the methods are indeed getting or setting a simple
332# type. If this is not the case, or you want to show the methods anyway, you
333# should set this option to NO.
334# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000335
336IDL_PROPERTY_SUPPORT = YES
337
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700338# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
339# tag is set to YES, then doxygen will reuse the documentation of the first
340# member in the group (if any) for the other members of the group. By default
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000341# all members of a group must be documented explicitly.
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700342# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000343
344DISTRIBUTE_GROUP_DOC = NO
345
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700346# Set the SUBGROUPING tag to YES to allow class member groups of the same type
347# (for instance a group of public functions) to be put as a subgroup of that
348# type (e.g. under the Public Functions section). Set it to NO to prevent
349# subgrouping. Alternatively, this can be done per class using the
350# \nosubgrouping command.
351# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000352
Christopher Dunne0d72242007-06-14 17:58:59 +0000353SUBGROUPING = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000354
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700355# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
356# are shown inside the group in which they are included (e.g. using \ingroup)
357# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
358# and RTF).
359#
360# Note that this feature does not work in combination with
361# SEPARATE_MEMBER_PAGES.
362# The default value is: NO.
363
364INLINE_GROUPED_CLASSES = NO
365
366# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
367# with only public data fields or simple typedef fields will be shown inline in
368# the documentation of the scope in which they are defined (i.e. file,
369# namespace, or group documentation), provided this scope is documented. If set
370# to NO, structs, classes, and unions are shown on a separate page (for HTML and
371# Man pages) or section (for LaTeX and RTF).
372# The default value is: NO.
373
374INLINE_SIMPLE_STRUCTS = NO
375
376# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
377# enum is documented as struct, union, or enum with the name of the typedef. So
378# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
379# with name TypeT. When disabled the typedef will appear as a member of a file,
380# namespace, or class. And the struct will be named TypeS. This can typically be
381# useful for C code in case the coding convention dictates that all compound
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000382# types are typedef'ed and only the typedef is referenced, never the tag name.
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700383# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000384
385TYPEDEF_HIDES_STRUCT = NO
386
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700387# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
388# cache is used to resolve symbols given their name and scope. Since this can be
389# an expensive process and often the same symbol appears multiple times in the
390# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
391# doxygen will become slower. If the cache is too large, memory is wasted. The
392# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
393# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
394# symbols. At the end of a run doxygen will report the cache usage and suggest
395# the optimal cache size from a speed point of view.
396# Minimum value: 0, maximum value: 9, default value: 0.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000397
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700398LOOKUP_CACHE_SIZE = 0
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000399
Christopher Dunne0d72242007-06-14 17:58:59 +0000400#---------------------------------------------------------------------------
401# Build related configuration options
402#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000403
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700404# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
405# documentation are documented, even if no documentation was available. Private
406# class members and static file members will be hidden unless the
407# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
408# Note: This will also disable the warnings about undocumented members that are
409# normally produced when WARNINGS is set to YES.
410# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000411
Christopher Dunne0d72242007-06-14 17:58:59 +0000412EXTRACT_ALL = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000413
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700414# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
415# be included in the documentation.
416# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000417
Christopher Dunne0d72242007-06-14 17:58:59 +0000418EXTRACT_PRIVATE = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000419
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700420# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
421# scope will be included in the documentation.
422# The default value is: NO.
423
424EXTRACT_PACKAGE = NO
425
426# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
427# included in the documentation.
428# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000429
Christopher Dunne0d72242007-06-14 17:58:59 +0000430EXTRACT_STATIC = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000431
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700432# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
433# locally in source files will be included in the documentation. If set to NO
434# only classes defined in header files are included. Does not have any effect
435# for Java sources.
436# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000437
Christopher Dunne0d72242007-06-14 17:58:59 +0000438EXTRACT_LOCAL_CLASSES = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000439
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700440# This flag is only useful for Objective-C code. When set to YES local methods,
441# which are defined in the implementation section but not in the interface are
442# included in the documentation. If set to NO only methods in the interface are
443# included.
444# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000445
Christopher Dunne0d72242007-06-14 17:58:59 +0000446EXTRACT_LOCAL_METHODS = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000447
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700448# If this flag is set to YES, the members of anonymous namespaces will be
449# extracted and appear in the documentation as a namespace called
450# 'anonymous_namespace{file}', where file will be replaced with the base name of
451# the file that contains the anonymous namespace. By default anonymous namespace
452# are hidden.
453# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000454
455EXTRACT_ANON_NSPACES = NO
456
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700457# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
458# undocumented members inside documented classes or files. If set to NO these
459# members will be included in the various overviews, but no documentation
460# section is generated. This option has no effect if EXTRACT_ALL is enabled.
461# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000462
Christopher Dunne0d72242007-06-14 17:58:59 +0000463HIDE_UNDOC_MEMBERS = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000464
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700465# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
466# undocumented classes that are normally visible in the class hierarchy. If set
467# to NO these classes will be included in the various overviews. This option has
468# no effect if EXTRACT_ALL is enabled.
469# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000470
Christopher Dunne0d72242007-06-14 17:58:59 +0000471HIDE_UNDOC_CLASSES = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000472
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700473# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
474# (class|struct|union) declarations. If set to NO these declarations will be
475# included in the documentation.
476# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000477
Christopher Dunne0d72242007-06-14 17:58:59 +0000478HIDE_FRIEND_COMPOUNDS = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000479
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700480# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
481# documentation blocks found inside the body of a function. If set to NO these
482# blocks will be appended to the function's detailed documentation block.
483# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000484
Christopher Dunne0d72242007-06-14 17:58:59 +0000485HIDE_IN_BODY_DOCS = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000486
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700487# The INTERNAL_DOCS tag determines if documentation that is typed after a
488# \internal command is included. If the tag is set to NO then the documentation
489# will be excluded. Set it to YES to include the internal documentation.
490# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000491
Christopher Dunne0d72242007-06-14 17:58:59 +0000492INTERNAL_DOCS = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000493
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700494# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
495# names in lower-case letters. If set to YES upper-case letters are also
496# allowed. This is useful if you have classes or files whose names only differ
497# in case and if your file system supports case sensitive file names. Windows
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000498# and Mac users are advised to set this option to NO.
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700499# The default value is: system dependent.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000500
Christopher Dunne0d72242007-06-14 17:58:59 +0000501CASE_SENSE_NAMES = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000502
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700503# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
504# their full class and namespace scopes in the documentation. If set to YES the
505# scope will be hidden.
506# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000507
Christopher Dunne0d72242007-06-14 17:58:59 +0000508HIDE_SCOPE_NAMES = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000509
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700510# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
511# the files that are included by a file in the documentation of that file.
512# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000513
Christopher Dunne0d72242007-06-14 17:58:59 +0000514SHOW_INCLUDE_FILES = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000515
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700516# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
517# files with double quotes in the documentation rather than with sharp brackets.
518# The default value is: NO.
519
520FORCE_LOCAL_INCLUDES = NO
521
522# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
523# documentation for inline members.
524# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000525
Christopher Dunne0d72242007-06-14 17:58:59 +0000526INLINE_INFO = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000527
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700528# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
529# (detailed) documentation of file and class members alphabetically by member
530# name. If set to NO the members will appear in declaration order.
531# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000532
Christopher Dunne0d72242007-06-14 17:58:59 +0000533SORT_MEMBER_DOCS = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000534
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700535# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
536# descriptions of file, namespace and class members alphabetically by member
537# name. If set to NO the members will appear in declaration order.
538# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000539
Christopher Dunne0d72242007-06-14 17:58:59 +0000540SORT_BRIEF_DOCS = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000541
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700542# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
543# (brief and detailed) documentation of class members so that constructors and
544# destructors are listed first. If set to NO the constructors will appear in the
545# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
546# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
547# member documentation.
548# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
549# detailed member documentation.
550# The default value is: NO.
551
552SORT_MEMBERS_CTORS_1ST = NO
553
554# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
555# of group names into alphabetical order. If set to NO the group names will
556# appear in their defined order.
557# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000558
559SORT_GROUP_NAMES = NO
560
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700561# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
562# fully-qualified names, including namespaces. If set to NO, the class list will
563# be sorted only by class name, not including the namespace part.
564# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
565# Note: This option applies only to the class list, not to the alphabetical
566# list.
567# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000568
569SORT_BY_SCOPE_NAME = YES
570
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700571# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
572# type resolution of all parameters of a function it will reject a match between
573# the prototype and the implementation of a member function even if there is
574# only one candidate or it is obvious which candidate to choose by doing a
575# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
576# accept a match between prototype and implementation in such cases.
577# The default value is: NO.
578
579STRICT_PROTO_MATCHING = NO
580
581# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
582# todo list. This list is created by putting \todo commands in the
583# documentation.
584# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000585
Christopher Dunne0d72242007-06-14 17:58:59 +0000586GENERATE_TODOLIST = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000587
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700588# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
589# test list. This list is created by putting \test commands in the
590# documentation.
591# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000592
593GENERATE_TESTLIST = NO
594
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700595# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
596# list. This list is created by putting \bug commands in the documentation.
597# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000598
599GENERATE_BUGLIST = NO
600
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700601# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
602# the deprecated list. This list is created by putting \deprecated commands in
603# the documentation.
604# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000605
Christopher Dunne0d72242007-06-14 17:58:59 +0000606GENERATE_DEPRECATEDLIST= YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000607
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700608# The ENABLED_SECTIONS tag can be used to enable conditional documentation
609# sections, marked by \if <section_label> ... \endif and \cond <section_label>
610# ... \endcond blocks.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000611
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700612ENABLED_SECTIONS =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000613
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700614# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
615# initial value of a variable or macro / define can have for it to appear in the
616# documentation. If the initializer consists of more lines than specified here
617# it will be hidden. Use a value of 0 to hide initializers completely. The
618# appearance of the value of individual variables and macros / defines can be
619# controlled using \showinitializer or \hideinitializer command in the
620# documentation regardless of this setting.
621# Minimum value: 0, maximum value: 10000, default value: 30.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000622
Christopher Dunne0d72242007-06-14 17:58:59 +0000623MAX_INITIALIZER_LINES = 30
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000624
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700625# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
626# the bottom of the documentation of classes and structs. If set to YES the list
627# will mention the files that were used to generate the documentation.
628# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000629
Christopher Dunne0d72242007-06-14 17:58:59 +0000630SHOW_USED_FILES = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000631
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700632# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
633# will remove the Files entry from the Quick Index and from the Folder Tree View
634# (if specified).
635# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000636
637SHOW_FILES = YES
638
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700639# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
640# page. This will remove the Namespaces entry from the Quick Index and from the
641# Folder Tree View (if specified).
642# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000643
644SHOW_NAMESPACES = YES
645
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700646# The FILE_VERSION_FILTER tag can be used to specify a program or script that
647# doxygen should invoke to get the current version for each file (typically from
648# the version control system). Doxygen will invoke the program by executing (via
649# popen()) the command command input-file, where command is the value of the
650# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
651# by doxygen. Whatever the program writes to standard output is used as the file
652# version. For an example see the documentation.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000653
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700654FILE_VERSION_FILTER =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000655
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700656# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
657# by doxygen. The layout file controls the global structure of the generated
658# output files in an output format independent way. To create the layout file
659# that represents doxygen's defaults, run doxygen with the -l option. You can
660# optionally specify a file name after the option, if omitted DoxygenLayout.xml
661# will be used as the name of the layout file.
662#
663# Note that if you run doxygen from a directory containing a file called
664# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
665# tag is left empty.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000666
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700667LAYOUT_FILE =
668
669# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
670# the reference definitions. This must be a list of .bib files. The .bib
671# extension is automatically appended if omitted. This requires the bibtex tool
672# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
673# For LaTeX the style of the bibliography can be controlled using
674# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
675# search path. Do not use file names with spaces, bibtex cannot handle them. See
676# also \cite for info how to create references.
677
678CITE_BIB_FILES =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000679
Christopher Dunne0d72242007-06-14 17:58:59 +0000680#---------------------------------------------------------------------------
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700681# Configuration options related to warning and progress messages
Christopher Dunne0d72242007-06-14 17:58:59 +0000682#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000683
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700684# The QUIET tag can be used to turn on/off the messages that are generated to
685# standard output by doxygen. If QUIET is set to YES this implies that the
686# messages are off.
687# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000688
Christopher Dunne0d72242007-06-14 17:58:59 +0000689QUIET = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000690
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700691# The WARNINGS tag can be used to turn on/off the warning messages that are
692# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
693# this implies that the warnings are on.
694#
695# Tip: Turn warnings on while writing the documentation.
696# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000697
Christopher Dunne0d72242007-06-14 17:58:59 +0000698WARNINGS = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000699
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700700# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
701# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
702# will automatically be disabled.
703# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000704
Christopher Dunne0d72242007-06-14 17:58:59 +0000705WARN_IF_UNDOCUMENTED = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000706
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700707# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
708# potential errors in the documentation, such as not documenting some parameters
709# in a documented function, or documenting parameters that don't exist or using
710# markup commands wrongly.
711# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000712
Christopher Dunne0d72242007-06-14 17:58:59 +0000713WARN_IF_DOC_ERROR = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000714
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700715# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
716# are documented, but have no documentation for their parameters or return
717# value. If set to NO doxygen will only warn about wrong or incomplete parameter
718# documentation, but not about the absence of documentation.
719# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000720
Christopher Dunne0d72242007-06-14 17:58:59 +0000721WARN_NO_PARAMDOC = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000722
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700723# The WARN_FORMAT tag determines the format of the warning messages that doxygen
724# can produce. The string should contain the $file, $line, and $text tags, which
725# will be replaced by the file and line number from which the warning originated
726# and the warning text. Optionally the format may contain $version, which will
727# be replaced by the version of the file (if it could be obtained via
728# FILE_VERSION_FILTER)
729# The default value is: $file:$line: $text.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000730
Christopher Dunne0d72242007-06-14 17:58:59 +0000731WARN_FORMAT = "$file:$line: $text"
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000732
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700733# The WARN_LOGFILE tag can be used to specify a file to which warning and error
734# messages should be written. If left blank the output is written to standard
735# error (stderr).
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000736
737WARN_LOGFILE = %WARNING_LOG_PATH%
738
Christopher Dunne0d72242007-06-14 17:58:59 +0000739#---------------------------------------------------------------------------
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700740# Configuration options related to the input files
Christopher Dunne0d72242007-06-14 17:58:59 +0000741#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000742
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700743# The INPUT tag is used to specify the files and/or directories that contain
744# documented source files. You may enter file names like myfile.cpp or
745# directories like /usr/src/myproject. Separate the files or directories with
746# spaces.
747# Note: If this tag is empty the current directory is searched.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000748
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700749INPUT = ../include \
750 ../src/lib_json \
751 .
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000752
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700753# This tag can be used to specify the character encoding of the source files
754# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
755# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
756# documentation (see: http://www.gnu.org/software/libiconv) for the list of
757# possible encodings.
758# The default value is: UTF-8.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000759
760INPUT_ENCODING = UTF-8
761
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700762# If the value of the INPUT tag contains directories, you can use the
763# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
764# *.h) to filter out the source-files in the directories. If left blank the
765# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
766# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
767# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
768# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
769# *.qsf, *.as and *.js.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000770
771FILE_PATTERNS = *.h \
772 *.cpp \
773 *.inl \
774 *.dox
775
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700776# The RECURSIVE tag can be used to specify whether or not subdirectories should
777# be searched for input files as well.
778# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000779
Christopher Dunne0d72242007-06-14 17:58:59 +0000780RECURSIVE = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000781
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700782# The EXCLUDE tag can be used to specify files and/or directories that should be
783# excluded from the INPUT source files. This way you can easily exclude a
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000784# subdirectory from a directory tree whose root is specified with the INPUT tag.
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700785#
786# Note that relative paths are relative to the directory from which doxygen is
787# run.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000788
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700789EXCLUDE =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000790
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700791# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
792# directories that are symbolic links (a Unix file system feature) are excluded
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000793# from the input.
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700794# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000795
Christopher Dunne0d72242007-06-14 17:58:59 +0000796EXCLUDE_SYMLINKS = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000797
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700798# If the value of the INPUT tag contains directories, you can use the
799# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
800# certain files from those directories.
801#
802# Note that the wildcards are matched against the file with absolute path, so to
803# exclude all test directories for example use the pattern */test/*
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000804
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700805EXCLUDE_PATTERNS =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000806
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700807# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
808# (namespaces, classes, functions, etc.) that should be excluded from the
809# output. The symbol name can be a fully qualified name, a word, or if the
810# wildcard * is used, a substring. Examples: ANamespace, AClass,
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000811# AClass::ANamespace, ANamespace::*Test
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700812#
813# Note that the wildcards are matched against the file with absolute path, so to
814# exclude all test directories use the pattern */test/*
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000815
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700816EXCLUDE_SYMBOLS =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000817
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700818# The EXAMPLE_PATH tag can be used to specify one or more files or directories
819# that contain example code fragments that are included (see the \include
820# command).
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000821
Christopher Dunn249fd182015-02-09 00:46:20 -0600822EXAMPLE_PATH = ..
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000823
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700824# If the value of the EXAMPLE_PATH tag contains directories, you can use the
825# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
826# *.h) to filter out the source-files in the directories. If left blank all
827# files are included.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000828
Christopher Dunne0d72242007-06-14 17:58:59 +0000829EXAMPLE_PATTERNS = *
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000830
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700831# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
832# searched for input files to be used with the \include or \dontinclude commands
833# irrespective of the value of the RECURSIVE tag.
834# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000835
Christopher Dunne0d72242007-06-14 17:58:59 +0000836EXAMPLE_RECURSIVE = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000837
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700838# The IMAGE_PATH tag can be used to specify one or more files or directories
839# that contain images that are to be included in the documentation (see the
840# \image command).
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000841
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700842IMAGE_PATH =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000843
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700844# The INPUT_FILTER tag can be used to specify a program that doxygen should
845# invoke to filter for each input file. Doxygen will invoke the filter program
846# by executing (via popen()) the command:
847#
848# <filter> <input-file>
849#
850# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
851# name of an input file. Doxygen will then use the output that the filter
852# program writes to standard output. If FILTER_PATTERNS is specified, this tag
853# will be ignored.
854#
855# Note that the filter must not add or remove lines; it is applied before the
856# code is scanned, but not when the output code is generated. If lines are added
857# or removed, the anchors will not be placed correctly.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000858
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700859INPUT_FILTER =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000860
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700861# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
862# basis. Doxygen will compare the file name with each pattern and apply the
863# filter if there is a match. The filters are a list of the form: pattern=filter
864# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
865# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
866# patterns match the file name, INPUT_FILTER is applied.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000867
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700868FILTER_PATTERNS =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000869
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700870# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
871# INPUT_FILTER ) will also be used to filter the input files that are used for
872# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
873# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000874
Christopher Dunne0d72242007-06-14 17:58:59 +0000875FILTER_SOURCE_FILES = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000876
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700877# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
878# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
879# it is also possible to disable source filtering for a specific pattern using
880# *.ext= (so without naming a filter).
881# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
882
883FILTER_SOURCE_PATTERNS =
884
885# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
886# is part of the input, its contents will be placed on the main page
887# (index.html). This can be useful if you have a project on for instance GitHub
888# and want to reuse the introduction page also for the doxygen output.
889
890USE_MDFILE_AS_MAINPAGE =
891
Christopher Dunne0d72242007-06-14 17:58:59 +0000892#---------------------------------------------------------------------------
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700893# Configuration options related to source browsing
Christopher Dunne0d72242007-06-14 17:58:59 +0000894#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000895
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700896# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
897# generated. Documented entities will be cross-referenced with these sources.
898#
899# Note: To get rid of all source code in the generated output, make sure that
900# also VERBATIM_HEADERS is set to NO.
901# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000902
Christopher Dunne0d72242007-06-14 17:58:59 +0000903SOURCE_BROWSER = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000904
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700905# Setting the INLINE_SOURCES tag to YES will include the body of functions,
906# classes and enums directly into the documentation.
907# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000908
Christopher Dunne0d72242007-06-14 17:58:59 +0000909INLINE_SOURCES = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000910
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700911# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
912# special comment blocks from generated source code fragments. Normal C, C++ and
913# Fortran comments will always remain visible.
914# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000915
Christopher Dunne0d72242007-06-14 17:58:59 +0000916STRIP_CODE_COMMENTS = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000917
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700918# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
919# function all documented functions referencing it will be listed.
920# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000921
Christopher Dunne0d72242007-06-14 17:58:59 +0000922REFERENCED_BY_RELATION = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000923
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700924# If the REFERENCES_RELATION tag is set to YES then for each documented function
925# all documented entities called/used by that function will be listed.
926# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000927
Christopher Dunne0d72242007-06-14 17:58:59 +0000928REFERENCES_RELATION = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000929
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700930# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
931# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
932# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
933# link to the documentation.
934# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000935
936REFERENCES_LINK_SOURCE = YES
937
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700938# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
939# source code will show a tooltip with additional information such as prototype,
940# brief description and links to the definition and documentation. Since this
941# will make the HTML file larger and loading of large files a bit slower, you
942# can opt to disable this feature.
943# The default value is: YES.
944# This tag requires that the tag SOURCE_BROWSER is set to YES.
945
946SOURCE_TOOLTIPS = YES
947
948# If the USE_HTAGS tag is set to YES then the references to source code will
949# point to the HTML generated by the htags(1) tool instead of doxygen built-in
950# source browser. The htags tool is part of GNU's global source tagging system
951# (see http://www.gnu.org/software/global/global.html). You will need version
952# 4.8.6 or higher.
953#
954# To use it do the following:
955# - Install the latest version of global
956# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
957# - Make sure the INPUT points to the root of the source tree
958# - Run doxygen as normal
959#
960# Doxygen will invoke htags (and that will in turn invoke gtags), so these
961# tools must be available from the command line (i.e. in the search path).
962#
963# The result: instead of the source browser generated by doxygen, the links to
964# source code will now point to the output of htags.
965# The default value is: NO.
966# This tag requires that the tag SOURCE_BROWSER is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000967
Christopher Dunne0d72242007-06-14 17:58:59 +0000968USE_HTAGS = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000969
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700970# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
971# verbatim copy of the header file for each class for which an include is
972# specified. Set to NO to disable this.
973# See also: Section \class.
974# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000975
Christopher Dunne0d72242007-06-14 17:58:59 +0000976VERBATIM_HEADERS = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000977
Christopher Dunne0d72242007-06-14 17:58:59 +0000978#---------------------------------------------------------------------------
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700979# Configuration options related to the alphabetical class index
Christopher Dunne0d72242007-06-14 17:58:59 +0000980#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000981
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700982# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
983# compounds will be generated. Enable this if the project contains a lot of
984# classes, structs, unions or interfaces.
985# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000986
Christopher Dunn692164d2017-09-10 19:53:42 -0500987ALPHABETICAL_INDEX = YES
988TOC_INCLUDE_HEADINGS = 2
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000989
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700990# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
991# which the alphabetical index list will be split.
992# Minimum value: 1, maximum value: 20, default value: 5.
993# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000994
Christopher Dunne0d72242007-06-14 17:58:59 +0000995COLS_IN_ALPHA_INDEX = 5
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000996
Christopher Dunn0973f2e2014-07-05 14:15:24 -0700997# In case all classes in a project start with a common prefix, all classes will
998# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
999# can be used to specify a prefix (or a list of prefixes) that should be ignored
1000# while generating the index headers.
1001# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001002
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001003IGNORE_PREFIX =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001004
Christopher Dunne0d72242007-06-14 17:58:59 +00001005#---------------------------------------------------------------------------
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001006# Configuration options related to the HTML output
Christopher Dunne0d72242007-06-14 17:58:59 +00001007#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001008
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001009# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1010# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001011
Christopher Dunne0d72242007-06-14 17:58:59 +00001012GENERATE_HTML = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001013
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001014# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1015# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1016# it.
1017# The default directory is: html.
1018# This tag requires that the tag GENERATE_HTML is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001019
1020HTML_OUTPUT = %HTML_OUTPUT%
1021
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001022# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1023# generated HTML page (for example: .htm, .php, .asp).
1024# The default value is: .html.
1025# This tag requires that the tag GENERATE_HTML is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001026
Christopher Dunne0d72242007-06-14 17:58:59 +00001027HTML_FILE_EXTENSION = .html
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001028
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001029# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1030# each generated HTML page. If the tag is left blank doxygen will generate a
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001031# standard header.
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001032#
1033# To get valid HTML the header file that includes any scripts and style sheets
1034# that doxygen needs, which is dependent on the configuration options used (e.g.
1035# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1036# default header using
1037# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1038# YourConfigFile
1039# and then modify the file new_header.html. See also section "Doxygen usage"
1040# for information on how to generate the default header that doxygen normally
1041# uses.
1042# Note: The header is subject to change so you typically have to regenerate the
1043# default header when upgrading to a newer version of doxygen. For a description
1044# of the possible markers and block names see the documentation.
1045# This tag requires that the tag GENERATE_HTML is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001046
Christopher Dunne0d72242007-06-14 17:58:59 +00001047HTML_HEADER = header.html
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001048
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001049# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1050# generated HTML page. If the tag is left blank doxygen will generate a standard
1051# footer. See HTML_HEADER for more information on how to generate a default
1052# footer and what special commands can be used inside the footer. See also
1053# section "Doxygen usage" for information on how to generate the default footer
1054# that doxygen normally uses.
1055# This tag requires that the tag GENERATE_HTML is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001056
Christopher Dunne0d72242007-06-14 17:58:59 +00001057HTML_FOOTER = footer.html
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001058
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001059# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1060# sheet that is used by each HTML page. It can be used to fine-tune the look of
1061# the HTML output. If left blank doxygen will generate a default style sheet.
1062# See also section "Doxygen usage" for information on how to generate the style
1063# sheet that doxygen normally uses.
1064# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1065# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1066# obsolete.
1067# This tag requires that the tag GENERATE_HTML is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001068
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001069HTML_STYLESHEET =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001070
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001071# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1072# defined cascading style sheet that is included after the standard style sheets
1073# created by doxygen. Using this option one can overrule certain style aspects.
1074# This is preferred over using HTML_STYLESHEET since it does not replace the
1075# standard style sheet and is therefor more robust against future updates.
1076# Doxygen will copy the style sheet file to the output directory. For an example
1077# see the documentation.
1078# This tag requires that the tag GENERATE_HTML is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001079
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001080HTML_EXTRA_STYLESHEET =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001081
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001082# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1083# other source files which should be copied to the HTML output directory. Note
1084# that these files will be copied to the base HTML output directory. Use the
1085# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1086# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1087# files will be copied as-is; there are no commands or markers available.
1088# This tag requires that the tag GENERATE_HTML is set to YES.
1089
1090HTML_EXTRA_FILES =
1091
1092# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1093# will adjust the colors in the stylesheet and background images according to
1094# this color. Hue is specified as an angle on a colorwheel, see
1095# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1096# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1097# purple, and 360 is red again.
1098# Minimum value: 0, maximum value: 359, default value: 220.
1099# This tag requires that the tag GENERATE_HTML is set to YES.
1100
1101HTML_COLORSTYLE_HUE = 220
1102
1103# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1104# in the HTML output. For a value of 0 the output will use grayscales only. A
1105# value of 255 will produce the most vivid colors.
1106# Minimum value: 0, maximum value: 255, default value: 100.
1107# This tag requires that the tag GENERATE_HTML is set to YES.
1108
1109HTML_COLORSTYLE_SAT = 100
1110
1111# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1112# luminance component of the colors in the HTML output. Values below 100
1113# gradually make the output lighter, whereas values above 100 make the output
1114# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1115# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1116# change the gamma.
1117# Minimum value: 40, maximum value: 240, default value: 80.
1118# This tag requires that the tag GENERATE_HTML is set to YES.
1119
1120HTML_COLORSTYLE_GAMMA = 80
1121
1122# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1123# page will contain the date and time when the page was generated. Setting this
1124# to NO can help when comparing the output of multiple runs.
1125# The default value is: YES.
1126# This tag requires that the tag GENERATE_HTML is set to YES.
1127
1128HTML_TIMESTAMP = YES
1129
1130# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1131# documentation will contain sections that can be hidden and shown after the
1132# page has loaded.
1133# The default value is: NO.
1134# This tag requires that the tag GENERATE_HTML is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001135
1136HTML_DYNAMIC_SECTIONS = YES
1137
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001138# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1139# shown in the various tree structured indices initially; the user can expand
1140# and collapse entries dynamically later on. Doxygen will expand the tree to
1141# such a level that at most the specified number of entries are visible (unless
1142# a fully collapsed tree already exceeds this amount). So setting the number of
1143# entries 1 will produce a full collapsed tree by default. 0 is a special value
1144# representing an infinite number of entries and will result in a full expanded
1145# tree by default.
1146# Minimum value: 0, maximum value: 9999, default value: 100.
1147# This tag requires that the tag GENERATE_HTML is set to YES.
1148
1149HTML_INDEX_NUM_ENTRIES = 100
1150
1151# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1152# generated that can be used as input for Apple's Xcode 3 integrated development
1153# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1154# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1155# Makefile in the HTML output directory. Running make will produce the docset in
1156# that directory and running make install will install the docset in
1157# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1158# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1159# for more information.
1160# The default value is: NO.
1161# This tag requires that the tag GENERATE_HTML is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001162
1163GENERATE_DOCSET = NO
1164
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001165# This tag determines the name of the docset feed. A documentation feed provides
1166# an umbrella under which multiple documentation sets from a single provider
1167# (such as a company or product suite) can be grouped.
1168# The default value is: Doxygen generated docs.
1169# This tag requires that the tag GENERATE_DOCSET is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001170
1171DOCSET_FEEDNAME = "Doxygen generated docs"
1172
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001173# This tag specifies a string that should uniquely identify the documentation
1174# set bundle. This should be a reverse domain-name style string, e.g.
1175# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1176# The default value is: org.doxygen.Project.
1177# This tag requires that the tag GENERATE_DOCSET is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001178
1179DOCSET_BUNDLE_ID = org.doxygen.Project
1180
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001181# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1182# the documentation publisher. This should be a reverse domain-name style
1183# string, e.g. com.mycompany.MyDocSet.documentation.
1184# The default value is: org.doxygen.Publisher.
1185# This tag requires that the tag GENERATE_DOCSET is set to YES.
1186
1187DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1188
1189# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1190# The default value is: Publisher.
1191# This tag requires that the tag GENERATE_DOCSET is set to YES.
1192
1193DOCSET_PUBLISHER_NAME = Publisher
1194
1195# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1196# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1197# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1198# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1199# Windows.
1200#
1201# The HTML Help Workshop contains a compiler that can convert all HTML output
1202# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1203# files are now used as the Windows 98 help format, and will replace the old
1204# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1205# HTML files also contain an index, a table of contents, and you can search for
1206# words in the documentation. The HTML workshop also contains a viewer for
1207# compressed HTML files.
1208# The default value is: NO.
1209# This tag requires that the tag GENERATE_HTML is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001210
1211GENERATE_HTMLHELP = %HTML_HELP%
1212
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001213# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1214# file. You can add a path in front of the file if the result should not be
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001215# written to the html output directory.
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001216# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001217
1218CHM_FILE = jsoncpp-%JSONCPP_VERSION%.chm
1219
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001220# The HHC_LOCATION tag can be used to specify the location (absolute path
1221# including file name) of the HTML help compiler ( hhc.exe). If non-empty
1222# doxygen will try to run the HTML help compiler on the generated index.hhp.
1223# The file has to be specified with full path.
1224# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001225
1226HHC_LOCATION = "c:\Program Files\HTML Help Workshop\hhc.exe"
1227
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001228# The GENERATE_CHI flag controls if a separate .chi index file is generated (
1229# YES) or that it should be included in the master .chm file ( NO).
1230# The default value is: NO.
1231# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001232
1233GENERATE_CHI = YES
1234
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001235# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1236# and project file content.
1237# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001238
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001239CHM_INDEX_ENCODING =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001240
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001241# The BINARY_TOC flag controls whether a binary table of contents is generated (
1242# YES) or a normal table of contents ( NO) in the .chm file.
1243# The default value is: NO.
1244# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001245
1246BINARY_TOC = YES
1247
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001248# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1249# the table of contents of the HTML help documentation and to the tree view.
1250# The default value is: NO.
1251# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001252
1253TOC_EXPAND = YES
1254
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001255# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1256# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1257# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1258# (.qch) of the generated HTML documentation.
1259# The default value is: NO.
1260# This tag requires that the tag GENERATE_HTML is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001261
1262GENERATE_QHP = NO
1263
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001264# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1265# the file name of the resulting .qch file. The path specified is relative to
1266# the HTML output folder.
1267# This tag requires that the tag GENERATE_QHP is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001268
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001269QCH_FILE =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001270
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001271# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1272# Project output. For more information please see Qt Help Project / Namespace
1273# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1274# The default value is: org.doxygen.Project.
1275# This tag requires that the tag GENERATE_QHP is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001276
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001277QHP_NAMESPACE =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001278
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001279# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1280# Help Project output. For more information please see Qt Help Project / Virtual
1281# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1282# folders).
1283# The default value is: doc.
1284# This tag requires that the tag GENERATE_QHP is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001285
1286QHP_VIRTUAL_FOLDER = doc
1287
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001288# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1289# filter to add. For more information please see Qt Help Project / Custom
1290# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1291# filters).
1292# This tag requires that the tag GENERATE_QHP is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001293
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001294QHP_CUST_FILTER_NAME =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001295
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001296# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1297# custom filter to add. For more information please see Qt Help Project / Custom
1298# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1299# filters).
1300# This tag requires that the tag GENERATE_QHP is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001301
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001302QHP_CUST_FILTER_ATTRS =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001303
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001304# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1305# project's filter section matches. Qt Help Project / Filter Attributes (see:
1306# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1307# This tag requires that the tag GENERATE_QHP is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001308
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001309QHP_SECT_FILTER_ATTRS =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001310
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001311# The QHG_LOCATION tag can be used to specify the location of Qt's
1312# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1313# generated .qhp file.
1314# This tag requires that the tag GENERATE_QHP is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001315
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001316QHG_LOCATION =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001317
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001318# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1319# generated, together with the HTML files, they form an Eclipse help plugin. To
1320# install this plugin and make it available under the help contents menu in
1321# Eclipse, the contents of the directory containing the HTML and XML files needs
1322# to be copied into the plugins directory of eclipse. The name of the directory
1323# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1324# After copying Eclipse needs to be restarted before the help appears.
1325# The default value is: NO.
1326# This tag requires that the tag GENERATE_HTML is set to YES.
1327
1328GENERATE_ECLIPSEHELP = NO
1329
1330# A unique identifier for the Eclipse help plugin. When installing the plugin
1331# the directory name containing the HTML and XML files should also have this
1332# name. Each documentation set should have its own identifier.
1333# The default value is: org.doxygen.Project.
1334# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1335
1336ECLIPSE_DOC_ID = org.doxygen.Project
1337
1338# If you want full control over the layout of the generated HTML pages it might
1339# be necessary to disable the index and replace it with your own. The
1340# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1341# of each HTML page. A value of NO enables the index and the value YES disables
1342# it. Since the tabs in the index contain the same information as the navigation
1343# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1344# The default value is: NO.
1345# This tag requires that the tag GENERATE_HTML is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001346
Christopher Dunne0d72242007-06-14 17:58:59 +00001347DISABLE_INDEX = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001348
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001349# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1350# structure should be generated to display hierarchical information. If the tag
1351# value is set to YES, a side panel will be generated containing a tree-like
1352# index structure (just like the one that is generated for HTML Help). For this
1353# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1354# (i.e. any modern browser). Windows users are probably better off using the
1355# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
1356# further fine-tune the look of the index. As an example, the default style
1357# sheet generated by doxygen has an example that shows how to put an image at
1358# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1359# the same information as the tab index, you could consider setting
1360# DISABLE_INDEX to YES when enabling this option.
1361# The default value is: NO.
1362# This tag requires that the tag GENERATE_HTML is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001363
Christopher Dunne0d72242007-06-14 17:58:59 +00001364GENERATE_TREEVIEW = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001365
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001366# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1367# doxygen will group on one line in the generated HTML documentation.
1368#
1369# Note that a value of 0 will completely suppress the enum values from appearing
1370# in the overview section.
1371# Minimum value: 0, maximum value: 20, default value: 4.
1372# This tag requires that the tag GENERATE_HTML is set to YES.
1373
1374ENUM_VALUES_PER_LINE = 4
1375
1376# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1377# to set the initial width (in pixels) of the frame in which the tree is shown.
1378# Minimum value: 0, maximum value: 1500, default value: 250.
1379# This tag requires that the tag GENERATE_HTML is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001380
Christopher Dunne0d72242007-06-14 17:58:59 +00001381TREEVIEW_WIDTH = 250
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001382
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001383# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1384# external symbols imported via tag files in a separate window.
1385# The default value is: NO.
1386# This tag requires that the tag GENERATE_HTML is set to YES.
1387
1388EXT_LINKS_IN_WINDOW = NO
1389
1390# Use this tag to change the font size of LaTeX formulas included as images in
1391# the HTML documentation. When you change the font size after a successful
1392# doxygen run you need to manually remove any form_*.png images from the HTML
1393# output directory to force them to be regenerated.
1394# Minimum value: 8, maximum value: 50, default value: 10.
1395# This tag requires that the tag GENERATE_HTML is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001396
1397FORMULA_FONTSIZE = 10
1398
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001399# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1400# generated for formulas are transparent PNGs. Transparent PNGs are not
1401# supported properly for IE 6.0, but are supported on all modern browsers.
1402#
1403# Note that when changing this option you need to delete any form_*.png files in
1404# the HTML output directory before the changes have effect.
1405# The default value is: YES.
1406# This tag requires that the tag GENERATE_HTML is set to YES.
1407
1408FORMULA_TRANSPARENT = YES
1409
1410# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1411# http://www.mathjax.org) which uses client side Javascript for the rendering
1412# instead of using prerendered bitmaps. Use this if you do not have LaTeX
1413# installed or if you want to formulas look prettier in the HTML output. When
1414# enabled you may also need to install MathJax separately and configure the path
1415# to it using the MATHJAX_RELPATH option.
1416# The default value is: NO.
1417# This tag requires that the tag GENERATE_HTML is set to YES.
1418
1419USE_MATHJAX = NO
1420
1421# When MathJax is enabled you can set the default output format to be used for
1422# the MathJax output. See the MathJax site (see:
1423# http://docs.mathjax.org/en/latest/output.html) for more details.
1424# Possible values are: HTML-CSS (which is slower, but has the best
1425# compatibility), NativeMML (i.e. MathML) and SVG.
1426# The default value is: HTML-CSS.
1427# This tag requires that the tag USE_MATHJAX is set to YES.
1428
1429MATHJAX_FORMAT = HTML-CSS
1430
1431# When MathJax is enabled you need to specify the location relative to the HTML
1432# output directory using the MATHJAX_RELPATH option. The destination directory
1433# should contain the MathJax.js script. For instance, if the mathjax directory
1434# is located at the same level as the HTML output directory, then
1435# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1436# Content Delivery Network so you can quickly see the result without installing
1437# MathJax. However, it is strongly recommended to install a local copy of
1438# MathJax from http://www.mathjax.org before deployment.
1439# The default value is: http://cdn.mathjax.org/mathjax/latest.
1440# This tag requires that the tag USE_MATHJAX is set to YES.
1441
1442MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1443
1444# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1445# extension names that should be enabled during MathJax rendering. For example
1446# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1447# This tag requires that the tag USE_MATHJAX is set to YES.
1448
1449MATHJAX_EXTENSIONS =
1450
1451# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1452# of code that will be used on startup of the MathJax code. See the MathJax site
1453# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1454# example see the documentation.
1455# This tag requires that the tag USE_MATHJAX is set to YES.
1456
1457MATHJAX_CODEFILE =
1458
1459# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1460# the HTML output. The underlying search engine uses javascript and DHTML and
1461# should work on any modern browser. Note that when using HTML help
1462# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1463# there is already a search function so this one should typically be disabled.
1464# For large projects the javascript based search engine can be slow, then
1465# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1466# search using the keyboard; to jump to the search box use <access key> + S
1467# (what the <access key> is depends on the OS and browser, but it is typically
1468# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1469# key> to jump into the search results window, the results can be navigated
1470# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1471# the search. The filter options can be selected when the cursor is inside the
1472# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1473# to select a filter and <Enter> or <escape> to activate or cancel the filter
1474# option.
1475# The default value is: YES.
1476# This tag requires that the tag GENERATE_HTML is set to YES.
1477
1478SEARCHENGINE = NO
1479
1480# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1481# implemented using a web server instead of a web client using Javascript. There
1482# are two flavours of web server based searching depending on the
1483# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
1484# searching and an index file used by the script. When EXTERNAL_SEARCH is
1485# enabled the indexing and searching needs to be provided by external tools. See
1486# the section "External Indexing and Searching" for details.
1487# The default value is: NO.
1488# This tag requires that the tag SEARCHENGINE is set to YES.
1489
1490SERVER_BASED_SEARCH = NO
1491
1492# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1493# script for searching. Instead the search results are written to an XML file
1494# which needs to be processed by an external indexer. Doxygen will invoke an
1495# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1496# search results.
1497#
1498# Doxygen ships with an example indexer ( doxyindexer) and search engine
1499# (doxysearch.cgi) which are based on the open source search engine library
1500# Xapian (see: http://xapian.org/).
1501#
1502# See the section "External Indexing and Searching" for details.
1503# The default value is: NO.
1504# This tag requires that the tag SEARCHENGINE is set to YES.
1505
1506EXTERNAL_SEARCH = NO
1507
1508# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1509# which will return the search results when EXTERNAL_SEARCH is enabled.
1510#
1511# Doxygen ships with an example indexer ( doxyindexer) and search engine
1512# (doxysearch.cgi) which are based on the open source search engine library
1513# Xapian (see: http://xapian.org/). See the section "External Indexing and
1514# Searching" for details.
1515# This tag requires that the tag SEARCHENGINE is set to YES.
1516
1517SEARCHENGINE_URL =
1518
1519# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1520# search data is written to a file for indexing by an external tool. With the
1521# SEARCHDATA_FILE tag the name of this file can be specified.
1522# The default file is: searchdata.xml.
1523# This tag requires that the tag SEARCHENGINE is set to YES.
1524
1525SEARCHDATA_FILE = searchdata.xml
1526
1527# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1528# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1529# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1530# projects and redirect the results back to the right project.
1531# This tag requires that the tag SEARCHENGINE is set to YES.
1532
1533EXTERNAL_SEARCH_ID =
1534
1535# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1536# projects other than the one defined by this configuration file, but that are
1537# all added to the same external search index. Each project needs to have a
1538# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1539# to a relative location where the documentation can be found. The format is:
1540# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1541# This tag requires that the tag SEARCHENGINE is set to YES.
1542
1543EXTRA_SEARCH_MAPPINGS =
1544
Christopher Dunne0d72242007-06-14 17:58:59 +00001545#---------------------------------------------------------------------------
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001546# Configuration options related to the LaTeX output
Christopher Dunne0d72242007-06-14 17:58:59 +00001547#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001548
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001549# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1550# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001551
Christopher Dunne0d72242007-06-14 17:58:59 +00001552GENERATE_LATEX = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001553
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001554# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1555# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1556# it.
1557# The default directory is: latex.
1558# This tag requires that the tag GENERATE_LATEX is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001559
Christopher Dunne0d72242007-06-14 17:58:59 +00001560LATEX_OUTPUT = latex
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001561
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001562# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1563# invoked.
1564#
1565# Note that when enabling USE_PDFLATEX this option is only used for generating
1566# bitmaps for formulas in the HTML output, but not in the Makefile that is
1567# written to the output directory.
1568# The default file is: latex.
1569# This tag requires that the tag GENERATE_LATEX is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001570
Christopher Dunne0d72242007-06-14 17:58:59 +00001571LATEX_CMD_NAME = latex
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001572
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001573# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1574# index for LaTeX.
1575# The default file is: makeindex.
1576# This tag requires that the tag GENERATE_LATEX is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001577
Christopher Dunne0d72242007-06-14 17:58:59 +00001578MAKEINDEX_CMD_NAME = makeindex
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001579
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001580# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1581# documents. This may be useful for small projects and may help to save some
1582# trees in general.
1583# The default value is: NO.
1584# This tag requires that the tag GENERATE_LATEX is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001585
Christopher Dunne0d72242007-06-14 17:58:59 +00001586COMPACT_LATEX = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001587
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001588# The PAPER_TYPE tag can be used to set the paper type that is used by the
1589# printer.
1590# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1591# 14 inches) and executive (7.25 x 10.5 inches).
1592# The default value is: a4.
1593# This tag requires that the tag GENERATE_LATEX is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001594
Christopher Dunne0d72242007-06-14 17:58:59 +00001595PAPER_TYPE = a4wide
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001596
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001597# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1598# that should be included in the LaTeX output. To get the times font for
1599# instance you can specify
1600# EXTRA_PACKAGES=times
1601# If left blank no extra packages will be included.
1602# This tag requires that the tag GENERATE_LATEX is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001603
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001604EXTRA_PACKAGES =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001605
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001606# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1607# generated LaTeX document. The header should contain everything until the first
1608# chapter. If it is left blank doxygen will generate a standard header. See
1609# section "Doxygen usage" for information on how to let doxygen write the
1610# default header to a separate file.
1611#
1612# Note: Only use a user-defined header if you know what you are doing! The
1613# following commands have a special meaning inside the header: $title,
1614# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
1615# replace them by respectively the title of the page, the current date and time,
1616# only the current date, the version number of doxygen, the project name (see
1617# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
1618# This tag requires that the tag GENERATE_LATEX is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001619
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001620LATEX_HEADER =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001621
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001622# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1623# generated LaTeX document. The footer should contain everything after the last
1624# chapter. If it is left blank doxygen will generate a standard footer.
1625#
1626# Note: Only use a user-defined footer if you know what you are doing!
1627# This tag requires that the tag GENERATE_LATEX is set to YES.
1628
1629LATEX_FOOTER =
1630
1631# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1632# other source files which should be copied to the LATEX_OUTPUT output
1633# directory. Note that the files will be copied as-is; there are no commands or
1634# markers available.
1635# This tag requires that the tag GENERATE_LATEX is set to YES.
1636
1637LATEX_EXTRA_FILES =
1638
1639# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1640# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1641# contain links (just like the HTML output) instead of page references. This
1642# makes the output suitable for online browsing using a PDF viewer.
1643# The default value is: YES.
1644# This tag requires that the tag GENERATE_LATEX is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001645
Christopher Dunne0d72242007-06-14 17:58:59 +00001646PDF_HYPERLINKS = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001647
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001648# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1649# the PDF file directly from the LaTeX files. Set this option to YES to get a
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001650# higher quality PDF documentation.
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001651# The default value is: YES.
1652# This tag requires that the tag GENERATE_LATEX is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001653
Christopher Dunne0d72242007-06-14 17:58:59 +00001654USE_PDFLATEX = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001655
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001656# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1657# command to the generated LaTeX files. This will instruct LaTeX to keep running
1658# if errors occur, instead of asking the user for help. This option is also used
1659# when generating formulas in HTML.
1660# The default value is: NO.
1661# This tag requires that the tag GENERATE_LATEX is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001662
Christopher Dunne0d72242007-06-14 17:58:59 +00001663LATEX_BATCHMODE = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001664
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001665# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1666# index chapters (such as File Index, Compound Index, etc.) in the output.
1667# The default value is: NO.
1668# This tag requires that the tag GENERATE_LATEX is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001669
Christopher Dunne0d72242007-06-14 17:58:59 +00001670LATEX_HIDE_INDICES = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001671
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001672# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1673# code with syntax highlighting in the LaTeX output.
1674#
1675# Note that which sources are shown also depends on other settings such as
1676# SOURCE_BROWSER.
1677# The default value is: NO.
1678# This tag requires that the tag GENERATE_LATEX is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001679
1680LATEX_SOURCE_CODE = NO
1681
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001682# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1683# bibliography, e.g. plainnat, or ieeetr. See
1684# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1685# The default value is: plain.
1686# This tag requires that the tag GENERATE_LATEX is set to YES.
1687
1688LATEX_BIB_STYLE = plain
1689
Christopher Dunne0d72242007-06-14 17:58:59 +00001690#---------------------------------------------------------------------------
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001691# Configuration options related to the RTF output
Christopher Dunne0d72242007-06-14 17:58:59 +00001692#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001693
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001694# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1695# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1696# readers/editors.
1697# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001698
Christopher Dunne0d72242007-06-14 17:58:59 +00001699GENERATE_RTF = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001700
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001701# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1702# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1703# it.
1704# The default directory is: rtf.
1705# This tag requires that the tag GENERATE_RTF is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001706
Christopher Dunne0d72242007-06-14 17:58:59 +00001707RTF_OUTPUT = rtf
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001708
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001709# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1710# documents. This may be useful for small projects and may help to save some
1711# trees in general.
1712# The default value is: NO.
1713# This tag requires that the tag GENERATE_RTF is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001714
Christopher Dunne0d72242007-06-14 17:58:59 +00001715COMPACT_RTF = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001716
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001717# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1718# contain hyperlink fields. The RTF file will contain links (just like the HTML
1719# output) instead of page references. This makes the output suitable for online
1720# browsing using Word or some other Word compatible readers that support those
1721# fields.
1722#
1723# Note: WordPad (write) and others do not support links.
1724# The default value is: NO.
1725# This tag requires that the tag GENERATE_RTF is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001726
Christopher Dunne0d72242007-06-14 17:58:59 +00001727RTF_HYPERLINKS = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001728
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001729# Load stylesheet definitions from file. Syntax is similar to doxygen's config
1730# file, i.e. a series of assignments. You only have to provide replacements,
1731# missing definitions are set to their default value.
1732#
1733# See also section "Doxygen usage" for information on how to generate the
1734# default style sheet that doxygen normally uses.
1735# This tag requires that the tag GENERATE_RTF is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001736
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001737RTF_STYLESHEET_FILE =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001738
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001739# Set optional variables used in the generation of an RTF document. Syntax is
1740# similar to doxygen's config file. A template extensions file can be generated
1741# using doxygen -e rtf extensionFile.
1742# This tag requires that the tag GENERATE_RTF is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001743
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001744RTF_EXTENSIONS_FILE =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001745
Christopher Dunne0d72242007-06-14 17:58:59 +00001746#---------------------------------------------------------------------------
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001747# Configuration options related to the man page output
Christopher Dunne0d72242007-06-14 17:58:59 +00001748#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001749
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001750# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1751# classes and files.
1752# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001753
Christopher Dunne0d72242007-06-14 17:58:59 +00001754GENERATE_MAN = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001755
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001756# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1757# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1758# it. A directory man3 will be created inside the directory specified by
1759# MAN_OUTPUT.
1760# The default directory is: man.
1761# This tag requires that the tag GENERATE_MAN is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001762
Christopher Dunne0d72242007-06-14 17:58:59 +00001763MAN_OUTPUT = man
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001764
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001765# The MAN_EXTENSION tag determines the extension that is added to the generated
1766# man pages. In case the manual section does not start with a number, the number
1767# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1768# optional.
1769# The default value is: .3.
1770# This tag requires that the tag GENERATE_MAN is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001771
Christopher Dunne0d72242007-06-14 17:58:59 +00001772MAN_EXTENSION = .3
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001773
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001774# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1775# will generate one additional man file for each entity documented in the real
1776# man page(s). These additional files only source the real man page, but without
1777# them the man command would be unable to find the correct page.
1778# The default value is: NO.
1779# This tag requires that the tag GENERATE_MAN is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001780
Christopher Dunne0d72242007-06-14 17:58:59 +00001781MAN_LINKS = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001782
Christopher Dunne0d72242007-06-14 17:58:59 +00001783#---------------------------------------------------------------------------
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001784# Configuration options related to the XML output
Christopher Dunne0d72242007-06-14 17:58:59 +00001785#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001786
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001787# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1788# captures the structure of the code including all documentation.
1789# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001790
Christopher Dunne0d72242007-06-14 17:58:59 +00001791GENERATE_XML = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001792
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001793# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1794# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1795# it.
1796# The default directory is: xml.
1797# This tag requires that the tag GENERATE_XML is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001798
Christopher Dunne0d72242007-06-14 17:58:59 +00001799XML_OUTPUT = xml
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001800
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001801# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
1802# validating XML parser to check the syntax of the XML files.
1803# This tag requires that the tag GENERATE_XML is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001804
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001805XML_SCHEMA =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001806
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001807# The XML_DTD tag can be used to specify a XML DTD, which can be used by a
1808# validating XML parser to check the syntax of the XML files.
1809# This tag requires that the tag GENERATE_XML is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001810
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001811XML_DTD =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001812
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001813# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1814# listings (including syntax highlighting and cross-referencing information) to
1815# the XML output. Note that enabling this will significantly increase the size
1816# of the XML output.
1817# The default value is: YES.
1818# This tag requires that the tag GENERATE_XML is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001819
Christopher Dunne0d72242007-06-14 17:58:59 +00001820XML_PROGRAMLISTING = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001821
Christopher Dunne0d72242007-06-14 17:58:59 +00001822#---------------------------------------------------------------------------
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001823# Configuration options related to the DOCBOOK output
Christopher Dunne0d72242007-06-14 17:58:59 +00001824#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001825
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001826# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1827# that can be used to generate PDF.
1828# The default value is: NO.
1829
1830GENERATE_DOCBOOK = NO
1831
1832# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1833# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1834# front of it.
1835# The default directory is: docbook.
1836# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1837
1838DOCBOOK_OUTPUT = docbook
1839
1840#---------------------------------------------------------------------------
1841# Configuration options for the AutoGen Definitions output
1842#---------------------------------------------------------------------------
1843
1844# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1845# Definitions (see http://autogen.sf.net) file that captures the structure of
1846# the code including all documentation. Note that this feature is still
1847# experimental and incomplete at the moment.
1848# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001849
Christopher Dunne0d72242007-06-14 17:58:59 +00001850GENERATE_AUTOGEN_DEF = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001851
Christopher Dunne0d72242007-06-14 17:58:59 +00001852#---------------------------------------------------------------------------
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001853# Configuration options related to the Perl module output
Christopher Dunne0d72242007-06-14 17:58:59 +00001854#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001855
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001856# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1857# file that captures the structure of the code including all documentation.
1858#
1859# Note that this feature is still experimental and incomplete at the moment.
1860# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001861
Christopher Dunne0d72242007-06-14 17:58:59 +00001862GENERATE_PERLMOD = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001863
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001864# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1865# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1866# output from the Perl module output.
1867# The default value is: NO.
1868# This tag requires that the tag GENERATE_PERLMOD is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001869
Christopher Dunne0d72242007-06-14 17:58:59 +00001870PERLMOD_LATEX = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001871
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001872# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1873# formatted so it can be parsed by a human reader. This is useful if you want to
1874# understand what is going on. On the other hand, if this tag is set to NO the
1875# size of the Perl module output will be much smaller and Perl will parse it
1876# just the same.
1877# The default value is: YES.
1878# This tag requires that the tag GENERATE_PERLMOD is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001879
Christopher Dunne0d72242007-06-14 17:58:59 +00001880PERLMOD_PRETTY = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001881
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001882# The names of the make variables in the generated doxyrules.make file are
1883# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1884# so different doxyrules.make files included by the same Makefile don't
1885# overwrite each other's variables.
1886# This tag requires that the tag GENERATE_PERLMOD is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001887
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001888PERLMOD_MAKEVAR_PREFIX =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001889
Christopher Dunne0d72242007-06-14 17:58:59 +00001890#---------------------------------------------------------------------------
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001891# Configuration options related to the preprocessor
Christopher Dunne0d72242007-06-14 17:58:59 +00001892#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001893
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001894# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1895# C-preprocessor directives found in the sources and include files.
1896# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001897
Christopher Dunne0d72242007-06-14 17:58:59 +00001898ENABLE_PREPROCESSING = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001899
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001900# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1901# in the source code. If set to NO only conditional compilation will be
1902# performed. Macro expansion can be done in a controlled way by setting
1903# EXPAND_ONLY_PREDEF to YES.
1904# The default value is: NO.
1905# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001906
1907MACRO_EXPANSION = YES
1908
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001909# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1910# the macro expansion is limited to the macros specified with the PREDEFINED and
1911# EXPAND_AS_DEFINED tags.
1912# The default value is: NO.
1913# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001914
Christopher Dunne0d72242007-06-14 17:58:59 +00001915EXPAND_ONLY_PREDEF = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001916
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001917# If the SEARCH_INCLUDES tag is set to YES the includes files in the
1918# INCLUDE_PATH will be searched if a #include is found.
1919# The default value is: YES.
1920# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001921
Christopher Dunne0d72242007-06-14 17:58:59 +00001922SEARCH_INCLUDES = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001923
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001924# The INCLUDE_PATH tag can be used to specify one or more directories that
1925# contain include files that are not input files but should be processed by the
1926# preprocessor.
1927# This tag requires that the tag SEARCH_INCLUDES is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001928
Christopher Dunne0d72242007-06-14 17:58:59 +00001929INCLUDE_PATH = ../include
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001930
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001931# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1932# patterns (like *.h and *.hpp) to filter out the header-files in the
1933# directories. If left blank, the patterns specified with FILE_PATTERNS will be
1934# used.
1935# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001936
Christopher Dunne0d72242007-06-14 17:58:59 +00001937INCLUDE_FILE_PATTERNS = *.h
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001938
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001939# The PREDEFINED tag can be used to specify one or more macro names that are
1940# defined before the preprocessor is started (similar to the -D option of e.g.
1941# gcc). The argument of the tag is a list of macros of the form: name or
1942# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
1943# is assumed. To prevent a macro definition from being undefined via #undef or
1944# recursively expanded use the := operator instead of the = operator.
1945# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001946
1947PREDEFINED = "_MSC_VER=1400" \
1948 _CPPRTTI \
1949 _WIN32 \
Christopher Dunn47887642015-02-22 16:38:05 -06001950 JSONCPP_DOC_EXCLUDE_IMPLEMENTATION
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001951
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001952# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
1953# tag can be used to specify a list of macro names that should be expanded. The
1954# macro definition that is found in the sources will be used. Use the PREDEFINED
1955# tag if you want to use a different macro definition that overrules the
1956# definition found in the source code.
1957# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001958
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001959EXPAND_AS_DEFINED =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001960
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001961# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
1962# remove all refrences to function-like macros that are alone on a line, have an
1963# all uppercase name, and do not end with a semicolon. Such function macros are
1964# typically used for boiler-plate code, and will confuse the parser if not
1965# removed.
1966# The default value is: YES.
1967# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001968
Christopher Dunne0d72242007-06-14 17:58:59 +00001969SKIP_FUNCTION_MACROS = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001970
Christopher Dunne0d72242007-06-14 17:58:59 +00001971#---------------------------------------------------------------------------
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001972# Configuration options related to external references
Christopher Dunne0d72242007-06-14 17:58:59 +00001973#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001974
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001975# The TAGFILES tag can be used to specify one or more tag files. For each tag
1976# file the location of the external documentation should be added. The format of
1977# a tag file without this location is as follows:
1978# TAGFILES = file1 file2 ...
1979# Adding location for the tag files is done as follows:
1980# TAGFILES = file1=loc1 "file2 = loc2" ...
1981# where loc1 and loc2 can be relative or absolute paths or URLs. See the
1982# section "Linking to external documentation" for more information about the use
1983# of tag files.
1984# Note: Each tag file must have an unique name (where the name does NOT include
1985# the path). If a tag file is not located in the directory in which doxygen is
1986# run, you must also specify the path to the tagfile here.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001987
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001988TAGFILES =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001989
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001990# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
1991# tag file that is based on the input files it reads. See section "Linking to
1992# external documentation" for more information about the usage of tag files.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001993
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001994GENERATE_TAGFILE =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001995
Christopher Dunn0973f2e2014-07-05 14:15:24 -07001996# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
1997# class index. If set to NO only the inherited external classes will be listed.
1998# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001999
Christopher Dunne0d72242007-06-14 17:58:59 +00002000ALLEXTERNALS = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002001
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002002# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
2003# the modules index. If set to NO, only the current project's groups will be
2004# listed.
2005# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002006
Christopher Dunne0d72242007-06-14 17:58:59 +00002007EXTERNAL_GROUPS = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002008
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002009# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2010# the related pages index. If set to NO, only the current project's pages will
2011# be listed.
2012# The default value is: YES.
2013
2014EXTERNAL_PAGES = YES
2015
2016# The PERL_PATH should be the absolute path and name of the perl script
2017# interpreter (i.e. the result of 'which perl').
2018# The default file (with absolute path) is: /usr/bin/perl.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002019
Christopher Dunne0d72242007-06-14 17:58:59 +00002020PERL_PATH = /usr/bin/perl
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002021
Christopher Dunne0d72242007-06-14 17:58:59 +00002022#---------------------------------------------------------------------------
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002023# Configuration options related to the dot tool
Christopher Dunne0d72242007-06-14 17:58:59 +00002024#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002025
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002026# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2027# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2028# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2029# disabled, but it is recommended to install and use dot, since it yields more
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002030# powerful graphs.
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002031# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002032
Christopher Dunne0d72242007-06-14 17:58:59 +00002033CLASS_DIAGRAMS = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002034
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002035# You can define message sequence charts within doxygen comments using the \msc
2036# command. Doxygen will then run the mscgen tool (see:
2037# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2038# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2039# the mscgen tool resides. If left empty the tool is assumed to be found in the
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002040# default search path.
2041
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002042MSCGEN_PATH =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002043
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002044# If set to YES, the inheritance and collaboration graphs will hide inheritance
2045# and usage relations if the target is undocumented or is not a class.
2046# The default value is: YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002047
2048HIDE_UNDOC_RELATIONS = NO
2049
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002050# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2051# available from the path. This tool is part of Graphviz (see:
2052# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2053# Bell Labs. The other options in this section have no effect if this option is
2054# set to NO
2055# The default value is: NO.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002056
2057HAVE_DOT = %HAVE_DOT%
2058
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002059# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2060# to run in parallel. When set to 0 doxygen will base this on the number of
2061# processors available in the system. You can set it explicitly to a value
2062# larger than 0 to get control over the balance between CPU load and processing
2063# speed.
2064# Minimum value: 0, maximum value: 32, default value: 0.
2065# This tag requires that the tag HAVE_DOT is set to YES.
2066
2067DOT_NUM_THREADS = 0
2068
2069# When you want a differently looking font n the dot files that doxygen
2070# generates you can specify the font name using DOT_FONTNAME. You need to make
2071# sure dot is able to find the font, which can be done by putting it in a
2072# standard location or by setting the DOTFONTPATH environment variable or by
2073# setting DOT_FONTPATH to the directory containing the font.
2074# The default value is: Helvetica.
2075# This tag requires that the tag HAVE_DOT is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002076
2077DOT_FONTNAME = FreeSans
2078
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002079# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2080# dot graphs.
2081# Minimum value: 4, maximum value: 24, default value: 10.
2082# This tag requires that the tag HAVE_DOT is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002083
2084DOT_FONTSIZE = 10
2085
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002086# By default doxygen will tell dot to use the default font as specified with
2087# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2088# the path where dot can find it using this tag.
2089# This tag requires that the tag HAVE_DOT is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002090
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002091DOT_FONTPATH =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002092
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002093# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2094# each documented class showing the direct and indirect inheritance relations.
2095# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2096# The default value is: YES.
2097# This tag requires that the tag HAVE_DOT is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002098
Christopher Dunne0d72242007-06-14 17:58:59 +00002099CLASS_GRAPH = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002100
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002101# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2102# graph for each documented class showing the direct and indirect implementation
2103# dependencies (inheritance, containment, and class references variables) of the
2104# class with other documented classes.
2105# The default value is: YES.
2106# This tag requires that the tag HAVE_DOT is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002107
Christopher Dunne0d72242007-06-14 17:58:59 +00002108COLLABORATION_GRAPH = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002109
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002110# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2111# groups, showing the direct groups dependencies.
2112# The default value is: YES.
2113# This tag requires that the tag HAVE_DOT is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002114
Christopher Dunne0d72242007-06-14 17:58:59 +00002115GROUP_GRAPHS = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002116
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002117# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2118# collaboration diagrams in a style similar to the OMG's Unified Modeling
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002119# Language.
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002120# The default value is: NO.
2121# This tag requires that the tag HAVE_DOT is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002122
2123UML_LOOK = %UML_LOOK%
2124
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002125# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2126# class node. If there are many fields or methods and many nodes the graph may
2127# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2128# number of items for each type to make the size more manageable. Set this to 0
2129# for no limit. Note that the threshold may be exceeded by 50% before the limit
2130# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2131# but if the number exceeds 15, the total amount of fields shown is limited to
2132# 10.
2133# Minimum value: 0, maximum value: 100, default value: 10.
2134# This tag requires that the tag HAVE_DOT is set to YES.
2135
2136UML_LIMIT_NUM_FIELDS = 10
2137
2138# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2139# collaboration graphs will show the relations between templates and their
2140# instances.
2141# The default value is: NO.
2142# This tag requires that the tag HAVE_DOT is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002143
2144TEMPLATE_RELATIONS = YES
2145
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002146# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2147# YES then doxygen will generate a graph for each documented file showing the
2148# direct and indirect include dependencies of the file with other documented
2149# files.
2150# The default value is: YES.
2151# This tag requires that the tag HAVE_DOT is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002152
Christopher Dunne0d72242007-06-14 17:58:59 +00002153INCLUDE_GRAPH = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002154
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002155# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2156# set to YES then doxygen will generate a graph for each documented file showing
2157# the direct and indirect include dependencies of the file with other documented
2158# files.
2159# The default value is: YES.
2160# This tag requires that the tag HAVE_DOT is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002161
Christopher Dunne0d72242007-06-14 17:58:59 +00002162INCLUDED_BY_GRAPH = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002163
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002164# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2165# dependency graph for every global function or class method.
2166#
2167# Note that enabling this option will significantly increase the time of a run.
2168# So in most cases it will be better to enable call graphs for selected
2169# functions only using the \callgraph command.
2170# The default value is: NO.
2171# This tag requires that the tag HAVE_DOT is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002172
Christopher Dunne0d72242007-06-14 17:58:59 +00002173CALL_GRAPH = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002174
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002175# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2176# dependency graph for every global function or class method.
2177#
2178# Note that enabling this option will significantly increase the time of a run.
2179# So in most cases it will be better to enable caller graphs for selected
2180# functions only using the \callergraph command.
2181# The default value is: NO.
2182# This tag requires that the tag HAVE_DOT is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002183
2184CALLER_GRAPH = YES
2185
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002186# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2187# hierarchy of all classes instead of a textual one.
2188# The default value is: YES.
2189# This tag requires that the tag HAVE_DOT is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002190
Christopher Dunne0d72242007-06-14 17:58:59 +00002191GRAPHICAL_HIERARCHY = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002192
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002193# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2194# dependencies a directory has on other directories in a graphical way. The
2195# dependency relations are determined by the #include relations between the
2196# files in the directories.
2197# The default value is: YES.
2198# This tag requires that the tag HAVE_DOT is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002199
Christopher Dunne0d72242007-06-14 17:58:59 +00002200DIRECTORY_GRAPH = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002201
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002202# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2203# generated by dot.
2204# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2205# to make the SVG files visible in IE 9+ (other browsers do not have this
2206# requirement).
2207# Possible values are: png, jpg, gif and svg.
2208# The default value is: png.
2209# This tag requires that the tag HAVE_DOT is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002210
Christopher Dunne0d72242007-06-14 17:58:59 +00002211DOT_IMAGE_FORMAT = png
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002212
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002213# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2214# enable generation of interactive SVG images that allow zooming and panning.
2215#
2216# Note that this requires a modern browser other than Internet Explorer. Tested
2217# and working are Firefox, Chrome, Safari, and Opera.
2218# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2219# the SVG files visible. Older versions of IE do not have SVG support.
2220# The default value is: NO.
2221# This tag requires that the tag HAVE_DOT is set to YES.
2222
2223INTERACTIVE_SVG = NO
2224
2225# The DOT_PATH tag can be used to specify the path where the dot tool can be
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002226# found. If left blank, it is assumed the dot tool can be found in the path.
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002227# This tag requires that the tag HAVE_DOT is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002228
2229DOT_PATH = %DOT_PATH%
2230
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002231# The DOTFILE_DIRS tag can be used to specify one or more directories that
2232# contain dot files that are included in the documentation (see the \dotfile
2233# command).
2234# This tag requires that the tag HAVE_DOT is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002235
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002236DOTFILE_DIRS =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002237
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002238# The MSCFILE_DIRS tag can be used to specify one or more directories that
2239# contain msc files that are included in the documentation (see the \mscfile
2240# command).
2241
2242MSCFILE_DIRS =
2243
2244# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2245# that will be shown in the graph. If the number of nodes in a graph becomes
2246# larger than this value, doxygen will truncate the graph, which is visualized
2247# by representing a node as a red box. Note that doxygen if the number of direct
2248# children of the root node in a graph is already larger than
2249# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2250# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2251# Minimum value: 0, maximum value: 10000, default value: 50.
2252# This tag requires that the tag HAVE_DOT is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002253
2254DOT_GRAPH_MAX_NODES = 50
2255
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002256# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2257# generated by dot. A depth value of 3 means that only nodes reachable from the
2258# root by following a path via at most 3 edges will be shown. Nodes that lay
2259# further from the root node will be omitted. Note that setting this option to 1
2260# or 2 may greatly reduce the computation time needed for large code bases. Also
2261# note that the size of a graph can be further restricted by
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002262# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002263# Minimum value: 0, maximum value: 1000, default value: 0.
2264# This tag requires that the tag HAVE_DOT is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002265
Christopher Dunne0d72242007-06-14 17:58:59 +00002266MAX_DOT_GRAPH_DEPTH = 1000
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002267
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002268# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2269# background. This is disabled by default, because dot on Windows does not seem
2270# to support this out of the box.
2271#
2272# Warning: Depending on the platform used, enabling this option may lead to
2273# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2274# read).
2275# The default value is: NO.
2276# This tag requires that the tag HAVE_DOT is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002277
Christopher Dunne0d72242007-06-14 17:58:59 +00002278DOT_TRANSPARENT = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002279
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002280# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2281# files in one run (i.e. multiple -o and -T options on the command line). This
2282# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2283# this, this feature is disabled by default.
2284# The default value is: NO.
2285# This tag requires that the tag HAVE_DOT is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002286
2287DOT_MULTI_TARGETS = YES
2288
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002289# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2290# explaining the meaning of the various boxes and arrows in the dot generated
2291# graphs.
2292# The default value is: YES.
2293# This tag requires that the tag HAVE_DOT is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002294
Christopher Dunne0d72242007-06-14 17:58:59 +00002295GENERATE_LEGEND = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002296
Christopher Dunn0973f2e2014-07-05 14:15:24 -07002297# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2298# files that are used to generate the various graphs.
2299# The default value is: YES.
2300# This tag requires that the tag HAVE_DOT is set to YES.
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00002301
Christopher Dunne0d72242007-06-14 17:58:59 +00002302DOT_CLEANUP = YES