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