source: tspsg/Doxyfile @ 1241232377

appveyorimgbotreadme
Last change on this file since 1241232377 was 243b53b608, checked in by Oleksii Serdiuk, 11 years ago

Updated Doxyfile to the latest doxygen format (1.8.5).

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