xref: /netbsd-src/external/gpl3/gcc.old/dist/libstdc++-v3/doc/doxygen/user.cfg.in (revision 23f5f46327e37e7811da3520f4bb933f9489322f)
18feb0f0bSmrg# Doxyfile 1.8.14
236ac495dSmrg
336ac495dSmrg# This file describes the settings to be used by the documentation system
436ac495dSmrg# doxygen (www.doxygen.org) for a project.
536ac495dSmrg#
636ac495dSmrg# All text after a double hash (##) is considered a comment and is placed in
736ac495dSmrg# front of the TAG it is preceding.
836ac495dSmrg#
936ac495dSmrg# All text after a single hash (#) is considered a comment and will be ignored.
1036ac495dSmrg# The format is:
1136ac495dSmrg# TAG = value [value, ...]
1236ac495dSmrg# For lists, items can also be appended using:
1336ac495dSmrg# TAG += value [value, ...]
1436ac495dSmrg# Values that contain spaces should be placed between quotes (\" \").
1536ac495dSmrg
1636ac495dSmrg#---------------------------------------------------------------------------
1736ac495dSmrg# Project related configuration options
1836ac495dSmrg#---------------------------------------------------------------------------
1936ac495dSmrg
2036ac495dSmrg# This tag specifies the encoding used for all characters in the config file
2136ac495dSmrg# that follow. The default is UTF-8 which is also the encoding used for all text
2236ac495dSmrg# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
238feb0f0bSmrg# built into libc) for the transcoding. See
248feb0f0bSmrg# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
2536ac495dSmrg# The default value is: UTF-8.
2636ac495dSmrg
2736ac495dSmrgDOXYFILE_ENCODING      = UTF-8
2836ac495dSmrg
2936ac495dSmrg# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
3036ac495dSmrg# double-quotes, unless you are using Doxywizard) that should identify the
3136ac495dSmrg# project for which the documentation is generated. This name is used in the
3236ac495dSmrg# title of most generated pages and in a few other places.
3336ac495dSmrg# The default value is: My Project.
3436ac495dSmrg
3536ac495dSmrgPROJECT_NAME           = libstdc++
3636ac495dSmrg
3736ac495dSmrg# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
3836ac495dSmrg# could be handy for archiving the generated documentation or if some version
3936ac495dSmrg# control system is used.
4036ac495dSmrg
4136ac495dSmrgPROJECT_NUMBER         =
4236ac495dSmrg
4336ac495dSmrg# Using the PROJECT_BRIEF tag one can provide an optional one line description
4436ac495dSmrg# for a project that appears at the top of each page and should give viewer a
4536ac495dSmrg# quick idea about the purpose of the project. Keep the description short.
4636ac495dSmrg
4736ac495dSmrgPROJECT_BRIEF          =
4836ac495dSmrg
498feb0f0bSmrg# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
508feb0f0bSmrg# in the documentation. The maximum height of the logo should not exceed 55
518feb0f0bSmrg# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
528feb0f0bSmrg# the logo to the output directory.
5336ac495dSmrg
5436ac495dSmrgPROJECT_LOGO           =
5536ac495dSmrg
5636ac495dSmrg# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
5736ac495dSmrg# into which the generated documentation will be written. If a relative path is
5836ac495dSmrg# entered, it will be relative to the location where doxygen was started. If
5936ac495dSmrg# left blank the current directory will be used.
6036ac495dSmrg
6136ac495dSmrgOUTPUT_DIRECTORY       = @outdir@
6236ac495dSmrg
638feb0f0bSmrg# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
6436ac495dSmrg# directories (in 2 levels) under the output directory of each output format and
6536ac495dSmrg# will distribute the generated files over these directories. Enabling this
6636ac495dSmrg# option can be useful when feeding doxygen a huge amount of source files, where
6736ac495dSmrg# putting all generated files in the same directory would otherwise causes
6836ac495dSmrg# performance problems for the file system.
6936ac495dSmrg# The default value is: NO.
7036ac495dSmrg
7136ac495dSmrgCREATE_SUBDIRS         = NO
7236ac495dSmrg
738feb0f0bSmrg# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
748feb0f0bSmrg# characters to appear in the names of generated files. If set to NO, non-ASCII
758feb0f0bSmrg# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
768feb0f0bSmrg# U+3044.
778feb0f0bSmrg# The default value is: NO.
788feb0f0bSmrg
798feb0f0bSmrgALLOW_UNICODE_NAMES    = NO
808feb0f0bSmrg
8136ac495dSmrg# The OUTPUT_LANGUAGE tag is used to specify the language in which all
8236ac495dSmrg# documentation generated by doxygen is written. Doxygen will use this
8336ac495dSmrg# information to generate all constant output in the proper language.
8436ac495dSmrg# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
8536ac495dSmrg# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
8636ac495dSmrg# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
8736ac495dSmrg# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
8836ac495dSmrg# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
8936ac495dSmrg# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
9036ac495dSmrg# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
9136ac495dSmrg# Ukrainian and Vietnamese.
9236ac495dSmrg# The default value is: English.
9336ac495dSmrg
9436ac495dSmrgOUTPUT_LANGUAGE        = English
9536ac495dSmrg
968feb0f0bSmrg# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
9736ac495dSmrg# descriptions after the members that are listed in the file and class
9836ac495dSmrg# documentation (similar to Javadoc). Set to NO to disable this.
9936ac495dSmrg# The default value is: YES.
10036ac495dSmrg
10136ac495dSmrgBRIEF_MEMBER_DESC      = @do_man@
10236ac495dSmrg
1038feb0f0bSmrg# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
10436ac495dSmrg# description of a member or function before the detailed description
10536ac495dSmrg#
10636ac495dSmrg# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
10736ac495dSmrg# brief descriptions will be completely suppressed.
10836ac495dSmrg# The default value is: YES.
10936ac495dSmrg
11036ac495dSmrgREPEAT_BRIEF           = YES
11136ac495dSmrg
11236ac495dSmrg# This tag implements a quasi-intelligent brief description abbreviator that is
11336ac495dSmrg# used to form the text in various listings. Each string in this list, if found
11436ac495dSmrg# as the leading text of the brief description, will be stripped from the text
11536ac495dSmrg# and the result, after processing the whole list, is used as the annotated
11636ac495dSmrg# text. Otherwise, the brief description is used as-is. If left blank, the
11736ac495dSmrg# following values are used ($name is automatically replaced with the name of
11836ac495dSmrg# the entity):The $name class, The $name widget, The $name file, is, provides,
11936ac495dSmrg# specifies, contains, represents, a, an and the.
12036ac495dSmrg
12136ac495dSmrgABBREVIATE_BRIEF       =
12236ac495dSmrg
12336ac495dSmrg# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
12436ac495dSmrg# doxygen will generate a detailed section even if there is only a brief
12536ac495dSmrg# description.
12636ac495dSmrg# The default value is: NO.
12736ac495dSmrg
12836ac495dSmrgALWAYS_DETAILED_SEC    = YES
12936ac495dSmrg
13036ac495dSmrg# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
13136ac495dSmrg# inherited members of a class in the documentation of that class as if those
13236ac495dSmrg# members were ordinary class members. Constructors, destructors and assignment
13336ac495dSmrg# operators of the base classes will not be shown.
13436ac495dSmrg# The default value is: NO.
13536ac495dSmrg
13636ac495dSmrgINLINE_INHERITED_MEMB  = YES
13736ac495dSmrg
1388feb0f0bSmrg# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
13936ac495dSmrg# before files name in the file list and in the header files. If set to NO the
14036ac495dSmrg# shortest path that makes the file name unique will be used
14136ac495dSmrg# The default value is: YES.
14236ac495dSmrg
14336ac495dSmrgFULL_PATH_NAMES        = NO
14436ac495dSmrg
14536ac495dSmrg# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
14636ac495dSmrg# Stripping is only done if one of the specified strings matches the left-hand
14736ac495dSmrg# part of the path. The tag can be used to show relative paths in the file list.
14836ac495dSmrg# If left blank the directory from which doxygen is run is used as the path to
14936ac495dSmrg# strip.
15036ac495dSmrg#
15136ac495dSmrg# Note that you can specify absolute paths here, but also relative paths, which
15236ac495dSmrg# will be relative from the directory where doxygen is started.
15336ac495dSmrg# This tag requires that the tag FULL_PATH_NAMES is set to YES.
15436ac495dSmrg
155*23f5f463SmrgSTRIP_FROM_PATH        = @srcdir@/doc/ @srcdir@/libsupc++/ include/
15636ac495dSmrg
15736ac495dSmrg# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
15836ac495dSmrg# path mentioned in the documentation of a class, which tells the reader which
15936ac495dSmrg# header file to include in order to use a class. If left blank only the name of
16036ac495dSmrg# the header file containing the class definition is used. Otherwise one should
16136ac495dSmrg# specify the list of include paths that are normally passed to the compiler
16236ac495dSmrg# using the -I flag.
16336ac495dSmrg
16436ac495dSmrgSTRIP_FROM_INC_PATH    =
16536ac495dSmrg
16636ac495dSmrg# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
16736ac495dSmrg# less readable) file names. This can be useful is your file systems doesn't
16836ac495dSmrg# support long names like on DOS, Mac, or CD-ROM.
16936ac495dSmrg# The default value is: NO.
17036ac495dSmrg
17136ac495dSmrgSHORT_NAMES            = @shortname@
17236ac495dSmrg
17336ac495dSmrg# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
17436ac495dSmrg# first line (until the first dot) of a Javadoc-style comment as the brief
17536ac495dSmrg# description. If set to NO, the Javadoc-style will behave just like regular Qt-
17636ac495dSmrg# style comments (thus requiring an explicit @brief command for a brief
17736ac495dSmrg# description.)
17836ac495dSmrg# The default value is: NO.
17936ac495dSmrg
18036ac495dSmrgJAVADOC_AUTOBRIEF      = NO
18136ac495dSmrg
18236ac495dSmrg# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
18336ac495dSmrg# line (until the first dot) of a Qt-style comment as the brief description. If
18436ac495dSmrg# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
18536ac495dSmrg# requiring an explicit \brief command for a brief description.)
18636ac495dSmrg# The default value is: NO.
18736ac495dSmrg
18836ac495dSmrgQT_AUTOBRIEF           = NO
18936ac495dSmrg
19036ac495dSmrg# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
19136ac495dSmrg# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
19236ac495dSmrg# a brief description. This used to be the default behavior. The new default is
19336ac495dSmrg# to treat a multi-line C++ comment block as a detailed description. Set this
19436ac495dSmrg# tag to YES if you prefer the old behavior instead.
19536ac495dSmrg#
19636ac495dSmrg# Note that setting this tag to YES also means that rational rose comments are
19736ac495dSmrg# not recognized any more.
19836ac495dSmrg# The default value is: NO.
19936ac495dSmrg
20036ac495dSmrgMULTILINE_CPP_IS_BRIEF = YES
20136ac495dSmrg
20236ac495dSmrg# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
20336ac495dSmrg# documentation from any documented member that it re-implements.
20436ac495dSmrg# The default value is: YES.
20536ac495dSmrg
20636ac495dSmrgINHERIT_DOCS           = YES
20736ac495dSmrg
2088feb0f0bSmrg# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
2098feb0f0bSmrg# page for each member. If set to NO, the documentation of a member will be part
2108feb0f0bSmrg# of the file/class/namespace that contains it.
21136ac495dSmrg# The default value is: NO.
21236ac495dSmrg
21336ac495dSmrgSEPARATE_MEMBER_PAGES  = NO
21436ac495dSmrg
21536ac495dSmrg# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
21636ac495dSmrg# uses this value to replace tabs by spaces in code fragments.
21736ac495dSmrg# Minimum value: 1, maximum value: 16, default value: 4.
21836ac495dSmrg
21936ac495dSmrgTAB_SIZE               = 8
22036ac495dSmrg
22136ac495dSmrg# This tag can be used to specify a number of aliases that act as commands in
22236ac495dSmrg# the documentation. An alias has the form:
22336ac495dSmrg# name=value
22436ac495dSmrg# For example adding
22536ac495dSmrg# "sideeffect=@par Side Effects:\n"
22636ac495dSmrg# will allow you to put the command \sideeffect (or @sideeffect) in the
22736ac495dSmrg# documentation, which will result in a user-defined paragraph with heading
22836ac495dSmrg# "Side Effects:". You can put \n's in the value part of an alias to insert
2298feb0f0bSmrg# newlines (in the resulting output). You can put ^^ in the value part of an
2308feb0f0bSmrg# alias to insert a newline as if a physical newline was in the original file.
23136ac495dSmrg
2328feb0f0bSmrgALIASES                = "doctodo=@todo Needs documentation! See http://gcc.gnu.org/onlinedocs/libstdc++/manual/documentation_style.html" \
23336ac495dSmrg                         "headername{1}=Instead, include \<\1\>." \
23436ac495dSmrg                         "headername{2}=Instead, include \<\1\> or \<\2\>."
23536ac495dSmrg
23636ac495dSmrg# This tag can be used to specify a number of word-keyword mappings (TCL only).
23736ac495dSmrg# A mapping has the form "name=value". For example adding "class=itcl::class"
23836ac495dSmrg# will allow you to use the command class in the itcl::class meaning.
23936ac495dSmrg
24036ac495dSmrgTCL_SUBST              =
24136ac495dSmrg
24236ac495dSmrg# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
24336ac495dSmrg# only. Doxygen will then generate output that is more tailored for C. For
24436ac495dSmrg# instance, some of the names that are used will be different. The list of all
24536ac495dSmrg# members will be omitted, etc.
24636ac495dSmrg# The default value is: NO.
24736ac495dSmrg
24836ac495dSmrgOPTIMIZE_OUTPUT_FOR_C  = NO
24936ac495dSmrg
25036ac495dSmrg# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
25136ac495dSmrg# Python sources only. Doxygen will then generate output that is more tailored
25236ac495dSmrg# for that language. For instance, namespaces will be presented as packages,
25336ac495dSmrg# qualified scopes will look different, etc.
25436ac495dSmrg# The default value is: NO.
25536ac495dSmrg
25636ac495dSmrgOPTIMIZE_OUTPUT_JAVA   = NO
25736ac495dSmrg
25836ac495dSmrg# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
25936ac495dSmrg# sources. Doxygen will then generate output that is tailored for Fortran.
26036ac495dSmrg# The default value is: NO.
26136ac495dSmrg
26236ac495dSmrgOPTIMIZE_FOR_FORTRAN   = NO
26336ac495dSmrg
26436ac495dSmrg# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
26536ac495dSmrg# sources. Doxygen will then generate output that is tailored for VHDL.
26636ac495dSmrg# The default value is: NO.
26736ac495dSmrg
26836ac495dSmrgOPTIMIZE_OUTPUT_VHDL   = NO
26936ac495dSmrg
27036ac495dSmrg# Doxygen selects the parser to use depending on the extension of the files it
27136ac495dSmrg# parses. With this tag you can assign which parser to use for a given
27236ac495dSmrg# extension. Doxygen has a built-in mapping, but you can override or extend it
27336ac495dSmrg# using this tag. The format is ext=language, where ext is a file extension, and
27436ac495dSmrg# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
2758feb0f0bSmrg# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
2768feb0f0bSmrg# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
2778feb0f0bSmrg# Fortran. In the later case the parser tries to guess whether the code is fixed
2788feb0f0bSmrg# or free formatted code, this is the default for Fortran type files), VHDL. For
2798feb0f0bSmrg# instance to make doxygen treat .inc files as Fortran files (default is PHP),
2808feb0f0bSmrg# and .f files as C (default is Fortran), use: inc=Fortran f=C.
28136ac495dSmrg#
2828feb0f0bSmrg# Note: For files without extension you can use no_extension as a placeholder.
28336ac495dSmrg#
28436ac495dSmrg# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
28536ac495dSmrg# the files are not read by doxygen.
28636ac495dSmrg
2878feb0f0bSmrgEXTENSION_MAPPING      = no_extension=C++ \
2888feb0f0bSmrg                         .h=C++ \
2898feb0f0bSmrg                         .tcc=C++ \
2908feb0f0bSmrg                         .hpp=C++
29136ac495dSmrg
29236ac495dSmrg# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
29336ac495dSmrg# according to the Markdown format, which allows for more readable
29436ac495dSmrg# documentation. See http://daringfireball.net/projects/markdown/ for details.
29536ac495dSmrg# The output of markdown processing is further processed by doxygen, so you can
29636ac495dSmrg# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
29736ac495dSmrg# case of backward compatibilities issues.
29836ac495dSmrg# The default value is: YES.
29936ac495dSmrg
3008feb0f0bSmrgMARKDOWN_SUPPORT       = YES
3018feb0f0bSmrg
3028feb0f0bSmrg# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
3038feb0f0bSmrg# to that level are automatically included in the table of contents, even if
3048feb0f0bSmrg# they do not have an id attribute.
3058feb0f0bSmrg# Note: This feature currently applies only to Markdown headings.
3068feb0f0bSmrg# Minimum value: 0, maximum value: 99, default value: 0.
3078feb0f0bSmrg# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
3088feb0f0bSmrg
3098feb0f0bSmrgTOC_INCLUDE_HEADINGS   = 0
31036ac495dSmrg
31136ac495dSmrg# When enabled doxygen tries to link words that correspond to documented
31236ac495dSmrg# classes, or namespaces to their corresponding documentation. Such a link can
3138feb0f0bSmrg# be prevented in individual cases by putting a % sign in front of the word or
3148feb0f0bSmrg# globally by setting AUTOLINK_SUPPORT to NO.
31536ac495dSmrg# The default value is: YES.
31636ac495dSmrg
31736ac495dSmrgAUTOLINK_SUPPORT       = NO
31836ac495dSmrg
31936ac495dSmrg# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
32036ac495dSmrg# to include (a tag file for) the STL sources as input, then you should set this
32136ac495dSmrg# tag to YES in order to let doxygen match functions declarations and
32236ac495dSmrg# definitions whose arguments contain STL classes (e.g. func(std::string);
32336ac495dSmrg# versus func(std::string) {}). This also make the inheritance and collaboration
32436ac495dSmrg# diagrams that involve STL classes more complete and accurate.
32536ac495dSmrg# The default value is: NO.
32636ac495dSmrg
32736ac495dSmrgBUILTIN_STL_SUPPORT    = NO
32836ac495dSmrg
32936ac495dSmrg# If you use Microsoft's C++/CLI language, you should set this option to YES to
33036ac495dSmrg# enable parsing support.
33136ac495dSmrg# The default value is: NO.
33236ac495dSmrg
33336ac495dSmrgCPP_CLI_SUPPORT        = NO
33436ac495dSmrg
33536ac495dSmrg# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
3368feb0f0bSmrg# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
33736ac495dSmrg# will parse them like normal C++ but will assume all classes use public instead
33836ac495dSmrg# of private inheritance when no explicit protection keyword is present.
33936ac495dSmrg# The default value is: NO.
34036ac495dSmrg
34136ac495dSmrgSIP_SUPPORT            = NO
34236ac495dSmrg
34336ac495dSmrg# For Microsoft's IDL there are propget and propput attributes to indicate
34436ac495dSmrg# getter and setter methods for a property. Setting this option to YES will make
34536ac495dSmrg# doxygen to replace the get and set methods by a property in the documentation.
34636ac495dSmrg# This will only work if the methods are indeed getting or setting a simple
34736ac495dSmrg# type. If this is not the case, or you want to show the methods anyway, you
34836ac495dSmrg# should set this option to NO.
34936ac495dSmrg# The default value is: YES.
35036ac495dSmrg
35136ac495dSmrgIDL_PROPERTY_SUPPORT   = NO
35236ac495dSmrg
35336ac495dSmrg# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
3548feb0f0bSmrg# tag is set to YES then doxygen will reuse the documentation of the first
35536ac495dSmrg# member in the group (if any) for the other members of the group. By default
35636ac495dSmrg# all members of a group must be documented explicitly.
35736ac495dSmrg# The default value is: NO.
35836ac495dSmrg
35936ac495dSmrgDISTRIBUTE_GROUP_DOC   = YES
36036ac495dSmrg
3618feb0f0bSmrg# If one adds a struct or class to a group and this option is enabled, then also
3628feb0f0bSmrg# any nested class or struct is added to the same group. By default this option
3638feb0f0bSmrg# is disabled and one has to add nested compounds explicitly via \ingroup.
3648feb0f0bSmrg# The default value is: NO.
3658feb0f0bSmrg
3668feb0f0bSmrgGROUP_NESTED_COMPOUNDS = YES
3678feb0f0bSmrg
36836ac495dSmrg# Set the SUBGROUPING tag to YES to allow class member groups of the same type
36936ac495dSmrg# (for instance a group of public functions) to be put as a subgroup of that
37036ac495dSmrg# type (e.g. under the Public Functions section). Set it to NO to prevent
37136ac495dSmrg# subgrouping. Alternatively, this can be done per class using the
37236ac495dSmrg# \nosubgrouping command.
37336ac495dSmrg# The default value is: YES.
37436ac495dSmrg
37536ac495dSmrgSUBGROUPING            = YES
37636ac495dSmrg
37736ac495dSmrg# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
37836ac495dSmrg# are shown inside the group in which they are included (e.g. using \ingroup)
37936ac495dSmrg# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
38036ac495dSmrg# and RTF).
38136ac495dSmrg#
38236ac495dSmrg# Note that this feature does not work in combination with
38336ac495dSmrg# SEPARATE_MEMBER_PAGES.
38436ac495dSmrg# The default value is: NO.
38536ac495dSmrg
38636ac495dSmrgINLINE_GROUPED_CLASSES = NO
38736ac495dSmrg
38836ac495dSmrg# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
38936ac495dSmrg# with only public data fields or simple typedef fields will be shown inline in
39036ac495dSmrg# the documentation of the scope in which they are defined (i.e. file,
39136ac495dSmrg# namespace, or group documentation), provided this scope is documented. If set
39236ac495dSmrg# to NO, structs, classes, and unions are shown on a separate page (for HTML and
39336ac495dSmrg# Man pages) or section (for LaTeX and RTF).
39436ac495dSmrg# The default value is: NO.
39536ac495dSmrg
39636ac495dSmrgINLINE_SIMPLE_STRUCTS  = NO
39736ac495dSmrg
39836ac495dSmrg# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
39936ac495dSmrg# enum is documented as struct, union, or enum with the name of the typedef. So
40036ac495dSmrg# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
40136ac495dSmrg# with name TypeT. When disabled the typedef will appear as a member of a file,
40236ac495dSmrg# namespace, or class. And the struct will be named TypeS. This can typically be
40336ac495dSmrg# useful for C code in case the coding convention dictates that all compound
40436ac495dSmrg# types are typedef'ed and only the typedef is referenced, never the tag name.
40536ac495dSmrg# The default value is: NO.
40636ac495dSmrg
40736ac495dSmrgTYPEDEF_HIDES_STRUCT   = NO
40836ac495dSmrg
40936ac495dSmrg# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
41036ac495dSmrg# cache is used to resolve symbols given their name and scope. Since this can be
41136ac495dSmrg# an expensive process and often the same symbol appears multiple times in the
41236ac495dSmrg# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
41336ac495dSmrg# doxygen will become slower. If the cache is too large, memory is wasted. The
41436ac495dSmrg# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
41536ac495dSmrg# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
41636ac495dSmrg# symbols. At the end of a run doxygen will report the cache usage and suggest
41736ac495dSmrg# the optimal cache size from a speed point of view.
41836ac495dSmrg# Minimum value: 0, maximum value: 9, default value: 0.
41936ac495dSmrg
42036ac495dSmrgLOOKUP_CACHE_SIZE      = 0
42136ac495dSmrg
42236ac495dSmrg#---------------------------------------------------------------------------
42336ac495dSmrg# Build related configuration options
42436ac495dSmrg#---------------------------------------------------------------------------
42536ac495dSmrg
4268feb0f0bSmrg# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
42736ac495dSmrg# documentation are documented, even if no documentation was available. Private
42836ac495dSmrg# class members and static file members will be hidden unless the
42936ac495dSmrg# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
43036ac495dSmrg# Note: This will also disable the warnings about undocumented members that are
43136ac495dSmrg# normally produced when WARNINGS is set to YES.
43236ac495dSmrg# The default value is: NO.
43336ac495dSmrg
43436ac495dSmrgEXTRACT_ALL            = NO
43536ac495dSmrg
4368feb0f0bSmrg# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
43736ac495dSmrg# be included in the documentation.
43836ac495dSmrg# The default value is: NO.
43936ac495dSmrg
44036ac495dSmrgEXTRACT_PRIVATE        = NO
44136ac495dSmrg
4428feb0f0bSmrg# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
44336ac495dSmrg# scope will be included in the documentation.
44436ac495dSmrg# The default value is: NO.
44536ac495dSmrg
44636ac495dSmrgEXTRACT_PACKAGE        = NO
44736ac495dSmrg
4488feb0f0bSmrg# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
44936ac495dSmrg# included in the documentation.
45036ac495dSmrg# The default value is: NO.
45136ac495dSmrg
45236ac495dSmrgEXTRACT_STATIC         = YES
45336ac495dSmrg
4548feb0f0bSmrg# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
4558feb0f0bSmrg# locally in source files will be included in the documentation. If set to NO,
45636ac495dSmrg# only classes defined in header files are included. Does not have any effect
45736ac495dSmrg# for Java sources.
45836ac495dSmrg# The default value is: YES.
45936ac495dSmrg
46036ac495dSmrgEXTRACT_LOCAL_CLASSES  = YES
46136ac495dSmrg
4628feb0f0bSmrg# This flag is only useful for Objective-C code. If set to YES, local methods,
46336ac495dSmrg# which are defined in the implementation section but not in the interface are
4648feb0f0bSmrg# included in the documentation. If set to NO, only methods in the interface are
46536ac495dSmrg# included.
46636ac495dSmrg# The default value is: NO.
46736ac495dSmrg
46836ac495dSmrgEXTRACT_LOCAL_METHODS  = YES
46936ac495dSmrg
47036ac495dSmrg# If this flag is set to YES, the members of anonymous namespaces will be
47136ac495dSmrg# extracted and appear in the documentation as a namespace called
47236ac495dSmrg# 'anonymous_namespace{file}', where file will be replaced with the base name of
47336ac495dSmrg# the file that contains the anonymous namespace. By default anonymous namespace
47436ac495dSmrg# are hidden.
47536ac495dSmrg# The default value is: NO.
47636ac495dSmrg
47736ac495dSmrgEXTRACT_ANON_NSPACES   = NO
47836ac495dSmrg
47936ac495dSmrg# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
48036ac495dSmrg# undocumented members inside documented classes or files. If set to NO these
48136ac495dSmrg# members will be included in the various overviews, but no documentation
48236ac495dSmrg# section is generated. This option has no effect if EXTRACT_ALL is enabled.
48336ac495dSmrg# The default value is: NO.
48436ac495dSmrg
48536ac495dSmrgHIDE_UNDOC_MEMBERS     = NO
48636ac495dSmrg
48736ac495dSmrg# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
48836ac495dSmrg# undocumented classes that are normally visible in the class hierarchy. If set
4898feb0f0bSmrg# to NO, these classes will be included in the various overviews. This option
4908feb0f0bSmrg# has no effect if EXTRACT_ALL is enabled.
49136ac495dSmrg# The default value is: NO.
49236ac495dSmrg
49336ac495dSmrgHIDE_UNDOC_CLASSES     = YES
49436ac495dSmrg
49536ac495dSmrg# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
4968feb0f0bSmrg# (class|struct|union) declarations. If set to NO, these declarations will be
49736ac495dSmrg# included in the documentation.
49836ac495dSmrg# The default value is: NO.
49936ac495dSmrg
50036ac495dSmrgHIDE_FRIEND_COMPOUNDS  = NO
50136ac495dSmrg
50236ac495dSmrg# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
5038feb0f0bSmrg# documentation blocks found inside the body of a function. If set to NO, these
50436ac495dSmrg# blocks will be appended to the function's detailed documentation block.
50536ac495dSmrg# The default value is: NO.
50636ac495dSmrg
50736ac495dSmrgHIDE_IN_BODY_DOCS      = NO
50836ac495dSmrg
50936ac495dSmrg# The INTERNAL_DOCS tag determines if documentation that is typed after a
51036ac495dSmrg# \internal command is included. If the tag is set to NO then the documentation
51136ac495dSmrg# will be excluded. Set it to YES to include the internal documentation.
51236ac495dSmrg# The default value is: NO.
51336ac495dSmrg
51436ac495dSmrgINTERNAL_DOCS          = NO
51536ac495dSmrg
51636ac495dSmrg# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
5178feb0f0bSmrg# names in lower-case letters. If set to YES, upper-case letters are also
51836ac495dSmrg# allowed. This is useful if you have classes or files whose names only differ
51936ac495dSmrg# in case and if your file system supports case sensitive file names. Windows
52036ac495dSmrg# and Mac users are advised to set this option to NO.
52136ac495dSmrg# The default value is: system dependent.
52236ac495dSmrg
52336ac495dSmrgCASE_SENSE_NAMES       = NO
52436ac495dSmrg
52536ac495dSmrg# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
5268feb0f0bSmrg# their full class and namespace scopes in the documentation. If set to YES, the
52736ac495dSmrg# scope will be hidden.
52836ac495dSmrg# The default value is: NO.
52936ac495dSmrg
53036ac495dSmrgHIDE_SCOPE_NAMES       = NO
53136ac495dSmrg
5328feb0f0bSmrg# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
5338feb0f0bSmrg# append additional text to a page's title, such as Class Reference. If set to
5348feb0f0bSmrg# YES the compound reference will be hidden.
5358feb0f0bSmrg# The default value is: NO.
5368feb0f0bSmrg
5378feb0f0bSmrgHIDE_COMPOUND_REFERENCE= NO
5388feb0f0bSmrg
53936ac495dSmrg# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
54036ac495dSmrg# the files that are included by a file in the documentation of that file.
54136ac495dSmrg# The default value is: YES.
54236ac495dSmrg
54336ac495dSmrgSHOW_INCLUDE_FILES     = NO
54436ac495dSmrg
54536ac495dSmrg# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
54636ac495dSmrg# grouped member an include statement to the documentation, telling the reader
54736ac495dSmrg# which file to include in order to use the member.
54836ac495dSmrg# The default value is: NO.
54936ac495dSmrg
55036ac495dSmrgSHOW_GROUPED_MEMB_INC  = NO
55136ac495dSmrg
55236ac495dSmrg# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
55336ac495dSmrg# files with double quotes in the documentation rather than with sharp brackets.
55436ac495dSmrg# The default value is: NO.
55536ac495dSmrg
55636ac495dSmrgFORCE_LOCAL_INCLUDES   = NO
55736ac495dSmrg
55836ac495dSmrg# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
55936ac495dSmrg# documentation for inline members.
56036ac495dSmrg# The default value is: YES.
56136ac495dSmrg
56236ac495dSmrgINLINE_INFO            = YES
56336ac495dSmrg
56436ac495dSmrg# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
56536ac495dSmrg# (detailed) documentation of file and class members alphabetically by member
5668feb0f0bSmrg# name. If set to NO, the members will appear in declaration order.
56736ac495dSmrg# The default value is: YES.
56836ac495dSmrg
56936ac495dSmrgSORT_MEMBER_DOCS       = YES
57036ac495dSmrg
57136ac495dSmrg# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
57236ac495dSmrg# descriptions of file, namespace and class members alphabetically by member
5738feb0f0bSmrg# name. If set to NO, the members will appear in declaration order. Note that
57436ac495dSmrg# this will also influence the order of the classes in the class list.
57536ac495dSmrg# The default value is: NO.
57636ac495dSmrg
57736ac495dSmrgSORT_BRIEF_DOCS        = YES
57836ac495dSmrg
57936ac495dSmrg# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
58036ac495dSmrg# (brief and detailed) documentation of class members so that constructors and
58136ac495dSmrg# destructors are listed first. If set to NO the constructors will appear in the
58236ac495dSmrg# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
58336ac495dSmrg# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
58436ac495dSmrg# member documentation.
58536ac495dSmrg# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
58636ac495dSmrg# detailed member documentation.
58736ac495dSmrg# The default value is: NO.
58836ac495dSmrg
58936ac495dSmrgSORT_MEMBERS_CTORS_1ST = YES
59036ac495dSmrg
59136ac495dSmrg# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
59236ac495dSmrg# of group names into alphabetical order. If set to NO the group names will
59336ac495dSmrg# appear in their defined order.
59436ac495dSmrg# The default value is: NO.
59536ac495dSmrg
59636ac495dSmrgSORT_GROUP_NAMES       = YES
59736ac495dSmrg
59836ac495dSmrg# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
59936ac495dSmrg# fully-qualified names, including namespaces. If set to NO, the class list will
60036ac495dSmrg# be sorted only by class name, not including the namespace part.
60136ac495dSmrg# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
60236ac495dSmrg# Note: This option applies only to the class list, not to the alphabetical
60336ac495dSmrg# list.
60436ac495dSmrg# The default value is: NO.
60536ac495dSmrg
6068feb0f0bSmrgSORT_BY_SCOPE_NAME     = NO
60736ac495dSmrg
60836ac495dSmrg# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
60936ac495dSmrg# type resolution of all parameters of a function it will reject a match between
61036ac495dSmrg# the prototype and the implementation of a member function even if there is
61136ac495dSmrg# only one candidate or it is obvious which candidate to choose by doing a
61236ac495dSmrg# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
61336ac495dSmrg# accept a match between prototype and implementation in such cases.
61436ac495dSmrg# The default value is: NO.
61536ac495dSmrg
61636ac495dSmrgSTRICT_PROTO_MATCHING  = NO
61736ac495dSmrg
6188feb0f0bSmrg# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
6198feb0f0bSmrg# list. This list is created by putting \todo commands in the documentation.
62036ac495dSmrg# The default value is: YES.
62136ac495dSmrg
62236ac495dSmrgGENERATE_TODOLIST      = YES
62336ac495dSmrg
6248feb0f0bSmrg# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
6258feb0f0bSmrg# list. This list is created by putting \test commands in the documentation.
62636ac495dSmrg# The default value is: YES.
62736ac495dSmrg
62836ac495dSmrgGENERATE_TESTLIST      = NO
62936ac495dSmrg
63036ac495dSmrg# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
63136ac495dSmrg# list. This list is created by putting \bug commands in the documentation.
63236ac495dSmrg# The default value is: YES.
63336ac495dSmrg
63436ac495dSmrgGENERATE_BUGLIST       = YES
63536ac495dSmrg
63636ac495dSmrg# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
63736ac495dSmrg# the deprecated list. This list is created by putting \deprecated commands in
63836ac495dSmrg# the documentation.
63936ac495dSmrg# The default value is: YES.
64036ac495dSmrg
64136ac495dSmrgGENERATE_DEPRECATEDLIST= YES
64236ac495dSmrg
64336ac495dSmrg# The ENABLED_SECTIONS tag can be used to enable conditional documentation
64436ac495dSmrg# sections, marked by \if <section_label> ... \endif and \cond <section_label>
64536ac495dSmrg# ... \endcond blocks.
64636ac495dSmrg
64736ac495dSmrgENABLED_SECTIONS       = @enabled_sections@
64836ac495dSmrg
64936ac495dSmrg# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
65036ac495dSmrg# initial value of a variable or macro / define can have for it to appear in the
65136ac495dSmrg# documentation. If the initializer consists of more lines than specified here
65236ac495dSmrg# it will be hidden. Use a value of 0 to hide initializers completely. The
65336ac495dSmrg# appearance of the value of individual variables and macros / defines can be
65436ac495dSmrg# controlled using \showinitializer or \hideinitializer command in the
65536ac495dSmrg# documentation regardless of this setting.
65636ac495dSmrg# Minimum value: 0, maximum value: 10000, default value: 30.
65736ac495dSmrg
65836ac495dSmrgMAX_INITIALIZER_LINES  = 0
65936ac495dSmrg
66036ac495dSmrg# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
6618feb0f0bSmrg# the bottom of the documentation of classes and structs. If set to YES, the
6628feb0f0bSmrg# list will mention the files that were used to generate the documentation.
66336ac495dSmrg# The default value is: YES.
66436ac495dSmrg
66536ac495dSmrgSHOW_USED_FILES        = YES
66636ac495dSmrg
66736ac495dSmrg# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
66836ac495dSmrg# will remove the Files entry from the Quick Index and from the Folder Tree View
66936ac495dSmrg# (if specified).
67036ac495dSmrg# The default value is: YES.
67136ac495dSmrg
67236ac495dSmrgSHOW_FILES             = YES
67336ac495dSmrg
67436ac495dSmrg# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
67536ac495dSmrg# page. This will remove the Namespaces entry from the Quick Index and from the
67636ac495dSmrg# Folder Tree View (if specified).
67736ac495dSmrg# The default value is: YES.
67836ac495dSmrg
67936ac495dSmrgSHOW_NAMESPACES        = YES
68036ac495dSmrg
68136ac495dSmrg# The FILE_VERSION_FILTER tag can be used to specify a program or script that
68236ac495dSmrg# doxygen should invoke to get the current version for each file (typically from
68336ac495dSmrg# the version control system). Doxygen will invoke the program by executing (via
68436ac495dSmrg# popen()) the command command input-file, where command is the value of the
68536ac495dSmrg# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
68636ac495dSmrg# by doxygen. Whatever the program writes to standard output is used as the file
68736ac495dSmrg# version. For an example see the documentation.
68836ac495dSmrg
68936ac495dSmrgFILE_VERSION_FILTER    =
69036ac495dSmrg
69136ac495dSmrg# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
69236ac495dSmrg# by doxygen. The layout file controls the global structure of the generated
69336ac495dSmrg# output files in an output format independent way. To create the layout file
69436ac495dSmrg# that represents doxygen's defaults, run doxygen with the -l option. You can
69536ac495dSmrg# optionally specify a file name after the option, if omitted DoxygenLayout.xml
69636ac495dSmrg# will be used as the name of the layout file.
69736ac495dSmrg#
69836ac495dSmrg# Note that if you run doxygen from a directory containing a file called
69936ac495dSmrg# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
70036ac495dSmrg# tag is left empty.
70136ac495dSmrg
70236ac495dSmrgLAYOUT_FILE            =
70336ac495dSmrg
70436ac495dSmrg# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
70536ac495dSmrg# the reference definitions. This must be a list of .bib files. The .bib
70636ac495dSmrg# extension is automatically appended if omitted. This requires the bibtex tool
7078feb0f0bSmrg# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
70836ac495dSmrg# For LaTeX the style of the bibliography can be controlled using
70936ac495dSmrg# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
7108feb0f0bSmrg# search path. See also \cite for info how to create references.
71136ac495dSmrg
71236ac495dSmrgCITE_BIB_FILES         =
71336ac495dSmrg
71436ac495dSmrg#---------------------------------------------------------------------------
71536ac495dSmrg# Configuration options related to warning and progress messages
71636ac495dSmrg#---------------------------------------------------------------------------
71736ac495dSmrg
71836ac495dSmrg# The QUIET tag can be used to turn on/off the messages that are generated to
71936ac495dSmrg# standard output by doxygen. If QUIET is set to YES this implies that the
72036ac495dSmrg# messages are off.
72136ac495dSmrg# The default value is: NO.
72236ac495dSmrg
72336ac495dSmrgQUIET                  = YES
72436ac495dSmrg
72536ac495dSmrg# The WARNINGS tag can be used to turn on/off the warning messages that are
72636ac495dSmrg# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
72736ac495dSmrg# this implies that the warnings are on.
72836ac495dSmrg#
72936ac495dSmrg# Tip: Turn warnings on while writing the documentation.
73036ac495dSmrg# The default value is: YES.
73136ac495dSmrg
73236ac495dSmrgWARNINGS               = YES
73336ac495dSmrg
7348feb0f0bSmrg# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
73536ac495dSmrg# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
73636ac495dSmrg# will automatically be disabled.
73736ac495dSmrg# The default value is: YES.
73836ac495dSmrg
73936ac495dSmrgWARN_IF_UNDOCUMENTED   = NO
74036ac495dSmrg
74136ac495dSmrg# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
74236ac495dSmrg# potential errors in the documentation, such as not documenting some parameters
74336ac495dSmrg# in a documented function, or documenting parameters that don't exist or using
74436ac495dSmrg# markup commands wrongly.
74536ac495dSmrg# The default value is: YES.
74636ac495dSmrg
74736ac495dSmrgWARN_IF_DOC_ERROR      = YES
74836ac495dSmrg
74936ac495dSmrg# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
75036ac495dSmrg# are documented, but have no documentation for their parameters or return
7518feb0f0bSmrg# value. If set to NO, doxygen will only warn about wrong or incomplete
7528feb0f0bSmrg# parameter documentation, but not about the absence of documentation.
75336ac495dSmrg# The default value is: NO.
75436ac495dSmrg
75536ac495dSmrgWARN_NO_PARAMDOC       = NO
75636ac495dSmrg
7578feb0f0bSmrg# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
7588feb0f0bSmrg# a warning is encountered.
7598feb0f0bSmrg# The default value is: NO.
7608feb0f0bSmrg
7618feb0f0bSmrgWARN_AS_ERROR          = NO
7628feb0f0bSmrg
76336ac495dSmrg# The WARN_FORMAT tag determines the format of the warning messages that doxygen
76436ac495dSmrg# can produce. The string should contain the $file, $line, and $text tags, which
76536ac495dSmrg# will be replaced by the file and line number from which the warning originated
76636ac495dSmrg# and the warning text. Optionally the format may contain $version, which will
76736ac495dSmrg# be replaced by the version of the file (if it could be obtained via
76836ac495dSmrg# FILE_VERSION_FILTER)
76936ac495dSmrg# The default value is: $file:$line: $text.
77036ac495dSmrg
77136ac495dSmrgWARN_FORMAT            = "$file:$line: $text  "
77236ac495dSmrg
77336ac495dSmrg# The WARN_LOGFILE tag can be used to specify a file to which warning and error
77436ac495dSmrg# messages should be written. If left blank the output is written to standard
77536ac495dSmrg# error (stderr).
77636ac495dSmrg
77736ac495dSmrgWARN_LOGFILE           =
77836ac495dSmrg
77936ac495dSmrg#---------------------------------------------------------------------------
78036ac495dSmrg# Configuration options related to the input files
78136ac495dSmrg#---------------------------------------------------------------------------
78236ac495dSmrg
78336ac495dSmrg# The INPUT tag is used to specify the files and/or directories that contain
78436ac495dSmrg# documented source files. You may enter file names like myfile.cpp or
78536ac495dSmrg# directories like /usr/src/myproject. Separate the files or directories with
7868feb0f0bSmrg# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
78736ac495dSmrg# Note: If this tag is empty the current directory is searched.
78836ac495dSmrg
789*23f5f463Smrg# N.B. update STRIP_FROM_PATH to sanitize paths outside the build tree.
79036ac495dSmrgINPUT                  = @srcdir@/doc/doxygen/doxygroups.cc \
7918feb0f0bSmrg                         @srcdir@/libsupc++/compare \
79236ac495dSmrg                         @srcdir@/libsupc++/cxxabi.h \
79336ac495dSmrg                         @srcdir@/libsupc++/exception \
79436ac495dSmrg                         @srcdir@/libsupc++/initializer_list \
79536ac495dSmrg                         @srcdir@/libsupc++/new \
79636ac495dSmrg                         @srcdir@/libsupc++/typeinfo \
79736ac495dSmrg                         include/algorithm \
7988feb0f0bSmrg                         include/any \
79936ac495dSmrg                         include/array \
80036ac495dSmrg                         include/atomic \
8018feb0f0bSmrg                         include/bit \
80236ac495dSmrg                         include/bitset \
8038feb0f0bSmrg                         include/charconv \
80436ac495dSmrg                         include/chrono \
80536ac495dSmrg                         include/codecvt \
8068feb0f0bSmrg                         include/complex \
8078feb0f0bSmrg                         include/concepts \
80836ac495dSmrg                         include/condition_variable \
80936ac495dSmrg                         include/deque \
8108feb0f0bSmrg                         include/filesystem \
81136ac495dSmrg                         include/forward_list \
81236ac495dSmrg                         include/fstream \
81336ac495dSmrg                         include/functional \
81436ac495dSmrg                         include/future \
81536ac495dSmrg                         include/iomanip \
81636ac495dSmrg                         include/ios \
81736ac495dSmrg                         include/iosfwd \
81836ac495dSmrg                         include/iostream \
81936ac495dSmrg                         include/istream \
82036ac495dSmrg                         include/iterator \
82136ac495dSmrg                         include/limits \
82236ac495dSmrg                         include/list \
82336ac495dSmrg                         include/locale \
82436ac495dSmrg                         include/map \
82536ac495dSmrg                         include/memory \
8268feb0f0bSmrg                         include/memory_resource \
82736ac495dSmrg                         include/mutex \
82836ac495dSmrg                         include/numeric \
8298feb0f0bSmrg                         include/numbers \
8308feb0f0bSmrg                         include/optional \
83136ac495dSmrg                         include/ostream \
83236ac495dSmrg                         include/queue \
83336ac495dSmrg                         include/random \
8348feb0f0bSmrg                         include/ranges \
83536ac495dSmrg                         include/ratio \
83636ac495dSmrg                         include/regex \
83736ac495dSmrg                         include/scoped_allocator \
83836ac495dSmrg                         include/set \
83936ac495dSmrg                         include/shared_mutex \
8408feb0f0bSmrg                         include/span \
84136ac495dSmrg                         include/sstream \
84236ac495dSmrg                         include/stack \
84336ac495dSmrg                         include/stdexcept \
8448feb0f0bSmrg                         include/stop_token \
84536ac495dSmrg                         include/streambuf \
84636ac495dSmrg                         include/string \
8478feb0f0bSmrg                         include/string_view \
84836ac495dSmrg                         include/system_error \
84936ac495dSmrg                         include/thread \
85036ac495dSmrg                         include/tuple \
85136ac495dSmrg                         include/typeindex \
85236ac495dSmrg                         include/type_traits \
85336ac495dSmrg                         include/unordered_map \
85436ac495dSmrg                         include/unordered_set \
85536ac495dSmrg                         include/utility \
85636ac495dSmrg                         include/valarray \
8578feb0f0bSmrg                         include/variant \
85836ac495dSmrg                         include/vector \
85936ac495dSmrg                         include/cassert \
86036ac495dSmrg                         include/ccomplex \
86136ac495dSmrg                         include/cctype \
86236ac495dSmrg                         include/cerrno \
86336ac495dSmrg                         include/cfenv \
86436ac495dSmrg                         include/cfloat \
86536ac495dSmrg                         include/cinttypes \
86636ac495dSmrg                         include/ciso646 \
86736ac495dSmrg                         include/climits \
86836ac495dSmrg                         include/clocale \
86936ac495dSmrg                         include/cmath \
87036ac495dSmrg                         include/csetjmp \
87136ac495dSmrg                         include/csignal \
87236ac495dSmrg                         include/cstdalign \
87336ac495dSmrg                         include/cstdarg \
87436ac495dSmrg                         include/cstdbool \
87536ac495dSmrg                         include/cstddef \
87636ac495dSmrg                         include/cstdint \
87736ac495dSmrg                         include/cstdio \
87836ac495dSmrg                         include/cstdlib \
87936ac495dSmrg                         include/cstring \
88036ac495dSmrg                         include/ctgmath \
88136ac495dSmrg                         include/ctime \
88236ac495dSmrg                         include/cwchar \
88336ac495dSmrg                         include/cuchar \
88436ac495dSmrg                         include/cwctype \
88536ac495dSmrg                         include/ \
88636ac495dSmrg                         include/bits \
88736ac495dSmrg                         include/@host_alias@/bits \
88836ac495dSmrg                         include/backward \
88936ac495dSmrg                         include/backward/hash_map \
89036ac495dSmrg                         include/backward/hash_set \
89136ac495dSmrg                         include/backward/strstream \
89236ac495dSmrg                         include/debug \
89336ac495dSmrg                         include/debug/array \
89436ac495dSmrg                         include/debug/bitset \
89536ac495dSmrg                         include/debug/deque \
89636ac495dSmrg                         include/debug/forward_list \
89736ac495dSmrg                         include/debug/list \
89836ac495dSmrg                         include/debug/map \
89936ac495dSmrg                         include/debug/set \
90036ac495dSmrg                         include/debug/string \
90136ac495dSmrg                         include/debug/unordered_map \
90236ac495dSmrg                         include/debug/unordered_set \
90336ac495dSmrg                         include/debug/vector \
90436ac495dSmrg                         include/ext/algorithm \
90536ac495dSmrg                         include/ext/cmath \
90636ac495dSmrg                         include/ext/functional \
90736ac495dSmrg                         include/ext/iterator \
90836ac495dSmrg                         include/ext/memory \
90936ac495dSmrg                         include/ext/numeric \
91036ac495dSmrg                         include/ext/rb_tree \
91136ac495dSmrg                         include/ext/rope \
91236ac495dSmrg                         include/ext/slist \
91336ac495dSmrg                         include/parallel \
91436ac495dSmrg                         include/parallel/algorithm \
91536ac495dSmrg                         include/parallel/numeric \
91636ac495dSmrg                         include/tr1/ccomplex \
91736ac495dSmrg                         include/tr1/cctype \
91836ac495dSmrg                         include/tr1/cfenv \
91936ac495dSmrg                         include/tr1/cfloat \
92036ac495dSmrg                         include/tr1/cinttypes \
92136ac495dSmrg                         include/tr1/climits \
92236ac495dSmrg                         include/tr1/cmath \
92336ac495dSmrg                         include/tr1/complex \
92436ac495dSmrg                         include/tr1/cstdarg \
92536ac495dSmrg                         include/tr1/cstdbool \
92636ac495dSmrg                         include/tr1/cstdint \
92736ac495dSmrg                         include/tr1/cstdio \
92836ac495dSmrg                         include/tr1/cstdlib \
92936ac495dSmrg                         include/tr1/ctgmath \
93036ac495dSmrg                         include/tr1/ctime \
93136ac495dSmrg                         include/tr1/cwchar \
93236ac495dSmrg                         include/tr1/cwctype \
93336ac495dSmrg                         include/tr2/ \
93436ac495dSmrg                         include/tr2/bool_set \
93536ac495dSmrg                         include/tr2/dynamic_bitset \
93636ac495dSmrg                         include/tr2/ratio \
93736ac495dSmrg                         include/tr2/type_traits \
93836ac495dSmrg                         include/decimal/decimal \
93936ac495dSmrg                         include/experimental/bits \
94036ac495dSmrg                         include/experimental/algorithm \
94136ac495dSmrg                         include/experimental/any \
94236ac495dSmrg                         include/experimental/array \
94336ac495dSmrg                         include/experimental/chrono \
94436ac495dSmrg                         include/experimental/deque \
94536ac495dSmrg                         include/experimental/filesystem \
94636ac495dSmrg                         include/experimental/forward_list \
94736ac495dSmrg                         include/experimental/functional \
94836ac495dSmrg                         include/experimental/iterator \
94936ac495dSmrg                         include/experimental/list \
95036ac495dSmrg                         include/experimental/map \
95136ac495dSmrg                         include/experimental/memory \
95236ac495dSmrg                         include/experimental/memory_resource \
95336ac495dSmrg                         include/experimental/numeric \
95436ac495dSmrg                         include/experimental/optional \
95536ac495dSmrg                         include/experimental/propagate_const \
95636ac495dSmrg                         include/experimental/random \
95736ac495dSmrg                         include/experimental/ratio \
95836ac495dSmrg                         include/experimental/regex \
95936ac495dSmrg                         include/experimental/set \
96036ac495dSmrg                         include/experimental/string \
96136ac495dSmrg                         include/experimental/string_view \
96236ac495dSmrg                         include/experimental/system_error \
96336ac495dSmrg                         include/experimental/tuple \
96436ac495dSmrg                         include/experimental/type_traits \
96536ac495dSmrg                         include/experimental/unordered_map \
96636ac495dSmrg                         include/experimental/unordered_set \
96736ac495dSmrg                         include/experimental/utility \
96836ac495dSmrg                         include/experimental/vector \
96936ac495dSmrg                         include/ext \
97036ac495dSmrg                         include/ext/pb_ds \
97136ac495dSmrg                         include/ext/pb_ds/detail \
97236ac495dSmrg                         include/ext/pb_ds/detail/binary_heap_ \
97336ac495dSmrg                         include/ext/pb_ds/detail/binomial_heap_ \
97436ac495dSmrg                         include/ext/pb_ds/detail/binomial_heap_base_ \
97536ac495dSmrg                         include/ext/pb_ds/detail/bin_search_tree_ \
97636ac495dSmrg                         include/ext/pb_ds/detail/branch_policy \
97736ac495dSmrg                         include/ext/pb_ds/detail/cc_hash_table_map_ \
97836ac495dSmrg                         include/ext/pb_ds/detail/eq_fn \
97936ac495dSmrg                         include/ext/pb_ds/detail/gp_hash_table_map_ \
98036ac495dSmrg                         include/ext/pb_ds/detail/hash_fn \
98136ac495dSmrg                         include/ext/pb_ds/detail/left_child_next_sibling_heap_ \
98236ac495dSmrg                         include/ext/pb_ds/detail/list_update_map_ \
98336ac495dSmrg                         include/ext/pb_ds/detail/list_update_policy \
98436ac495dSmrg                         include/ext/pb_ds/detail/ov_tree_map_ \
98536ac495dSmrg                         include/ext/pb_ds/detail/pairing_heap_ \
98636ac495dSmrg                         include/ext/pb_ds/detail/pat_trie_ \
98736ac495dSmrg                         include/ext/pb_ds/detail/rb_tree_map_ \
98836ac495dSmrg                         include/ext/pb_ds/detail/rc_binomial_heap_ \
98936ac495dSmrg                         include/ext/pb_ds/detail/resize_policy \
99036ac495dSmrg                         include/ext/pb_ds/detail/splay_tree_ \
99136ac495dSmrg                         include/ext/pb_ds/detail/thin_heap_ \
99236ac495dSmrg                         include/ext/pb_ds/detail/tree_policy \
99336ac495dSmrg                         include/ext/pb_ds/detail/trie_policy \
99436ac495dSmrg                         include/ext/pb_ds/detail/unordered_iterator
99536ac495dSmrg
99636ac495dSmrg# This tag can be used to specify the character encoding of the source files
99736ac495dSmrg# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
99836ac495dSmrg# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
9998feb0f0bSmrg# documentation (see: https://www.gnu.org/software/libiconv/) for the list of
100036ac495dSmrg# possible encodings.
100136ac495dSmrg# The default value is: UTF-8.
100236ac495dSmrg
100336ac495dSmrgINPUT_ENCODING         = UTF-8
100436ac495dSmrg
100536ac495dSmrg# If the value of the INPUT tag contains directories, you can use the
100636ac495dSmrg# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
10078feb0f0bSmrg# *.h) to filter out the source-files in the directories.
10088feb0f0bSmrg#
10098feb0f0bSmrg# Note that for custom extensions or not directly supported extensions you also
10108feb0f0bSmrg# need to set EXTENSION_MAPPING for the extension otherwise the files are not
10118feb0f0bSmrg# read by doxygen.
10128feb0f0bSmrg#
10138feb0f0bSmrg# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
10148feb0f0bSmrg# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
10158feb0f0bSmrg# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
10168feb0f0bSmrg# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
10178feb0f0bSmrg# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
101836ac495dSmrg
101936ac495dSmrgFILE_PATTERNS          = *.h \
102036ac495dSmrg                         *.hpp \
102136ac495dSmrg                         *.tcc
102236ac495dSmrg
102336ac495dSmrg# The RECURSIVE tag can be used to specify whether or not subdirectories should
102436ac495dSmrg# be searched for input files as well.
102536ac495dSmrg# The default value is: NO.
102636ac495dSmrg
102736ac495dSmrgRECURSIVE              = NO
102836ac495dSmrg
102936ac495dSmrg# The EXCLUDE tag can be used to specify files and/or directories that should be
103036ac495dSmrg# excluded from the INPUT source files. This way you can easily exclude a
103136ac495dSmrg# subdirectory from a directory tree whose root is specified with the INPUT tag.
103236ac495dSmrg#
103336ac495dSmrg# Note that relative paths are relative to the directory from which doxygen is
103436ac495dSmrg# run.
103536ac495dSmrg
103636ac495dSmrgEXCLUDE                = Makefile
103736ac495dSmrg
103836ac495dSmrg# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
103936ac495dSmrg# directories that are symbolic links (a Unix file system feature) are excluded
104036ac495dSmrg# from the input.
104136ac495dSmrg# The default value is: NO.
104236ac495dSmrg
104336ac495dSmrgEXCLUDE_SYMLINKS       = NO
104436ac495dSmrg
104536ac495dSmrg# If the value of the INPUT tag contains directories, you can use the
104636ac495dSmrg# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
104736ac495dSmrg# certain files from those directories.
104836ac495dSmrg#
104936ac495dSmrg# Note that the wildcards are matched against the file with absolute path, so to
105036ac495dSmrg# exclude all test directories for example use the pattern */test/*
105136ac495dSmrg
105236ac495dSmrgEXCLUDE_PATTERNS       = stamp-* \
105336ac495dSmrg                         doxygroups.cc \
105436ac495dSmrg                         *.gch \
105536ac495dSmrg                         */.svn/*
105636ac495dSmrg
105736ac495dSmrg# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
105836ac495dSmrg# (namespaces, classes, functions, etc.) that should be excluded from the
105936ac495dSmrg# output. The symbol name can be a fully qualified name, a word, or if the
106036ac495dSmrg# wildcard * is used, a substring. Examples: ANamespace, AClass,
106136ac495dSmrg# AClass::ANamespace, ANamespace::*Test
106236ac495dSmrg#
106336ac495dSmrg# Note that the wildcards are matched against the file with absolute path, so to
106436ac495dSmrg# exclude all test directories use the pattern */test/*
106536ac495dSmrg
106636ac495dSmrgEXCLUDE_SYMBOLS        =
106736ac495dSmrg
106836ac495dSmrg# The EXAMPLE_PATH tag can be used to specify one or more files or directories
106936ac495dSmrg# that contain example code fragments that are included (see the \include
107036ac495dSmrg# command).
107136ac495dSmrg
107236ac495dSmrgEXAMPLE_PATH           =
107336ac495dSmrg
107436ac495dSmrg# If the value of the EXAMPLE_PATH tag contains directories, you can use the
107536ac495dSmrg# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
107636ac495dSmrg# *.h) to filter out the source-files in the directories. If left blank all
107736ac495dSmrg# files are included.
107836ac495dSmrg
107936ac495dSmrgEXAMPLE_PATTERNS       =
108036ac495dSmrg
108136ac495dSmrg# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
108236ac495dSmrg# searched for input files to be used with the \include or \dontinclude commands
108336ac495dSmrg# irrespective of the value of the RECURSIVE tag.
108436ac495dSmrg# The default value is: NO.
108536ac495dSmrg
108636ac495dSmrgEXAMPLE_RECURSIVE      = NO
108736ac495dSmrg
108836ac495dSmrg# The IMAGE_PATH tag can be used to specify one or more files or directories
108936ac495dSmrg# that contain images that are to be included in the documentation (see the
109036ac495dSmrg# \image command).
109136ac495dSmrg
109236ac495dSmrgIMAGE_PATH             =
109336ac495dSmrg
109436ac495dSmrg# The INPUT_FILTER tag can be used to specify a program that doxygen should
109536ac495dSmrg# invoke to filter for each input file. Doxygen will invoke the filter program
109636ac495dSmrg# by executing (via popen()) the command:
109736ac495dSmrg#
109836ac495dSmrg# <filter> <input-file>
109936ac495dSmrg#
110036ac495dSmrg# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
110136ac495dSmrg# name of an input file. Doxygen will then use the output that the filter
110236ac495dSmrg# program writes to standard output. If FILTER_PATTERNS is specified, this tag
110336ac495dSmrg# will be ignored.
110436ac495dSmrg#
110536ac495dSmrg# Note that the filter must not add or remove lines; it is applied before the
110636ac495dSmrg# code is scanned, but not when the output code is generated. If lines are added
110736ac495dSmrg# or removed, the anchors will not be placed correctly.
11088feb0f0bSmrg#
11098feb0f0bSmrg# Note that for custom extensions or not directly supported extensions you also
11108feb0f0bSmrg# need to set EXTENSION_MAPPING for the extension otherwise the files are not
11118feb0f0bSmrg# properly processed by doxygen.
111236ac495dSmrg
111336ac495dSmrgINPUT_FILTER           =
111436ac495dSmrg
111536ac495dSmrg# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
111636ac495dSmrg# basis. Doxygen will compare the file name with each pattern and apply the
111736ac495dSmrg# filter if there is a match. The filters are a list of the form: pattern=filter
111836ac495dSmrg# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
111936ac495dSmrg# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
112036ac495dSmrg# patterns match the file name, INPUT_FILTER is applied.
11218feb0f0bSmrg#
11228feb0f0bSmrg# Note that for custom extensions or not directly supported extensions you also
11238feb0f0bSmrg# need to set EXTENSION_MAPPING for the extension otherwise the files are not
11248feb0f0bSmrg# properly processed by doxygen.
112536ac495dSmrg
112636ac495dSmrgFILTER_PATTERNS        =
112736ac495dSmrg
112836ac495dSmrg# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
112936ac495dSmrg# INPUT_FILTER) will also be used to filter the input files that are used for
113036ac495dSmrg# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
113136ac495dSmrg# The default value is: NO.
113236ac495dSmrg
113336ac495dSmrgFILTER_SOURCE_FILES    = NO
113436ac495dSmrg
113536ac495dSmrg# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
113636ac495dSmrg# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
113736ac495dSmrg# it is also possible to disable source filtering for a specific pattern using
113836ac495dSmrg# *.ext= (so without naming a filter).
113936ac495dSmrg# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
114036ac495dSmrg
114136ac495dSmrgFILTER_SOURCE_PATTERNS =
114236ac495dSmrg
114336ac495dSmrg# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
114436ac495dSmrg# is part of the input, its contents will be placed on the main page
114536ac495dSmrg# (index.html). This can be useful if you have a project on for instance GitHub
114636ac495dSmrg# and want to reuse the introduction page also for the doxygen output.
114736ac495dSmrg
114836ac495dSmrgUSE_MDFILE_AS_MAINPAGE =
114936ac495dSmrg
115036ac495dSmrg#---------------------------------------------------------------------------
115136ac495dSmrg# Configuration options related to source browsing
115236ac495dSmrg#---------------------------------------------------------------------------
115336ac495dSmrg
115436ac495dSmrg# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
115536ac495dSmrg# generated. Documented entities will be cross-referenced with these sources.
115636ac495dSmrg#
115736ac495dSmrg# Note: To get rid of all source code in the generated output, make sure that
115836ac495dSmrg# also VERBATIM_HEADERS is set to NO.
115936ac495dSmrg# The default value is: NO.
116036ac495dSmrg
1161*23f5f463SmrgSOURCE_BROWSER         = @do_html@
116236ac495dSmrg
116336ac495dSmrg# Setting the INLINE_SOURCES tag to YES will include the body of functions,
116436ac495dSmrg# classes and enums directly into the documentation.
116536ac495dSmrg# The default value is: NO.
116636ac495dSmrg
116736ac495dSmrgINLINE_SOURCES         = NO
116836ac495dSmrg
116936ac495dSmrg# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
117036ac495dSmrg# special comment blocks from generated source code fragments. Normal C, C++ and
117136ac495dSmrg# Fortran comments will always remain visible.
117236ac495dSmrg# The default value is: YES.
117336ac495dSmrg
117436ac495dSmrgSTRIP_CODE_COMMENTS    = NO
117536ac495dSmrg
117636ac495dSmrg# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
117736ac495dSmrg# function all documented functions referencing it will be listed.
117836ac495dSmrg# The default value is: NO.
117936ac495dSmrg
118036ac495dSmrgREFERENCED_BY_RELATION = YES
118136ac495dSmrg
118236ac495dSmrg# If the REFERENCES_RELATION tag is set to YES then for each documented function
118336ac495dSmrg# all documented entities called/used by that function will be listed.
118436ac495dSmrg# The default value is: NO.
118536ac495dSmrg
118636ac495dSmrgREFERENCES_RELATION    = YES
118736ac495dSmrg
118836ac495dSmrg# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
11898feb0f0bSmrg# to YES then the hyperlinks from functions in REFERENCES_RELATION and
119036ac495dSmrg# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
119136ac495dSmrg# link to the documentation.
119236ac495dSmrg# The default value is: YES.
119336ac495dSmrg
119436ac495dSmrgREFERENCES_LINK_SOURCE = YES
119536ac495dSmrg
119636ac495dSmrg# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
119736ac495dSmrg# source code will show a tooltip with additional information such as prototype,
119836ac495dSmrg# brief description and links to the definition and documentation. Since this
119936ac495dSmrg# will make the HTML file larger and loading of large files a bit slower, you
120036ac495dSmrg# can opt to disable this feature.
120136ac495dSmrg# The default value is: YES.
120236ac495dSmrg# This tag requires that the tag SOURCE_BROWSER is set to YES.
120336ac495dSmrg
120436ac495dSmrgSOURCE_TOOLTIPS        = YES
120536ac495dSmrg
120636ac495dSmrg# If the USE_HTAGS tag is set to YES then the references to source code will
120736ac495dSmrg# point to the HTML generated by the htags(1) tool instead of doxygen built-in
120836ac495dSmrg# source browser. The htags tool is part of GNU's global source tagging system
12098feb0f0bSmrg# (see https://www.gnu.org/software/global/global.html). You will need version
121036ac495dSmrg# 4.8.6 or higher.
121136ac495dSmrg#
121236ac495dSmrg# To use it do the following:
121336ac495dSmrg# - Install the latest version of global
121436ac495dSmrg# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
121536ac495dSmrg# - Make sure the INPUT points to the root of the source tree
121636ac495dSmrg# - Run doxygen as normal
121736ac495dSmrg#
121836ac495dSmrg# Doxygen will invoke htags (and that will in turn invoke gtags), so these
121936ac495dSmrg# tools must be available from the command line (i.e. in the search path).
122036ac495dSmrg#
122136ac495dSmrg# The result: instead of the source browser generated by doxygen, the links to
122236ac495dSmrg# source code will now point to the output of htags.
122336ac495dSmrg# The default value is: NO.
122436ac495dSmrg# This tag requires that the tag SOURCE_BROWSER is set to YES.
122536ac495dSmrg
122636ac495dSmrgUSE_HTAGS              = NO
122736ac495dSmrg
122836ac495dSmrg# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
122936ac495dSmrg# verbatim copy of the header file for each class for which an include is
123036ac495dSmrg# specified. Set to NO to disable this.
123136ac495dSmrg# See also: Section \class.
123236ac495dSmrg# The default value is: YES.
123336ac495dSmrg
123436ac495dSmrgVERBATIM_HEADERS       = NO
123536ac495dSmrg
123636ac495dSmrg#---------------------------------------------------------------------------
123736ac495dSmrg# Configuration options related to the alphabetical class index
123836ac495dSmrg#---------------------------------------------------------------------------
123936ac495dSmrg
124036ac495dSmrg# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
124136ac495dSmrg# compounds will be generated. Enable this if the project contains a lot of
124236ac495dSmrg# classes, structs, unions or interfaces.
124336ac495dSmrg# The default value is: YES.
124436ac495dSmrg
124536ac495dSmrgALPHABETICAL_INDEX     = YES
124636ac495dSmrg
124736ac495dSmrg# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
124836ac495dSmrg# which the alphabetical index list will be split.
124936ac495dSmrg# Minimum value: 1, maximum value: 20, default value: 5.
125036ac495dSmrg# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
125136ac495dSmrg
125236ac495dSmrgCOLS_IN_ALPHA_INDEX    = 2
125336ac495dSmrg
125436ac495dSmrg# In case all classes in a project start with a common prefix, all classes will
125536ac495dSmrg# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
125636ac495dSmrg# can be used to specify a prefix (or a list of prefixes) that should be ignored
125736ac495dSmrg# while generating the index headers.
125836ac495dSmrg# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
125936ac495dSmrg
126036ac495dSmrgIGNORE_PREFIX          =
126136ac495dSmrg
126236ac495dSmrg#---------------------------------------------------------------------------
126336ac495dSmrg# Configuration options related to the HTML output
126436ac495dSmrg#---------------------------------------------------------------------------
126536ac495dSmrg
12668feb0f0bSmrg# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
126736ac495dSmrg# The default value is: YES.
126836ac495dSmrg
126936ac495dSmrgGENERATE_HTML          = @do_html@
127036ac495dSmrg
127136ac495dSmrg# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
127236ac495dSmrg# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
127336ac495dSmrg# it.
127436ac495dSmrg# The default directory is: html.
127536ac495dSmrg# This tag requires that the tag GENERATE_HTML is set to YES.
127636ac495dSmrg
127736ac495dSmrgHTML_OUTPUT            = html
127836ac495dSmrg
127936ac495dSmrg# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
128036ac495dSmrg# generated HTML page (for example: .htm, .php, .asp).
128136ac495dSmrg# The default value is: .html.
128236ac495dSmrg# This tag requires that the tag GENERATE_HTML is set to YES.
128336ac495dSmrg
128436ac495dSmrgHTML_FILE_EXTENSION    = .html
128536ac495dSmrg
128636ac495dSmrg# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
128736ac495dSmrg# each generated HTML page. If the tag is left blank doxygen will generate a
128836ac495dSmrg# standard header.
128936ac495dSmrg#
129036ac495dSmrg# To get valid HTML the header file that includes any scripts and style sheets
129136ac495dSmrg# that doxygen needs, which is dependent on the configuration options used (e.g.
129236ac495dSmrg# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
129336ac495dSmrg# default header using
129436ac495dSmrg# doxygen -w html new_header.html new_footer.html new_stylesheet.css
129536ac495dSmrg# YourConfigFile
129636ac495dSmrg# and then modify the file new_header.html. See also section "Doxygen usage"
129736ac495dSmrg# for information on how to generate the default header that doxygen normally
129836ac495dSmrg# uses.
129936ac495dSmrg# Note: The header is subject to change so you typically have to regenerate the
130036ac495dSmrg# default header when upgrading to a newer version of doxygen. For a description
130136ac495dSmrg# of the possible markers and block names see the documentation.
130236ac495dSmrg# This tag requires that the tag GENERATE_HTML is set to YES.
130336ac495dSmrg
130436ac495dSmrgHTML_HEADER            =
130536ac495dSmrg
130636ac495dSmrg# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
130736ac495dSmrg# generated HTML page. If the tag is left blank doxygen will generate a standard
130836ac495dSmrg# footer. See HTML_HEADER for more information on how to generate a default
130936ac495dSmrg# footer and what special commands can be used inside the footer. See also
131036ac495dSmrg# section "Doxygen usage" for information on how to generate the default footer
131136ac495dSmrg# that doxygen normally uses.
131236ac495dSmrg# This tag requires that the tag GENERATE_HTML is set to YES.
131336ac495dSmrg
131436ac495dSmrgHTML_FOOTER            =
131536ac495dSmrg
131636ac495dSmrg# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
131736ac495dSmrg# sheet that is used by each HTML page. It can be used to fine-tune the look of
131836ac495dSmrg# the HTML output. If left blank doxygen will generate a default style sheet.
131936ac495dSmrg# See also section "Doxygen usage" for information on how to generate the style
132036ac495dSmrg# sheet that doxygen normally uses.
132136ac495dSmrg# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
132236ac495dSmrg# it is more robust and this tag (HTML_STYLESHEET) will in the future become
132336ac495dSmrg# obsolete.
132436ac495dSmrg# This tag requires that the tag GENERATE_HTML is set to YES.
132536ac495dSmrg
132636ac495dSmrgHTML_STYLESHEET        =
132736ac495dSmrg
13288feb0f0bSmrg# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
13298feb0f0bSmrg# cascading style sheets that are included after the standard style sheets
133036ac495dSmrg# created by doxygen. Using this option one can overrule certain style aspects.
133136ac495dSmrg# This is preferred over using HTML_STYLESHEET since it does not replace the
13328feb0f0bSmrg# standard style sheet and is therefore more robust against future updates.
13338feb0f0bSmrg# Doxygen will copy the style sheet files to the output directory.
13348feb0f0bSmrg# Note: The order of the extra style sheet files is of importance (e.g. the last
13358feb0f0bSmrg# style sheet in the list overrules the setting of the previous ones in the
13368feb0f0bSmrg# list). For an example see the documentation.
133736ac495dSmrg# This tag requires that the tag GENERATE_HTML is set to YES.
133836ac495dSmrg
133936ac495dSmrgHTML_EXTRA_STYLESHEET  =
134036ac495dSmrg
134136ac495dSmrg# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
134236ac495dSmrg# other source files which should be copied to the HTML output directory. Note
134336ac495dSmrg# that these files will be copied to the base HTML output directory. Use the
134436ac495dSmrg# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
134536ac495dSmrg# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
134636ac495dSmrg# files will be copied as-is; there are no commands or markers available.
134736ac495dSmrg# This tag requires that the tag GENERATE_HTML is set to YES.
134836ac495dSmrg
134936ac495dSmrgHTML_EXTRA_FILES       =
135036ac495dSmrg
135136ac495dSmrg# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
135236ac495dSmrg# will adjust the colors in the style sheet and background images according to
135336ac495dSmrg# this color. Hue is specified as an angle on a colorwheel, see
13548feb0f0bSmrg# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
135536ac495dSmrg# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
135636ac495dSmrg# purple, and 360 is red again.
135736ac495dSmrg# Minimum value: 0, maximum value: 359, default value: 220.
135836ac495dSmrg# This tag requires that the tag GENERATE_HTML is set to YES.
135936ac495dSmrg
136036ac495dSmrgHTML_COLORSTYLE_HUE    = 220
136136ac495dSmrg
136236ac495dSmrg# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
136336ac495dSmrg# in the HTML output. For a value of 0 the output will use grayscales only. A
136436ac495dSmrg# value of 255 will produce the most vivid colors.
136536ac495dSmrg# Minimum value: 0, maximum value: 255, default value: 100.
136636ac495dSmrg# This tag requires that the tag GENERATE_HTML is set to YES.
136736ac495dSmrg
136836ac495dSmrgHTML_COLORSTYLE_SAT    = 100
136936ac495dSmrg
137036ac495dSmrg# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
137136ac495dSmrg# luminance component of the colors in the HTML output. Values below 100
137236ac495dSmrg# gradually make the output lighter, whereas values above 100 make the output
137336ac495dSmrg# darker. The value divided by 100 is the actual gamma applied, so 80 represents
137436ac495dSmrg# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
137536ac495dSmrg# change the gamma.
137636ac495dSmrg# Minimum value: 40, maximum value: 240, default value: 80.
137736ac495dSmrg# This tag requires that the tag GENERATE_HTML is set to YES.
137836ac495dSmrg
137936ac495dSmrgHTML_COLORSTYLE_GAMMA  = 80
138036ac495dSmrg
138136ac495dSmrg# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
138236ac495dSmrg# page will contain the date and time when the page was generated. Setting this
13838feb0f0bSmrg# to YES can help to show when doxygen was last run and thus if the
13848feb0f0bSmrg# documentation is up to date.
13858feb0f0bSmrg# The default value is: NO.
138636ac495dSmrg# This tag requires that the tag GENERATE_HTML is set to YES.
138736ac495dSmrg
138836ac495dSmrgHTML_TIMESTAMP         = NO
138936ac495dSmrg
13908feb0f0bSmrg# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
13918feb0f0bSmrg# documentation will contain a main index with vertical navigation menus that
13928feb0f0bSmrg# are dynamically created via Javascript. If disabled, the navigation index will
13938feb0f0bSmrg# consists of multiple levels of tabs that are statically embedded in every HTML
13948feb0f0bSmrg# page. Disable this option to support browsers that do not have Javascript,
13958feb0f0bSmrg# like the Qt help browser.
13968feb0f0bSmrg# The default value is: YES.
13978feb0f0bSmrg# This tag requires that the tag GENERATE_HTML is set to YES.
13988feb0f0bSmrg
13998feb0f0bSmrgHTML_DYNAMIC_MENUS     = YES
14008feb0f0bSmrg
140136ac495dSmrg# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
140236ac495dSmrg# documentation will contain sections that can be hidden and shown after the
140336ac495dSmrg# page has loaded.
140436ac495dSmrg# The default value is: NO.
140536ac495dSmrg# This tag requires that the tag GENERATE_HTML is set to YES.
140636ac495dSmrg
140736ac495dSmrgHTML_DYNAMIC_SECTIONS  = NO
140836ac495dSmrg
140936ac495dSmrg# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
141036ac495dSmrg# shown in the various tree structured indices initially; the user can expand
141136ac495dSmrg# and collapse entries dynamically later on. Doxygen will expand the tree to
141236ac495dSmrg# such a level that at most the specified number of entries are visible (unless
141336ac495dSmrg# a fully collapsed tree already exceeds this amount). So setting the number of
141436ac495dSmrg# entries 1 will produce a full collapsed tree by default. 0 is a special value
141536ac495dSmrg# representing an infinite number of entries and will result in a full expanded
141636ac495dSmrg# tree by default.
141736ac495dSmrg# Minimum value: 0, maximum value: 9999, default value: 100.
141836ac495dSmrg# This tag requires that the tag GENERATE_HTML is set to YES.
141936ac495dSmrg
142036ac495dSmrgHTML_INDEX_NUM_ENTRIES = 0
142136ac495dSmrg
142236ac495dSmrg# If the GENERATE_DOCSET tag is set to YES, additional index files will be
142336ac495dSmrg# generated that can be used as input for Apple's Xcode 3 integrated development
14248feb0f0bSmrg# environment (see: https://developer.apple.com/tools/xcode/), introduced with
142536ac495dSmrg# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
142636ac495dSmrg# Makefile in the HTML output directory. Running make will produce the docset in
142736ac495dSmrg# that directory and running make install will install the docset in
142836ac495dSmrg# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
14298feb0f0bSmrg# startup. See https://developer.apple.com/tools/creatingdocsetswithdoxygen.html
143036ac495dSmrg# for more information.
143136ac495dSmrg# The default value is: NO.
143236ac495dSmrg# This tag requires that the tag GENERATE_HTML is set to YES.
143336ac495dSmrg
143436ac495dSmrgGENERATE_DOCSET        = NO
143536ac495dSmrg
143636ac495dSmrg# This tag determines the name of the docset feed. A documentation feed provides
143736ac495dSmrg# an umbrella under which multiple documentation sets from a single provider
143836ac495dSmrg# (such as a company or product suite) can be grouped.
143936ac495dSmrg# The default value is: Doxygen generated docs.
144036ac495dSmrg# This tag requires that the tag GENERATE_DOCSET is set to YES.
144136ac495dSmrg
144236ac495dSmrgDOCSET_FEEDNAME        = "Doxygen generated docs"
144336ac495dSmrg
144436ac495dSmrg# This tag specifies a string that should uniquely identify the documentation
144536ac495dSmrg# set bundle. This should be a reverse domain-name style string, e.g.
144636ac495dSmrg# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
144736ac495dSmrg# The default value is: org.doxygen.Project.
144836ac495dSmrg# This tag requires that the tag GENERATE_DOCSET is set to YES.
144936ac495dSmrg
145036ac495dSmrgDOCSET_BUNDLE_ID       = org.gnu.libstdc++
145136ac495dSmrg
145236ac495dSmrg# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
145336ac495dSmrg# the documentation publisher. This should be a reverse domain-name style
145436ac495dSmrg# string, e.g. com.mycompany.MyDocSet.documentation.
145536ac495dSmrg# The default value is: org.doxygen.Publisher.
145636ac495dSmrg# This tag requires that the tag GENERATE_DOCSET is set to YES.
145736ac495dSmrg
145836ac495dSmrgDOCSET_PUBLISHER_ID    = org.fsf
145936ac495dSmrg
146036ac495dSmrg# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
146136ac495dSmrg# The default value is: Publisher.
146236ac495dSmrg# This tag requires that the tag GENERATE_DOCSET is set to YES.
146336ac495dSmrg
146436ac495dSmrgDOCSET_PUBLISHER_NAME  = libstdc++
146536ac495dSmrg
146636ac495dSmrg# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
146736ac495dSmrg# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
146836ac495dSmrg# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
146936ac495dSmrg# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
147036ac495dSmrg# Windows.
147136ac495dSmrg#
147236ac495dSmrg# The HTML Help Workshop contains a compiler that can convert all HTML output
147336ac495dSmrg# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
147436ac495dSmrg# files are now used as the Windows 98 help format, and will replace the old
147536ac495dSmrg# Windows help format (.hlp) on all Windows platforms in the future. Compressed
147636ac495dSmrg# HTML files also contain an index, a table of contents, and you can search for
147736ac495dSmrg# words in the documentation. The HTML workshop also contains a viewer for
147836ac495dSmrg# compressed HTML files.
147936ac495dSmrg# The default value is: NO.
148036ac495dSmrg# This tag requires that the tag GENERATE_HTML is set to YES.
148136ac495dSmrg
148236ac495dSmrgGENERATE_HTMLHELP      = NO
148336ac495dSmrg
148436ac495dSmrg# The CHM_FILE tag can be used to specify the file name of the resulting .chm
148536ac495dSmrg# file. You can add a path in front of the file if the result should not be
148636ac495dSmrg# written to the html output directory.
148736ac495dSmrg# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
148836ac495dSmrg
148936ac495dSmrgCHM_FILE               =
149036ac495dSmrg
149136ac495dSmrg# The HHC_LOCATION tag can be used to specify the location (absolute path
14928feb0f0bSmrg# including file name) of the HTML help compiler (hhc.exe). If non-empty,
149336ac495dSmrg# doxygen will try to run the HTML help compiler on the generated index.hhp.
149436ac495dSmrg# The file has to be specified with full path.
149536ac495dSmrg# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
149636ac495dSmrg
149736ac495dSmrgHHC_LOCATION           =
149836ac495dSmrg
14998feb0f0bSmrg# The GENERATE_CHI flag controls if a separate .chi index file is generated
15008feb0f0bSmrg# (YES) or that it should be included in the master .chm file (NO).
150136ac495dSmrg# The default value is: NO.
150236ac495dSmrg# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
150336ac495dSmrg
150436ac495dSmrgGENERATE_CHI           = NO
150536ac495dSmrg
150636ac495dSmrg# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
150736ac495dSmrg# and project file content.
150836ac495dSmrg# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
150936ac495dSmrg
151036ac495dSmrgCHM_INDEX_ENCODING     =
151136ac495dSmrg
15128feb0f0bSmrg# The BINARY_TOC flag controls whether a binary table of contents is generated
15138feb0f0bSmrg# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
15148feb0f0bSmrg# enables the Previous and Next buttons.
151536ac495dSmrg# The default value is: NO.
151636ac495dSmrg# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
151736ac495dSmrg
151836ac495dSmrgBINARY_TOC             = NO
151936ac495dSmrg
152036ac495dSmrg# The TOC_EXPAND flag can be set to YES to add extra items for group members to
152136ac495dSmrg# the table of contents of the HTML help documentation and to the tree view.
152236ac495dSmrg# The default value is: NO.
152336ac495dSmrg# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
152436ac495dSmrg
152536ac495dSmrgTOC_EXPAND             = NO
152636ac495dSmrg
152736ac495dSmrg# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
152836ac495dSmrg# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
152936ac495dSmrg# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
153036ac495dSmrg# (.qch) of the generated HTML documentation.
153136ac495dSmrg# The default value is: NO.
153236ac495dSmrg# This tag requires that the tag GENERATE_HTML is set to YES.
153336ac495dSmrg
153436ac495dSmrgGENERATE_QHP           = NO
153536ac495dSmrg
153636ac495dSmrg# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
153736ac495dSmrg# the file name of the resulting .qch file. The path specified is relative to
153836ac495dSmrg# the HTML output folder.
153936ac495dSmrg# This tag requires that the tag GENERATE_QHP is set to YES.
154036ac495dSmrg
154136ac495dSmrgQCH_FILE               =
154236ac495dSmrg
154336ac495dSmrg# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
154436ac495dSmrg# Project output. For more information please see Qt Help Project / Namespace
15458feb0f0bSmrg# (see: http://doc.qt.io/qt-4.8/qthelpproject.html#namespace).
154636ac495dSmrg# The default value is: org.doxygen.Project.
154736ac495dSmrg# This tag requires that the tag GENERATE_QHP is set to YES.
154836ac495dSmrg
154936ac495dSmrgQHP_NAMESPACE          = org.doxygen.Project
155036ac495dSmrg
155136ac495dSmrg# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
155236ac495dSmrg# Help Project output. For more information please see Qt Help Project / Virtual
15538feb0f0bSmrg# Folders (see: http://doc.qt.io/qt-4.8/qthelpproject.html#virtual-folders).
155436ac495dSmrg# The default value is: doc.
155536ac495dSmrg# This tag requires that the tag GENERATE_QHP is set to YES.
155636ac495dSmrg
155736ac495dSmrgQHP_VIRTUAL_FOLDER     = doc
155836ac495dSmrg
155936ac495dSmrg# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
156036ac495dSmrg# filter to add. For more information please see Qt Help Project / Custom
15618feb0f0bSmrg# Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters).
156236ac495dSmrg# This tag requires that the tag GENERATE_QHP is set to YES.
156336ac495dSmrg
156436ac495dSmrgQHP_CUST_FILTER_NAME   =
156536ac495dSmrg
156636ac495dSmrg# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
156736ac495dSmrg# custom filter to add. For more information please see Qt Help Project / Custom
15688feb0f0bSmrg# Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters).
156936ac495dSmrg# This tag requires that the tag GENERATE_QHP is set to YES.
157036ac495dSmrg
157136ac495dSmrgQHP_CUST_FILTER_ATTRS  =
157236ac495dSmrg
157336ac495dSmrg# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
157436ac495dSmrg# project's filter section matches. Qt Help Project / Filter Attributes (see:
15758feb0f0bSmrg# http://doc.qt.io/qt-4.8/qthelpproject.html#filter-attributes).
157636ac495dSmrg# This tag requires that the tag GENERATE_QHP is set to YES.
157736ac495dSmrg
157836ac495dSmrgQHP_SECT_FILTER_ATTRS  =
157936ac495dSmrg
158036ac495dSmrg# The QHG_LOCATION tag can be used to specify the location of Qt's
158136ac495dSmrg# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
158236ac495dSmrg# generated .qhp file.
158336ac495dSmrg# This tag requires that the tag GENERATE_QHP is set to YES.
158436ac495dSmrg
158536ac495dSmrgQHG_LOCATION           =
158636ac495dSmrg
158736ac495dSmrg# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
158836ac495dSmrg# generated, together with the HTML files, they form an Eclipse help plugin. To
158936ac495dSmrg# install this plugin and make it available under the help contents menu in
159036ac495dSmrg# Eclipse, the contents of the directory containing the HTML and XML files needs
159136ac495dSmrg# to be copied into the plugins directory of eclipse. The name of the directory
159236ac495dSmrg# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
159336ac495dSmrg# After copying Eclipse needs to be restarted before the help appears.
159436ac495dSmrg# The default value is: NO.
159536ac495dSmrg# This tag requires that the tag GENERATE_HTML is set to YES.
159636ac495dSmrg
159736ac495dSmrgGENERATE_ECLIPSEHELP   = NO
159836ac495dSmrg
159936ac495dSmrg# A unique identifier for the Eclipse help plugin. When installing the plugin
160036ac495dSmrg# the directory name containing the HTML and XML files should also have this
160136ac495dSmrg# name. Each documentation set should have its own identifier.
160236ac495dSmrg# The default value is: org.doxygen.Project.
160336ac495dSmrg# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
160436ac495dSmrg
160536ac495dSmrgECLIPSE_DOC_ID         = org.doxygen.Project
160636ac495dSmrg
160736ac495dSmrg# If you want full control over the layout of the generated HTML pages it might
160836ac495dSmrg# be necessary to disable the index and replace it with your own. The
160936ac495dSmrg# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
161036ac495dSmrg# of each HTML page. A value of NO enables the index and the value YES disables
161136ac495dSmrg# it. Since the tabs in the index contain the same information as the navigation
161236ac495dSmrg# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
161336ac495dSmrg# The default value is: NO.
161436ac495dSmrg# This tag requires that the tag GENERATE_HTML is set to YES.
161536ac495dSmrg
161636ac495dSmrgDISABLE_INDEX          = YES
161736ac495dSmrg
161836ac495dSmrg# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
161936ac495dSmrg# structure should be generated to display hierarchical information. If the tag
162036ac495dSmrg# value is set to YES, a side panel will be generated containing a tree-like
162136ac495dSmrg# index structure (just like the one that is generated for HTML Help). For this
162236ac495dSmrg# to work a browser that supports JavaScript, DHTML, CSS and frames is required
162336ac495dSmrg# (i.e. any modern browser). Windows users are probably better off using the
162436ac495dSmrg# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
162536ac495dSmrg# further fine-tune the look of the index. As an example, the default style
162636ac495dSmrg# sheet generated by doxygen has an example that shows how to put an image at
162736ac495dSmrg# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
162836ac495dSmrg# the same information as the tab index, you could consider setting
162936ac495dSmrg# DISABLE_INDEX to YES when enabling this option.
163036ac495dSmrg# The default value is: NO.
163136ac495dSmrg# This tag requires that the tag GENERATE_HTML is set to YES.
163236ac495dSmrg
163336ac495dSmrgGENERATE_TREEVIEW      = YES
163436ac495dSmrg
163536ac495dSmrg# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
163636ac495dSmrg# doxygen will group on one line in the generated HTML documentation.
163736ac495dSmrg#
163836ac495dSmrg# Note that a value of 0 will completely suppress the enum values from appearing
163936ac495dSmrg# in the overview section.
164036ac495dSmrg# Minimum value: 0, maximum value: 20, default value: 4.
164136ac495dSmrg# This tag requires that the tag GENERATE_HTML is set to YES.
164236ac495dSmrg
164336ac495dSmrgENUM_VALUES_PER_LINE   = 4
164436ac495dSmrg
164536ac495dSmrg# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
164636ac495dSmrg# to set the initial width (in pixels) of the frame in which the tree is shown.
164736ac495dSmrg# Minimum value: 0, maximum value: 1500, default value: 250.
164836ac495dSmrg# This tag requires that the tag GENERATE_HTML is set to YES.
164936ac495dSmrg
165036ac495dSmrgTREEVIEW_WIDTH         = 250
165136ac495dSmrg
16528feb0f0bSmrg# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
165336ac495dSmrg# external symbols imported via tag files in a separate window.
165436ac495dSmrg# The default value is: NO.
165536ac495dSmrg# This tag requires that the tag GENERATE_HTML is set to YES.
165636ac495dSmrg
165736ac495dSmrgEXT_LINKS_IN_WINDOW    = NO
165836ac495dSmrg
165936ac495dSmrg# Use this tag to change the font size of LaTeX formulas included as images in
166036ac495dSmrg# the HTML documentation. When you change the font size after a successful
166136ac495dSmrg# doxygen run you need to manually remove any form_*.png images from the HTML
166236ac495dSmrg# output directory to force them to be regenerated.
166336ac495dSmrg# Minimum value: 8, maximum value: 50, default value: 10.
166436ac495dSmrg# This tag requires that the tag GENERATE_HTML is set to YES.
166536ac495dSmrg
166636ac495dSmrgFORMULA_FONTSIZE       = 10
166736ac495dSmrg
16688feb0f0bSmrg# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
166936ac495dSmrg# generated for formulas are transparent PNGs. Transparent PNGs are not
167036ac495dSmrg# supported properly for IE 6.0, but are supported on all modern browsers.
167136ac495dSmrg#
167236ac495dSmrg# Note that when changing this option you need to delete any form_*.png files in
167336ac495dSmrg# the HTML output directory before the changes have effect.
167436ac495dSmrg# The default value is: YES.
167536ac495dSmrg# This tag requires that the tag GENERATE_HTML is set to YES.
167636ac495dSmrg
167736ac495dSmrgFORMULA_TRANSPARENT    = YES
167836ac495dSmrg
167936ac495dSmrg# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
16808feb0f0bSmrg# https://www.mathjax.org) which uses client side Javascript for the rendering
16818feb0f0bSmrg# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
168236ac495dSmrg# installed or if you want to formulas look prettier in the HTML output. When
168336ac495dSmrg# enabled you may also need to install MathJax separately and configure the path
168436ac495dSmrg# to it using the MATHJAX_RELPATH option.
168536ac495dSmrg# The default value is: NO.
168636ac495dSmrg# This tag requires that the tag GENERATE_HTML is set to YES.
168736ac495dSmrg
168836ac495dSmrgUSE_MATHJAX            = NO
168936ac495dSmrg
169036ac495dSmrg# When MathJax is enabled you can set the default output format to be used for
169136ac495dSmrg# the MathJax output. See the MathJax site (see:
169236ac495dSmrg# http://docs.mathjax.org/en/latest/output.html) for more details.
169336ac495dSmrg# Possible values are: HTML-CSS (which is slower, but has the best
169436ac495dSmrg# compatibility), NativeMML (i.e. MathML) and SVG.
169536ac495dSmrg# The default value is: HTML-CSS.
169636ac495dSmrg# This tag requires that the tag USE_MATHJAX is set to YES.
169736ac495dSmrg
169836ac495dSmrgMATHJAX_FORMAT         = HTML-CSS
169936ac495dSmrg
170036ac495dSmrg# When MathJax is enabled you need to specify the location relative to the HTML
170136ac495dSmrg# output directory using the MATHJAX_RELPATH option. The destination directory
170236ac495dSmrg# should contain the MathJax.js script. For instance, if the mathjax directory
170336ac495dSmrg# is located at the same level as the HTML output directory, then
170436ac495dSmrg# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
170536ac495dSmrg# Content Delivery Network so you can quickly see the result without installing
170636ac495dSmrg# MathJax. However, it is strongly recommended to install a local copy of
17078feb0f0bSmrg# MathJax from https://www.mathjax.org before deployment.
17088feb0f0bSmrg# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/.
170936ac495dSmrg# This tag requires that the tag USE_MATHJAX is set to YES.
171036ac495dSmrg
171136ac495dSmrgMATHJAX_RELPATH        = http://www.mathjax.org/mathjax
171236ac495dSmrg
171336ac495dSmrg# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
171436ac495dSmrg# extension names that should be enabled during MathJax rendering. For example
171536ac495dSmrg# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
171636ac495dSmrg# This tag requires that the tag USE_MATHJAX is set to YES.
171736ac495dSmrg
171836ac495dSmrgMATHJAX_EXTENSIONS     =
171936ac495dSmrg
172036ac495dSmrg# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
172136ac495dSmrg# of code that will be used on startup of the MathJax code. See the MathJax site
172236ac495dSmrg# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
172336ac495dSmrg# example see the documentation.
172436ac495dSmrg# This tag requires that the tag USE_MATHJAX is set to YES.
172536ac495dSmrg
172636ac495dSmrgMATHJAX_CODEFILE       =
172736ac495dSmrg
172836ac495dSmrg# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
172936ac495dSmrg# the HTML output. The underlying search engine uses javascript and DHTML and
173036ac495dSmrg# should work on any modern browser. Note that when using HTML help
173136ac495dSmrg# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
173236ac495dSmrg# there is already a search function so this one should typically be disabled.
173336ac495dSmrg# For large projects the javascript based search engine can be slow, then
173436ac495dSmrg# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
173536ac495dSmrg# search using the keyboard; to jump to the search box use <access key> + S
173636ac495dSmrg# (what the <access key> is depends on the OS and browser, but it is typically
173736ac495dSmrg# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
173836ac495dSmrg# key> to jump into the search results window, the results can be navigated
173936ac495dSmrg# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
174036ac495dSmrg# the search. The filter options can be selected when the cursor is inside the
174136ac495dSmrg# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
174236ac495dSmrg# to select a filter and <Enter> or <escape> to activate or cancel the filter
174336ac495dSmrg# option.
174436ac495dSmrg# The default value is: YES.
174536ac495dSmrg# This tag requires that the tag GENERATE_HTML is set to YES.
174636ac495dSmrg
174736ac495dSmrgSEARCHENGINE           = NO
174836ac495dSmrg
174936ac495dSmrg# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
175036ac495dSmrg# implemented using a web server instead of a web client using Javascript. There
17518feb0f0bSmrg# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
17528feb0f0bSmrg# setting. When disabled, doxygen will generate a PHP script for searching and
17538feb0f0bSmrg# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
17548feb0f0bSmrg# and searching needs to be provided by external tools. See the section
17558feb0f0bSmrg# "External Indexing and Searching" for details.
175636ac495dSmrg# The default value is: NO.
175736ac495dSmrg# This tag requires that the tag SEARCHENGINE is set to YES.
175836ac495dSmrg
175936ac495dSmrgSERVER_BASED_SEARCH    = NO
176036ac495dSmrg
176136ac495dSmrg# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
176236ac495dSmrg# script for searching. Instead the search results are written to an XML file
176336ac495dSmrg# which needs to be processed by an external indexer. Doxygen will invoke an
176436ac495dSmrg# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
176536ac495dSmrg# search results.
176636ac495dSmrg#
176736ac495dSmrg# Doxygen ships with an example indexer (doxyindexer) and search engine
176836ac495dSmrg# (doxysearch.cgi) which are based on the open source search engine library
17698feb0f0bSmrg# Xapian (see: https://xapian.org/).
177036ac495dSmrg#
177136ac495dSmrg# See the section "External Indexing and Searching" for details.
177236ac495dSmrg# The default value is: NO.
177336ac495dSmrg# This tag requires that the tag SEARCHENGINE is set to YES.
177436ac495dSmrg
177536ac495dSmrgEXTERNAL_SEARCH        = NO
177636ac495dSmrg
177736ac495dSmrg# The SEARCHENGINE_URL should point to a search engine hosted by a web server
177836ac495dSmrg# which will return the search results when EXTERNAL_SEARCH is enabled.
177936ac495dSmrg#
178036ac495dSmrg# Doxygen ships with an example indexer (doxyindexer) and search engine
178136ac495dSmrg# (doxysearch.cgi) which are based on the open source search engine library
17828feb0f0bSmrg# Xapian (see: https://xapian.org/). See the section "External Indexing and
178336ac495dSmrg# Searching" for details.
178436ac495dSmrg# This tag requires that the tag SEARCHENGINE is set to YES.
178536ac495dSmrg
178636ac495dSmrgSEARCHENGINE_URL       =
178736ac495dSmrg
178836ac495dSmrg# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
178936ac495dSmrg# search data is written to a file for indexing by an external tool. With the
179036ac495dSmrg# SEARCHDATA_FILE tag the name of this file can be specified.
179136ac495dSmrg# The default file is: searchdata.xml.
179236ac495dSmrg# This tag requires that the tag SEARCHENGINE is set to YES.
179336ac495dSmrg
179436ac495dSmrgSEARCHDATA_FILE        = searchdata.xml
179536ac495dSmrg
179636ac495dSmrg# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
179736ac495dSmrg# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
179836ac495dSmrg# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
179936ac495dSmrg# projects and redirect the results back to the right project.
180036ac495dSmrg# This tag requires that the tag SEARCHENGINE is set to YES.
180136ac495dSmrg
180236ac495dSmrgEXTERNAL_SEARCH_ID     =
180336ac495dSmrg
180436ac495dSmrg# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
180536ac495dSmrg# projects other than the one defined by this configuration file, but that are
180636ac495dSmrg# all added to the same external search index. Each project needs to have a
180736ac495dSmrg# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
180836ac495dSmrg# to a relative location where the documentation can be found. The format is:
180936ac495dSmrg# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
181036ac495dSmrg# This tag requires that the tag SEARCHENGINE is set to YES.
181136ac495dSmrg
181236ac495dSmrgEXTRA_SEARCH_MAPPINGS  =
181336ac495dSmrg
181436ac495dSmrg#---------------------------------------------------------------------------
181536ac495dSmrg# Configuration options related to the LaTeX output
181636ac495dSmrg#---------------------------------------------------------------------------
181736ac495dSmrg
18188feb0f0bSmrg# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
181936ac495dSmrg# The default value is: YES.
182036ac495dSmrg
182136ac495dSmrgGENERATE_LATEX         = @do_latex@
182236ac495dSmrg
182336ac495dSmrg# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
182436ac495dSmrg# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
182536ac495dSmrg# it.
182636ac495dSmrg# The default directory is: latex.
182736ac495dSmrg# This tag requires that the tag GENERATE_LATEX is set to YES.
182836ac495dSmrg
182936ac495dSmrgLATEX_OUTPUT           = latex
183036ac495dSmrg
183136ac495dSmrg# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
183236ac495dSmrg# invoked.
183336ac495dSmrg#
183436ac495dSmrg# Note that when enabling USE_PDFLATEX this option is only used for generating
183536ac495dSmrg# bitmaps for formulas in the HTML output, but not in the Makefile that is
183636ac495dSmrg# written to the output directory.
183736ac495dSmrg# The default file is: latex.
183836ac495dSmrg# This tag requires that the tag GENERATE_LATEX is set to YES.
183936ac495dSmrg
184036ac495dSmrgLATEX_CMD_NAME         =
184136ac495dSmrg
184236ac495dSmrg# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
184336ac495dSmrg# index for LaTeX.
184436ac495dSmrg# The default file is: makeindex.
184536ac495dSmrg# This tag requires that the tag GENERATE_LATEX is set to YES.
184636ac495dSmrg
184736ac495dSmrgMAKEINDEX_CMD_NAME     = makeindex
184836ac495dSmrg
18498feb0f0bSmrg# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
185036ac495dSmrg# documents. This may be useful for small projects and may help to save some
185136ac495dSmrg# trees in general.
185236ac495dSmrg# The default value is: NO.
185336ac495dSmrg# This tag requires that the tag GENERATE_LATEX is set to YES.
185436ac495dSmrg
185536ac495dSmrgCOMPACT_LATEX          = YES
185636ac495dSmrg
185736ac495dSmrg# The PAPER_TYPE tag can be used to set the paper type that is used by the
185836ac495dSmrg# printer.
185936ac495dSmrg# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
186036ac495dSmrg# 14 inches) and executive (7.25 x 10.5 inches).
186136ac495dSmrg# The default value is: a4.
186236ac495dSmrg# This tag requires that the tag GENERATE_LATEX is set to YES.
186336ac495dSmrg
186436ac495dSmrgPAPER_TYPE             = letter
186536ac495dSmrg
186636ac495dSmrg# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
18678feb0f0bSmrg# that should be included in the LaTeX output. The package can be specified just
18688feb0f0bSmrg# by its name or with the correct syntax as to be used with the LaTeX
18698feb0f0bSmrg# \usepackage command. To get the times font for instance you can specify :
18708feb0f0bSmrg# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
18718feb0f0bSmrg# To use the option intlimits with the amsmath package you can specify:
18728feb0f0bSmrg# EXTRA_PACKAGES=[intlimits]{amsmath}
187336ac495dSmrg# If left blank no extra packages will be included.
187436ac495dSmrg# This tag requires that the tag GENERATE_LATEX is set to YES.
187536ac495dSmrg
187636ac495dSmrgEXTRA_PACKAGES         = amsmath
187736ac495dSmrg
187836ac495dSmrg# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
187936ac495dSmrg# generated LaTeX document. The header should contain everything until the first
188036ac495dSmrg# chapter. If it is left blank doxygen will generate a standard header. See
188136ac495dSmrg# section "Doxygen usage" for information on how to let doxygen write the
188236ac495dSmrg# default header to a separate file.
188336ac495dSmrg#
188436ac495dSmrg# Note: Only use a user-defined header if you know what you are doing! The
188536ac495dSmrg# following commands have a special meaning inside the header: $title,
18868feb0f0bSmrg# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
18878feb0f0bSmrg# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
18888feb0f0bSmrg# string, for the replacement values of the other commands the user is referred
18898feb0f0bSmrg# to HTML_HEADER.
189036ac495dSmrg# This tag requires that the tag GENERATE_LATEX is set to YES.
189136ac495dSmrg
189236ac495dSmrgLATEX_HEADER           =
189336ac495dSmrg
189436ac495dSmrg# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
189536ac495dSmrg# generated LaTeX document. The footer should contain everything after the last
18968feb0f0bSmrg# chapter. If it is left blank doxygen will generate a standard footer. See
18978feb0f0bSmrg# LATEX_HEADER for more information on how to generate a default footer and what
18988feb0f0bSmrg# special commands can be used inside the footer.
189936ac495dSmrg#
190036ac495dSmrg# Note: Only use a user-defined footer if you know what you are doing!
190136ac495dSmrg# This tag requires that the tag GENERATE_LATEX is set to YES.
190236ac495dSmrg
190336ac495dSmrgLATEX_FOOTER           =
190436ac495dSmrg
19058feb0f0bSmrg# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
19068feb0f0bSmrg# LaTeX style sheets that are included after the standard style sheets created
19078feb0f0bSmrg# by doxygen. Using this option one can overrule certain style aspects. Doxygen
19088feb0f0bSmrg# will copy the style sheet files to the output directory.
19098feb0f0bSmrg# Note: The order of the extra style sheet files is of importance (e.g. the last
19108feb0f0bSmrg# style sheet in the list overrules the setting of the previous ones in the
19118feb0f0bSmrg# list).
19128feb0f0bSmrg# This tag requires that the tag GENERATE_LATEX is set to YES.
19138feb0f0bSmrg
19148feb0f0bSmrgLATEX_EXTRA_STYLESHEET =
19158feb0f0bSmrg
191636ac495dSmrg# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
191736ac495dSmrg# other source files which should be copied to the LATEX_OUTPUT output
191836ac495dSmrg# directory. Note that the files will be copied as-is; there are no commands or
191936ac495dSmrg# markers available.
192036ac495dSmrg# This tag requires that the tag GENERATE_LATEX is set to YES.
192136ac495dSmrg
192236ac495dSmrgLATEX_EXTRA_FILES      =
192336ac495dSmrg
192436ac495dSmrg# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
192536ac495dSmrg# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
192636ac495dSmrg# contain links (just like the HTML output) instead of page references. This
192736ac495dSmrg# makes the output suitable for online browsing using a PDF viewer.
192836ac495dSmrg# The default value is: YES.
192936ac495dSmrg# This tag requires that the tag GENERATE_LATEX is set to YES.
193036ac495dSmrg
193136ac495dSmrgPDF_HYPERLINKS         = YES
193236ac495dSmrg
19338feb0f0bSmrg# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
19348feb0f0bSmrg# the PDF file directly from the LaTeX files. Set this option to YES, to get a
193536ac495dSmrg# higher quality PDF documentation.
193636ac495dSmrg# The default value is: YES.
193736ac495dSmrg# This tag requires that the tag GENERATE_LATEX is set to YES.
193836ac495dSmrg
193936ac495dSmrgUSE_PDFLATEX           = YES
194036ac495dSmrg
194136ac495dSmrg# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
194236ac495dSmrg# command to the generated LaTeX files. This will instruct LaTeX to keep running
194336ac495dSmrg# if errors occur, instead of asking the user for help. This option is also used
194436ac495dSmrg# when generating formulas in HTML.
194536ac495dSmrg# The default value is: NO.
194636ac495dSmrg# This tag requires that the tag GENERATE_LATEX is set to YES.
194736ac495dSmrg
194836ac495dSmrgLATEX_BATCHMODE        = YES
194936ac495dSmrg
195036ac495dSmrg# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
195136ac495dSmrg# index chapters (such as File Index, Compound Index, etc.) in the output.
195236ac495dSmrg# The default value is: NO.
195336ac495dSmrg# This tag requires that the tag GENERATE_LATEX is set to YES.
195436ac495dSmrg
195536ac495dSmrgLATEX_HIDE_INDICES     = YES
195636ac495dSmrg
195736ac495dSmrg# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
195836ac495dSmrg# code with syntax highlighting in the LaTeX output.
195936ac495dSmrg#
196036ac495dSmrg# Note that which sources are shown also depends on other settings such as
196136ac495dSmrg# SOURCE_BROWSER.
196236ac495dSmrg# The default value is: NO.
196336ac495dSmrg# This tag requires that the tag GENERATE_LATEX is set to YES.
196436ac495dSmrg
196536ac495dSmrgLATEX_SOURCE_CODE      = NO
196636ac495dSmrg
196736ac495dSmrg# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
196836ac495dSmrg# bibliography, e.g. plainnat, or ieeetr. See
19698feb0f0bSmrg# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
197036ac495dSmrg# The default value is: plain.
197136ac495dSmrg# This tag requires that the tag GENERATE_LATEX is set to YES.
197236ac495dSmrg
197336ac495dSmrgLATEX_BIB_STYLE        = plain
197436ac495dSmrg
19758feb0f0bSmrg# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
19768feb0f0bSmrg# page will contain the date and time when the page was generated. Setting this
19778feb0f0bSmrg# to NO can help when comparing the output of multiple runs.
19788feb0f0bSmrg# The default value is: NO.
19798feb0f0bSmrg# This tag requires that the tag GENERATE_LATEX is set to YES.
19808feb0f0bSmrg
19818feb0f0bSmrgLATEX_TIMESTAMP        = NO
19828feb0f0bSmrg
198336ac495dSmrg#---------------------------------------------------------------------------
198436ac495dSmrg# Configuration options related to the RTF output
198536ac495dSmrg#---------------------------------------------------------------------------
198636ac495dSmrg
19878feb0f0bSmrg# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
198836ac495dSmrg# RTF output is optimized for Word 97 and may not look too pretty with other RTF
198936ac495dSmrg# readers/editors.
199036ac495dSmrg# The default value is: NO.
199136ac495dSmrg
199236ac495dSmrgGENERATE_RTF           = NO
199336ac495dSmrg
199436ac495dSmrg# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
199536ac495dSmrg# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
199636ac495dSmrg# it.
199736ac495dSmrg# The default directory is: rtf.
199836ac495dSmrg# This tag requires that the tag GENERATE_RTF is set to YES.
199936ac495dSmrg
200036ac495dSmrgRTF_OUTPUT             = rtf
200136ac495dSmrg
20028feb0f0bSmrg# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
200336ac495dSmrg# documents. This may be useful for small projects and may help to save some
200436ac495dSmrg# trees in general.
200536ac495dSmrg# The default value is: NO.
200636ac495dSmrg# This tag requires that the tag GENERATE_RTF is set to YES.
200736ac495dSmrg
200836ac495dSmrgCOMPACT_RTF            = NO
200936ac495dSmrg
201036ac495dSmrg# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
201136ac495dSmrg# contain hyperlink fields. The RTF file will contain links (just like the HTML
201236ac495dSmrg# output) instead of page references. This makes the output suitable for online
201336ac495dSmrg# browsing using Word or some other Word compatible readers that support those
201436ac495dSmrg# fields.
201536ac495dSmrg#
201636ac495dSmrg# Note: WordPad (write) and others do not support links.
201736ac495dSmrg# The default value is: NO.
201836ac495dSmrg# This tag requires that the tag GENERATE_RTF is set to YES.
201936ac495dSmrg
202036ac495dSmrgRTF_HYPERLINKS         = NO
202136ac495dSmrg
202236ac495dSmrg# Load stylesheet definitions from file. Syntax is similar to doxygen's config
202336ac495dSmrg# file, i.e. a series of assignments. You only have to provide replacements,
202436ac495dSmrg# missing definitions are set to their default value.
202536ac495dSmrg#
202636ac495dSmrg# See also section "Doxygen usage" for information on how to generate the
202736ac495dSmrg# default style sheet that doxygen normally uses.
202836ac495dSmrg# This tag requires that the tag GENERATE_RTF is set to YES.
202936ac495dSmrg
203036ac495dSmrgRTF_STYLESHEET_FILE    =
203136ac495dSmrg
203236ac495dSmrg# Set optional variables used in the generation of an RTF document. Syntax is
203336ac495dSmrg# similar to doxygen's config file. A template extensions file can be generated
203436ac495dSmrg# using doxygen -e rtf extensionFile.
203536ac495dSmrg# This tag requires that the tag GENERATE_RTF is set to YES.
203636ac495dSmrg
203736ac495dSmrgRTF_EXTENSIONS_FILE    =
203836ac495dSmrg
20398feb0f0bSmrg# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
20408feb0f0bSmrg# with syntax highlighting in the RTF output.
20418feb0f0bSmrg#
20428feb0f0bSmrg# Note that which sources are shown also depends on other settings such as
20438feb0f0bSmrg# SOURCE_BROWSER.
20448feb0f0bSmrg# The default value is: NO.
20458feb0f0bSmrg# This tag requires that the tag GENERATE_RTF is set to YES.
20468feb0f0bSmrg
20478feb0f0bSmrgRTF_SOURCE_CODE        = NO
20488feb0f0bSmrg
204936ac495dSmrg#---------------------------------------------------------------------------
205036ac495dSmrg# Configuration options related to the man page output
205136ac495dSmrg#---------------------------------------------------------------------------
205236ac495dSmrg
20538feb0f0bSmrg# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
205436ac495dSmrg# classes and files.
205536ac495dSmrg# The default value is: NO.
205636ac495dSmrg
205736ac495dSmrgGENERATE_MAN           = @do_man@
205836ac495dSmrg
205936ac495dSmrg# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
206036ac495dSmrg# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
206136ac495dSmrg# it. A directory man3 will be created inside the directory specified by
206236ac495dSmrg# MAN_OUTPUT.
206336ac495dSmrg# The default directory is: man.
206436ac495dSmrg# This tag requires that the tag GENERATE_MAN is set to YES.
206536ac495dSmrg
206636ac495dSmrgMAN_OUTPUT             = man
206736ac495dSmrg
206836ac495dSmrg# The MAN_EXTENSION tag determines the extension that is added to the generated
206936ac495dSmrg# man pages. In case the manual section does not start with a number, the number
207036ac495dSmrg# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
207136ac495dSmrg# optional.
207236ac495dSmrg# The default value is: .3.
207336ac495dSmrg# This tag requires that the tag GENERATE_MAN is set to YES.
207436ac495dSmrg
207536ac495dSmrgMAN_EXTENSION          = .3
207636ac495dSmrg
20778feb0f0bSmrg# The MAN_SUBDIR tag determines the name of the directory created within
20788feb0f0bSmrg# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
20798feb0f0bSmrg# MAN_EXTENSION with the initial . removed.
20808feb0f0bSmrg# This tag requires that the tag GENERATE_MAN is set to YES.
20818feb0f0bSmrg
20828feb0f0bSmrgMAN_SUBDIR             =
20838feb0f0bSmrg
208436ac495dSmrg# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
208536ac495dSmrg# will generate one additional man file for each entity documented in the real
208636ac495dSmrg# man page(s). These additional files only source the real man page, but without
208736ac495dSmrg# them the man command would be unable to find the correct page.
208836ac495dSmrg# The default value is: NO.
208936ac495dSmrg# This tag requires that the tag GENERATE_MAN is set to YES.
209036ac495dSmrg
209136ac495dSmrgMAN_LINKS              = NO
209236ac495dSmrg
209336ac495dSmrg#---------------------------------------------------------------------------
209436ac495dSmrg# Configuration options related to the XML output
209536ac495dSmrg#---------------------------------------------------------------------------
209636ac495dSmrg
20978feb0f0bSmrg# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
209836ac495dSmrg# captures the structure of the code including all documentation.
209936ac495dSmrg# The default value is: NO.
210036ac495dSmrg
210136ac495dSmrgGENERATE_XML           = @do_xml@
210236ac495dSmrg
210336ac495dSmrg# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
210436ac495dSmrg# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
210536ac495dSmrg# it.
210636ac495dSmrg# The default directory is: xml.
210736ac495dSmrg# This tag requires that the tag GENERATE_XML is set to YES.
210836ac495dSmrg
210936ac495dSmrgXML_OUTPUT             = xml
211036ac495dSmrg
21118feb0f0bSmrg# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
211236ac495dSmrg# listings (including syntax highlighting and cross-referencing information) to
211336ac495dSmrg# the XML output. Note that enabling this will significantly increase the size
211436ac495dSmrg# of the XML output.
211536ac495dSmrg# The default value is: YES.
211636ac495dSmrg# This tag requires that the tag GENERATE_XML is set to YES.
211736ac495dSmrg
211836ac495dSmrgXML_PROGRAMLISTING     = NO
211936ac495dSmrg
212036ac495dSmrg#---------------------------------------------------------------------------
212136ac495dSmrg# Configuration options related to the DOCBOOK output
212236ac495dSmrg#---------------------------------------------------------------------------
212336ac495dSmrg
21248feb0f0bSmrg# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
212536ac495dSmrg# that can be used to generate PDF.
212636ac495dSmrg# The default value is: NO.
212736ac495dSmrg
212836ac495dSmrgGENERATE_DOCBOOK       = NO
212936ac495dSmrg
213036ac495dSmrg# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
213136ac495dSmrg# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
213236ac495dSmrg# front of it.
213336ac495dSmrg# The default directory is: docbook.
213436ac495dSmrg# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
213536ac495dSmrg
213636ac495dSmrgDOCBOOK_OUTPUT         = docbook
213736ac495dSmrg
21388feb0f0bSmrg# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
21398feb0f0bSmrg# program listings (including syntax highlighting and cross-referencing
21408feb0f0bSmrg# information) to the DOCBOOK output. Note that enabling this will significantly
21418feb0f0bSmrg# increase the size of the DOCBOOK output.
21428feb0f0bSmrg# The default value is: NO.
21438feb0f0bSmrg# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
21448feb0f0bSmrg
21458feb0f0bSmrgDOCBOOK_PROGRAMLISTING = NO
21468feb0f0bSmrg
214736ac495dSmrg#---------------------------------------------------------------------------
214836ac495dSmrg# Configuration options for the AutoGen Definitions output
214936ac495dSmrg#---------------------------------------------------------------------------
215036ac495dSmrg
21518feb0f0bSmrg# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
21528feb0f0bSmrg# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
21538feb0f0bSmrg# the structure of the code including all documentation. Note that this feature
21548feb0f0bSmrg# is still experimental and incomplete at the moment.
215536ac495dSmrg# The default value is: NO.
215636ac495dSmrg
215736ac495dSmrgGENERATE_AUTOGEN_DEF   = NO
215836ac495dSmrg
215936ac495dSmrg#---------------------------------------------------------------------------
216036ac495dSmrg# Configuration options related to the Perl module output
216136ac495dSmrg#---------------------------------------------------------------------------
216236ac495dSmrg
21638feb0f0bSmrg# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
216436ac495dSmrg# file that captures the structure of the code including all documentation.
216536ac495dSmrg#
216636ac495dSmrg# Note that this feature is still experimental and incomplete at the moment.
216736ac495dSmrg# The default value is: NO.
216836ac495dSmrg
216936ac495dSmrgGENERATE_PERLMOD       = NO
217036ac495dSmrg
21718feb0f0bSmrg# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
217236ac495dSmrg# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
217336ac495dSmrg# output from the Perl module output.
217436ac495dSmrg# The default value is: NO.
217536ac495dSmrg# This tag requires that the tag GENERATE_PERLMOD is set to YES.
217636ac495dSmrg
217736ac495dSmrgPERLMOD_LATEX          = NO
217836ac495dSmrg
21798feb0f0bSmrg# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
218036ac495dSmrg# formatted so it can be parsed by a human reader. This is useful if you want to
21818feb0f0bSmrg# understand what is going on. On the other hand, if this tag is set to NO, the
218236ac495dSmrg# size of the Perl module output will be much smaller and Perl will parse it
218336ac495dSmrg# just the same.
218436ac495dSmrg# The default value is: YES.
218536ac495dSmrg# This tag requires that the tag GENERATE_PERLMOD is set to YES.
218636ac495dSmrg
218736ac495dSmrgPERLMOD_PRETTY         = YES
218836ac495dSmrg
218936ac495dSmrg# The names of the make variables in the generated doxyrules.make file are
219036ac495dSmrg# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
219136ac495dSmrg# so different doxyrules.make files included by the same Makefile don't
219236ac495dSmrg# overwrite each other's variables.
219336ac495dSmrg# This tag requires that the tag GENERATE_PERLMOD is set to YES.
219436ac495dSmrg
219536ac495dSmrgPERLMOD_MAKEVAR_PREFIX =
219636ac495dSmrg
219736ac495dSmrg#---------------------------------------------------------------------------
219836ac495dSmrg# Configuration options related to the preprocessor
219936ac495dSmrg#---------------------------------------------------------------------------
220036ac495dSmrg
22018feb0f0bSmrg# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
220236ac495dSmrg# C-preprocessor directives found in the sources and include files.
220336ac495dSmrg# The default value is: YES.
220436ac495dSmrg
220536ac495dSmrgENABLE_PREPROCESSING   = YES
220636ac495dSmrg
22078feb0f0bSmrg# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
22088feb0f0bSmrg# in the source code. If set to NO, only conditional compilation will be
220936ac495dSmrg# performed. Macro expansion can be done in a controlled way by setting
221036ac495dSmrg# EXPAND_ONLY_PREDEF to YES.
221136ac495dSmrg# The default value is: NO.
221236ac495dSmrg# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
221336ac495dSmrg
221436ac495dSmrgMACRO_EXPANSION        = YES
221536ac495dSmrg
221636ac495dSmrg# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
221736ac495dSmrg# the macro expansion is limited to the macros specified with the PREDEFINED and
221836ac495dSmrg# EXPAND_AS_DEFINED tags.
221936ac495dSmrg# The default value is: NO.
222036ac495dSmrg# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
222136ac495dSmrg
222236ac495dSmrgEXPAND_ONLY_PREDEF     = NO
222336ac495dSmrg
22248feb0f0bSmrg# If the SEARCH_INCLUDES tag is set to YES, the include files in the
222536ac495dSmrg# INCLUDE_PATH will be searched if a #include is found.
222636ac495dSmrg# The default value is: YES.
222736ac495dSmrg# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
222836ac495dSmrg
222936ac495dSmrgSEARCH_INCLUDES        = YES
223036ac495dSmrg
223136ac495dSmrg# The INCLUDE_PATH tag can be used to specify one or more directories that
223236ac495dSmrg# contain include files that are not input files but should be processed by the
223336ac495dSmrg# preprocessor.
223436ac495dSmrg# This tag requires that the tag SEARCH_INCLUDES is set to YES.
223536ac495dSmrg
223636ac495dSmrgINCLUDE_PATH           = include
223736ac495dSmrg
223836ac495dSmrg# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
223936ac495dSmrg# patterns (like *.h and *.hpp) to filter out the header-files in the
224036ac495dSmrg# directories. If left blank, the patterns specified with FILE_PATTERNS will be
224136ac495dSmrg# used.
224236ac495dSmrg# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
224336ac495dSmrg
224436ac495dSmrgINCLUDE_FILE_PATTERNS  =
224536ac495dSmrg
224636ac495dSmrg# The PREDEFINED tag can be used to specify one or more macro names that are
224736ac495dSmrg# defined before the preprocessor is started (similar to the -D option of e.g.
224836ac495dSmrg# gcc). The argument of the tag is a list of macros of the form: name or
224936ac495dSmrg# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
225036ac495dSmrg# is assumed. To prevent a macro definition from being undefined via #undef or
225136ac495dSmrg# recursively expanded use the := operator instead of the = operator.
225236ac495dSmrg# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
225336ac495dSmrg
225436ac495dSmrgPREDEFINED             = __cplusplus=201402L \
225536ac495dSmrg                         __GTHREADS \
225636ac495dSmrg                         _GLIBCXX_HAS_GTHREADS \
225736ac495dSmrg                         _GLIBCXX_HAVE_TLS \
225836ac495dSmrg                         _GLIBCXX_INCLUDE_AS_CXX11 \
225936ac495dSmrg                         "_GLIBCXX_PURE= " \
226036ac495dSmrg                         "_GLIBCXX_CONST= " \
22618feb0f0bSmrg                         "_GLIBCXX_NODISCARD=[[nodiscard]]" \
226236ac495dSmrg                         "_GLIBCXX_NORETURN= " \
22638feb0f0bSmrg                         "_GLIBCXX_NOEXCEPT_PARM= " \
22648feb0f0bSmrg                         "_GLIBCXX_NOEXCEPT_QUAL= " \
226536ac495dSmrg                         "_GLIBCXX_STD_C= " \
226636ac495dSmrg                         "_GLIBCXX_STD_A= " \
22678feb0f0bSmrg                         "_GLIBCXX_TXN_SAFE_DYN= " \
226836ac495dSmrg                         "_GLIBCXX_VISIBILITY(V)= " \
226936ac495dSmrg                         "_GLIBCXX_BEGIN_NAMESPACE_VERSION= " \
227036ac495dSmrg                         "_GLIBCXX_BEGIN_NAMESPACE_ALGO= " \
227136ac495dSmrg                         "_GLIBCXX_BEGIN_NAMESPACE_CONTAINER= " \
22728feb0f0bSmrg                         "_GLIBCXX_BEGIN_NAMESPACE_CXX11= " \
227336ac495dSmrg                         "_GLIBCXX_BEGIN_NAMESPACE_LDBL= " \
227436ac495dSmrg                         "_GLIBCXX_END_NAMESPACE_VERSION= " \
227536ac495dSmrg                         "_GLIBCXX_END_NAMESPACE_ALGO= " \
227636ac495dSmrg                         "_GLIBCXX_END_NAMESPACE_CONTAINER= " \
22778feb0f0bSmrg                         "_GLIBCXX_END_NAMESPACE_CXX11= " \
227836ac495dSmrg                         "_GLIBCXX_END_NAMESPACE_LDBL= " \
227936ac495dSmrg                         "_GLIBCXX_TEMPLATE_ARGS=...  " \
228036ac495dSmrg                         _GLIBCXX_DEPRECATED \
228136ac495dSmrg                         _GLIBCXX_CONSTEXPR=constexpr \
228236ac495dSmrg                         _GLIBCXX_USE_CONSTEXPR=constexpr \
228336ac495dSmrg                         "_GLIBCXX_THROW(E)= " \
228436ac495dSmrg                         _GLIBCXX_NOEXCEPT=noexcept \
228536ac495dSmrg                         "_GLIBCXX_NOEXCEPT_IF(C)=noexcept(/*conditional*/)" \
228636ac495dSmrg                         _GLIBCXX_NOTHROW=noexcept \
228736ac495dSmrg                         _GLIBCXX_USE_NOEXCEPT=noexcept \
228836ac495dSmrg                         _GLIBCXX_USE_WCHAR_T \
228936ac495dSmrg                         _GLIBCXX_USE_LONG_LONG \
229036ac495dSmrg                         _GLIBCXX_USE_C99_STDINT_TR1 \
229136ac495dSmrg                         _GLIBCXX_USE_SCHED_YIELD \
229236ac495dSmrg                         _GLIBCXX_USE_NANOSLEEP \
229336ac495dSmrg                         __cpp_exceptions \
229436ac495dSmrg                         __cpp_rtti \
229536ac495dSmrg                         ATOMIC_INT_LOCK_FREE=2 \
229636ac495dSmrg                         PB_DS_DATA_TRUE_INDICATOR \
229736ac495dSmrg                         PB_DS_STATIC_ASSERT=// \
229836ac495dSmrg                         "_GLIBCXX_BEGIN_NAMESPACE_ALGO= " \
22998feb0f0bSmrg                         "_GLIBCXX_END_NAMESPACE_ALGO= " \
230036ac495dSmrg                         __glibcxx_function_requires=// \
230136ac495dSmrg                         __glibcxx_class_requires=// \
230236ac495dSmrg                         __glibcxx_class_requires2=// \
230336ac495dSmrg                         __glibcxx_class_requires3=// \
23048feb0f0bSmrg                         __glibcxx_class_requires4=// \
23058feb0f0bSmrg                         "__attribute__(X)=" \
23068feb0f0bSmrg                         _GLIBCXX14_CONSTEXPR=constexpr \
23078feb0f0bSmrg                         _GLIBCXX17_CONSTEXPR=constexpr \
23088feb0f0bSmrg                         _GLIBCXX20_CONSTEXPR=constexpr \
23098feb0f0bSmrg                         _GLIBCXX17_DEPRECATED=  \
23108feb0f0bSmrg                         _GLIBCXX17_INLINE=inline \
231136ac495dSmrg
231236ac495dSmrg# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
231336ac495dSmrg# tag can be used to specify a list of macro names that should be expanded. The
231436ac495dSmrg# macro definition that is found in the sources will be used. Use the PREDEFINED
231536ac495dSmrg# tag if you want to use a different macro definition that overrules the
231636ac495dSmrg# definition found in the source code.
231736ac495dSmrg# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
231836ac495dSmrg
231936ac495dSmrgEXPAND_AS_DEFINED      =
232036ac495dSmrg
232136ac495dSmrg# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
23228feb0f0bSmrg# remove all references to function-like macros that are alone on a line, have
23238feb0f0bSmrg# an all uppercase name, and do not end with a semicolon. Such function macros
23248feb0f0bSmrg# are typically used for boiler-plate code, and will confuse the parser if not
232536ac495dSmrg# removed.
232636ac495dSmrg# The default value is: YES.
232736ac495dSmrg# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
232836ac495dSmrg
232936ac495dSmrgSKIP_FUNCTION_MACROS   = YES
233036ac495dSmrg
233136ac495dSmrg#---------------------------------------------------------------------------
233236ac495dSmrg# Configuration options related to external references
233336ac495dSmrg#---------------------------------------------------------------------------
233436ac495dSmrg
233536ac495dSmrg# The TAGFILES tag can be used to specify one or more tag files. For each tag
233636ac495dSmrg# file the location of the external documentation should be added. The format of
233736ac495dSmrg# a tag file without this location is as follows:
233836ac495dSmrg# TAGFILES = file1 file2 ...
233936ac495dSmrg# Adding location for the tag files is done as follows:
234036ac495dSmrg# TAGFILES = file1=loc1 "file2 = loc2" ...
234136ac495dSmrg# where loc1 and loc2 can be relative or absolute paths or URLs. See the
234236ac495dSmrg# section "Linking to external documentation" for more information about the use
234336ac495dSmrg# of tag files.
23448feb0f0bSmrg# Note: Each tag file must have a unique name (where the name does NOT include
234536ac495dSmrg# the path). If a tag file is not located in the directory in which doxygen is
234636ac495dSmrg# run, you must also specify the path to the tagfile here.
234736ac495dSmrg
234836ac495dSmrgTAGFILES               =
234936ac495dSmrg
235036ac495dSmrg# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
235136ac495dSmrg# tag file that is based on the input files it reads. See section "Linking to
235236ac495dSmrg# external documentation" for more information about the usage of tag files.
235336ac495dSmrg
235436ac495dSmrgGENERATE_TAGFILE       = @generate_tagfile@
235536ac495dSmrg
23568feb0f0bSmrg# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
23578feb0f0bSmrg# the class index. If set to NO, only the inherited external classes will be
23588feb0f0bSmrg# listed.
235936ac495dSmrg# The default value is: NO.
236036ac495dSmrg
236136ac495dSmrgALLEXTERNALS           = YES
236236ac495dSmrg
23638feb0f0bSmrg# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
23648feb0f0bSmrg# in the modules index. If set to NO, only the current project's groups will be
236536ac495dSmrg# listed.
236636ac495dSmrg# The default value is: YES.
236736ac495dSmrg
236836ac495dSmrgEXTERNAL_GROUPS        = YES
236936ac495dSmrg
23708feb0f0bSmrg# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
237136ac495dSmrg# the related pages index. If set to NO, only the current project's pages will
237236ac495dSmrg# be listed.
237336ac495dSmrg# The default value is: YES.
237436ac495dSmrg
237536ac495dSmrgEXTERNAL_PAGES         = YES
237636ac495dSmrg
237736ac495dSmrg# The PERL_PATH should be the absolute path and name of the perl script
237836ac495dSmrg# interpreter (i.e. the result of 'which perl').
237936ac495dSmrg# The default file (with absolute path) is: /usr/bin/perl.
238036ac495dSmrg
238136ac495dSmrgPERL_PATH              = /usr/bin/perl
238236ac495dSmrg
238336ac495dSmrg#---------------------------------------------------------------------------
238436ac495dSmrg# Configuration options related to the dot tool
238536ac495dSmrg#---------------------------------------------------------------------------
238636ac495dSmrg
23878feb0f0bSmrg# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
238836ac495dSmrg# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
238936ac495dSmrg# NO turns the diagrams off. Note that this option also works with HAVE_DOT
239036ac495dSmrg# disabled, but it is recommended to install and use dot, since it yields more
239136ac495dSmrg# powerful graphs.
239236ac495dSmrg# The default value is: YES.
239336ac495dSmrg
239436ac495dSmrgCLASS_DIAGRAMS         = YES
239536ac495dSmrg
239636ac495dSmrg# You can define message sequence charts within doxygen comments using the \msc
239736ac495dSmrg# command. Doxygen will then run the mscgen tool (see:
239836ac495dSmrg# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
239936ac495dSmrg# documentation. The MSCGEN_PATH tag allows you to specify the directory where
240036ac495dSmrg# the mscgen tool resides. If left empty the tool is assumed to be found in the
240136ac495dSmrg# default search path.
240236ac495dSmrg
240336ac495dSmrgMSCGEN_PATH            =
240436ac495dSmrg
240536ac495dSmrg# You can include diagrams made with dia in doxygen documentation. Doxygen will
240636ac495dSmrg# then run dia to produce the diagram and insert it in the documentation. The
240736ac495dSmrg# DIA_PATH tag allows you to specify the directory where the dia binary resides.
240836ac495dSmrg# If left empty dia is assumed to be found in the default search path.
240936ac495dSmrg
241036ac495dSmrgDIA_PATH               =
241136ac495dSmrg
24128feb0f0bSmrg# If set to YES the inheritance and collaboration graphs will hide inheritance
241336ac495dSmrg# and usage relations if the target is undocumented or is not a class.
241436ac495dSmrg# The default value is: YES.
241536ac495dSmrg
241636ac495dSmrgHIDE_UNDOC_RELATIONS   = NO
241736ac495dSmrg
241836ac495dSmrg# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
241936ac495dSmrg# available from the path. This tool is part of Graphviz (see:
242036ac495dSmrg# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
242136ac495dSmrg# Bell Labs. The other options in this section have no effect if this option is
242236ac495dSmrg# set to NO
242336ac495dSmrg# The default value is: NO.
242436ac495dSmrg
242536ac495dSmrgHAVE_DOT               = YES
242636ac495dSmrg
242736ac495dSmrg# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
242836ac495dSmrg# to run in parallel. When set to 0 doxygen will base this on the number of
242936ac495dSmrg# processors available in the system. You can set it explicitly to a value
243036ac495dSmrg# larger than 0 to get control over the balance between CPU load and processing
243136ac495dSmrg# speed.
243236ac495dSmrg# Minimum value: 0, maximum value: 32, default value: 0.
243336ac495dSmrg# This tag requires that the tag HAVE_DOT is set to YES.
243436ac495dSmrg
243536ac495dSmrgDOT_NUM_THREADS        = 0
243636ac495dSmrg
24378feb0f0bSmrg# When you want a differently looking font in the dot files that doxygen
243836ac495dSmrg# generates you can specify the font name using DOT_FONTNAME. You need to make
243936ac495dSmrg# sure dot is able to find the font, which can be done by putting it in a
244036ac495dSmrg# standard location or by setting the DOTFONTPATH environment variable or by
244136ac495dSmrg# setting DOT_FONTPATH to the directory containing the font.
244236ac495dSmrg# The default value is: Helvetica.
244336ac495dSmrg# This tag requires that the tag HAVE_DOT is set to YES.
244436ac495dSmrg
244536ac495dSmrgDOT_FONTNAME           =
244636ac495dSmrg
244736ac495dSmrg# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
244836ac495dSmrg# dot graphs.
244936ac495dSmrg# Minimum value: 4, maximum value: 24, default value: 10.
245036ac495dSmrg# This tag requires that the tag HAVE_DOT is set to YES.
245136ac495dSmrg
245236ac495dSmrgDOT_FONTSIZE           = 9
245336ac495dSmrg
245436ac495dSmrg# By default doxygen will tell dot to use the default font as specified with
245536ac495dSmrg# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
245636ac495dSmrg# the path where dot can find it using this tag.
245736ac495dSmrg# This tag requires that the tag HAVE_DOT is set to YES.
245836ac495dSmrg
245936ac495dSmrgDOT_FONTPATH           =
246036ac495dSmrg
246136ac495dSmrg# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
246236ac495dSmrg# each documented class showing the direct and indirect inheritance relations.
246336ac495dSmrg# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
246436ac495dSmrg# The default value is: YES.
246536ac495dSmrg# This tag requires that the tag HAVE_DOT is set to YES.
246636ac495dSmrg
246736ac495dSmrgCLASS_GRAPH            = YES
246836ac495dSmrg
246936ac495dSmrg# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
247036ac495dSmrg# graph for each documented class showing the direct and indirect implementation
247136ac495dSmrg# dependencies (inheritance, containment, and class references variables) of the
247236ac495dSmrg# class with other documented classes.
247336ac495dSmrg# The default value is: YES.
247436ac495dSmrg# This tag requires that the tag HAVE_DOT is set to YES.
247536ac495dSmrg
247636ac495dSmrgCOLLABORATION_GRAPH    = NO
247736ac495dSmrg
247836ac495dSmrg# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
247936ac495dSmrg# groups, showing the direct groups dependencies.
248036ac495dSmrg# The default value is: YES.
248136ac495dSmrg# This tag requires that the tag HAVE_DOT is set to YES.
248236ac495dSmrg
248336ac495dSmrgGROUP_GRAPHS           = YES
248436ac495dSmrg
24858feb0f0bSmrg# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
248636ac495dSmrg# collaboration diagrams in a style similar to the OMG's Unified Modeling
248736ac495dSmrg# Language.
248836ac495dSmrg# The default value is: NO.
248936ac495dSmrg# This tag requires that the tag HAVE_DOT is set to YES.
249036ac495dSmrg
249136ac495dSmrgUML_LOOK               = NO
249236ac495dSmrg
249336ac495dSmrg# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
249436ac495dSmrg# class node. If there are many fields or methods and many nodes the graph may
249536ac495dSmrg# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
249636ac495dSmrg# number of items for each type to make the size more manageable. Set this to 0
249736ac495dSmrg# for no limit. Note that the threshold may be exceeded by 50% before the limit
249836ac495dSmrg# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
249936ac495dSmrg# but if the number exceeds 15, the total amount of fields shown is limited to
250036ac495dSmrg# 10.
250136ac495dSmrg# Minimum value: 0, maximum value: 100, default value: 10.
250236ac495dSmrg# This tag requires that the tag HAVE_DOT is set to YES.
250336ac495dSmrg
250436ac495dSmrgUML_LIMIT_NUM_FIELDS   = 10
250536ac495dSmrg
250636ac495dSmrg# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
250736ac495dSmrg# collaboration graphs will show the relations between templates and their
250836ac495dSmrg# instances.
250936ac495dSmrg# The default value is: NO.
251036ac495dSmrg# This tag requires that the tag HAVE_DOT is set to YES.
251136ac495dSmrg
251236ac495dSmrgTEMPLATE_RELATIONS     = NO
251336ac495dSmrg
251436ac495dSmrg# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
251536ac495dSmrg# YES then doxygen will generate a graph for each documented file showing the
251636ac495dSmrg# direct and indirect include dependencies of the file with other documented
251736ac495dSmrg# files.
251836ac495dSmrg# The default value is: YES.
251936ac495dSmrg# This tag requires that the tag HAVE_DOT is set to YES.
252036ac495dSmrg
252136ac495dSmrgINCLUDE_GRAPH          = NO
252236ac495dSmrg
252336ac495dSmrg# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
252436ac495dSmrg# set to YES then doxygen will generate a graph for each documented file showing
252536ac495dSmrg# the direct and indirect include dependencies of the file with other documented
252636ac495dSmrg# files.
252736ac495dSmrg# The default value is: YES.
252836ac495dSmrg# This tag requires that the tag HAVE_DOT is set to YES.
252936ac495dSmrg
253036ac495dSmrgINCLUDED_BY_GRAPH      = NO
253136ac495dSmrg
253236ac495dSmrg# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
253336ac495dSmrg# dependency graph for every global function or class method.
253436ac495dSmrg#
253536ac495dSmrg# Note that enabling this option will significantly increase the time of a run.
253636ac495dSmrg# So in most cases it will be better to enable call graphs for selected
25378feb0f0bSmrg# functions only using the \callgraph command. Disabling a call graph can be
25388feb0f0bSmrg# accomplished by means of the command \hidecallgraph.
253936ac495dSmrg# The default value is: NO.
254036ac495dSmrg# This tag requires that the tag HAVE_DOT is set to YES.
254136ac495dSmrg
254236ac495dSmrgCALL_GRAPH             = NO
254336ac495dSmrg
254436ac495dSmrg# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
254536ac495dSmrg# dependency graph for every global function or class method.
254636ac495dSmrg#
254736ac495dSmrg# Note that enabling this option will significantly increase the time of a run.
254836ac495dSmrg# So in most cases it will be better to enable caller graphs for selected
25498feb0f0bSmrg# functions only using the \callergraph command. Disabling a caller graph can be
25508feb0f0bSmrg# accomplished by means of the command \hidecallergraph.
255136ac495dSmrg# The default value is: NO.
255236ac495dSmrg# This tag requires that the tag HAVE_DOT is set to YES.
255336ac495dSmrg
255436ac495dSmrgCALLER_GRAPH           = NO
255536ac495dSmrg
255636ac495dSmrg# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
255736ac495dSmrg# hierarchy of all classes instead of a textual one.
255836ac495dSmrg# The default value is: YES.
255936ac495dSmrg# This tag requires that the tag HAVE_DOT is set to YES.
256036ac495dSmrg
256136ac495dSmrgGRAPHICAL_HIERARCHY    = YES
256236ac495dSmrg
256336ac495dSmrg# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
256436ac495dSmrg# dependencies a directory has on other directories in a graphical way. The
256536ac495dSmrg# dependency relations are determined by the #include relations between the
256636ac495dSmrg# files in the directories.
256736ac495dSmrg# The default value is: YES.
256836ac495dSmrg# This tag requires that the tag HAVE_DOT is set to YES.
256936ac495dSmrg
257036ac495dSmrgDIRECTORY_GRAPH        = NO
257136ac495dSmrg
257236ac495dSmrg# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
25738feb0f0bSmrg# generated by dot. For an explanation of the image formats see the section
25748feb0f0bSmrg# output formats in the documentation of the dot tool (Graphviz (see:
25758feb0f0bSmrg# http://www.graphviz.org/)).
257636ac495dSmrg# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
257736ac495dSmrg# to make the SVG files visible in IE 9+ (other browsers do not have this
257836ac495dSmrg# requirement).
25798feb0f0bSmrg# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
25808feb0f0bSmrg# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
25818feb0f0bSmrg# png:gdiplus:gdiplus.
258236ac495dSmrg# The default value is: png.
258336ac495dSmrg# This tag requires that the tag HAVE_DOT is set to YES.
258436ac495dSmrg
258536ac495dSmrgDOT_IMAGE_FORMAT       = svg
258636ac495dSmrg
258736ac495dSmrg# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
258836ac495dSmrg# enable generation of interactive SVG images that allow zooming and panning.
258936ac495dSmrg#
259036ac495dSmrg# Note that this requires a modern browser other than Internet Explorer. Tested
259136ac495dSmrg# and working are Firefox, Chrome, Safari, and Opera.
259236ac495dSmrg# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
259336ac495dSmrg# the SVG files visible. Older versions of IE do not have SVG support.
259436ac495dSmrg# The default value is: NO.
259536ac495dSmrg# This tag requires that the tag HAVE_DOT is set to YES.
259636ac495dSmrg
259736ac495dSmrgINTERACTIVE_SVG        = YES
259836ac495dSmrg
259936ac495dSmrg# The DOT_PATH tag can be used to specify the path where the dot tool can be
260036ac495dSmrg# found. If left blank, it is assumed the dot tool can be found in the path.
260136ac495dSmrg# This tag requires that the tag HAVE_DOT is set to YES.
260236ac495dSmrg
260336ac495dSmrgDOT_PATH               =
260436ac495dSmrg
260536ac495dSmrg# The DOTFILE_DIRS tag can be used to specify one or more directories that
260636ac495dSmrg# contain dot files that are included in the documentation (see the \dotfile
260736ac495dSmrg# command).
260836ac495dSmrg# This tag requires that the tag HAVE_DOT is set to YES.
260936ac495dSmrg
261036ac495dSmrgDOTFILE_DIRS           =
261136ac495dSmrg
261236ac495dSmrg# The MSCFILE_DIRS tag can be used to specify one or more directories that
261336ac495dSmrg# contain msc files that are included in the documentation (see the \mscfile
261436ac495dSmrg# command).
261536ac495dSmrg
261636ac495dSmrgMSCFILE_DIRS           =
261736ac495dSmrg
261836ac495dSmrg# The DIAFILE_DIRS tag can be used to specify one or more directories that
261936ac495dSmrg# contain dia files that are included in the documentation (see the \diafile
262036ac495dSmrg# command).
262136ac495dSmrg
262236ac495dSmrgDIAFILE_DIRS           =
262336ac495dSmrg
26248feb0f0bSmrg# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
26258feb0f0bSmrg# path where java can find the plantuml.jar file. If left blank, it is assumed
26268feb0f0bSmrg# PlantUML is not used or called during a preprocessing step. Doxygen will
26278feb0f0bSmrg# generate a warning when it encounters a \startuml command in this case and
26288feb0f0bSmrg# will not generate output for the diagram.
26298feb0f0bSmrg
26308feb0f0bSmrgPLANTUML_JAR_PATH      =
26318feb0f0bSmrg
26328feb0f0bSmrg# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
26338feb0f0bSmrg# configuration file for plantuml.
26348feb0f0bSmrg
26358feb0f0bSmrgPLANTUML_CFG_FILE      =
26368feb0f0bSmrg
26378feb0f0bSmrg# When using plantuml, the specified paths are searched for files specified by
26388feb0f0bSmrg# the !include statement in a plantuml block.
26398feb0f0bSmrg
26408feb0f0bSmrgPLANTUML_INCLUDE_PATH  =
26418feb0f0bSmrg
264236ac495dSmrg# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
264336ac495dSmrg# that will be shown in the graph. If the number of nodes in a graph becomes
264436ac495dSmrg# larger than this value, doxygen will truncate the graph, which is visualized
264536ac495dSmrg# by representing a node as a red box. Note that doxygen if the number of direct
264636ac495dSmrg# children of the root node in a graph is already larger than
264736ac495dSmrg# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
264836ac495dSmrg# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
264936ac495dSmrg# Minimum value: 0, maximum value: 10000, default value: 50.
265036ac495dSmrg# This tag requires that the tag HAVE_DOT is set to YES.
265136ac495dSmrg
265236ac495dSmrgDOT_GRAPH_MAX_NODES    = 50
265336ac495dSmrg
265436ac495dSmrg# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
265536ac495dSmrg# generated by dot. A depth value of 3 means that only nodes reachable from the
265636ac495dSmrg# root by following a path via at most 3 edges will be shown. Nodes that lay
265736ac495dSmrg# further from the root node will be omitted. Note that setting this option to 1
265836ac495dSmrg# or 2 may greatly reduce the computation time needed for large code bases. Also
265936ac495dSmrg# note that the size of a graph can be further restricted by
266036ac495dSmrg# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
266136ac495dSmrg# Minimum value: 0, maximum value: 1000, default value: 0.
266236ac495dSmrg# This tag requires that the tag HAVE_DOT is set to YES.
266336ac495dSmrg
266436ac495dSmrgMAX_DOT_GRAPH_DEPTH    = 0
266536ac495dSmrg
266636ac495dSmrg# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
266736ac495dSmrg# background. This is disabled by default, because dot on Windows does not seem
266836ac495dSmrg# to support this out of the box.
266936ac495dSmrg#
267036ac495dSmrg# Warning: Depending on the platform used, enabling this option may lead to
267136ac495dSmrg# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
267236ac495dSmrg# read).
267336ac495dSmrg# The default value is: NO.
267436ac495dSmrg# This tag requires that the tag HAVE_DOT is set to YES.
267536ac495dSmrg
267636ac495dSmrgDOT_TRANSPARENT        = NO
267736ac495dSmrg
26788feb0f0bSmrg# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
267936ac495dSmrg# files in one run (i.e. multiple -o and -T options on the command line). This
268036ac495dSmrg# makes dot run faster, but since only newer versions of dot (>1.8.10) support
268136ac495dSmrg# this, this feature is disabled by default.
268236ac495dSmrg# The default value is: NO.
268336ac495dSmrg# This tag requires that the tag HAVE_DOT is set to YES.
268436ac495dSmrg
268536ac495dSmrgDOT_MULTI_TARGETS      = YES
268636ac495dSmrg
268736ac495dSmrg# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
268836ac495dSmrg# explaining the meaning of the various boxes and arrows in the dot generated
268936ac495dSmrg# graphs.
269036ac495dSmrg# The default value is: YES.
269136ac495dSmrg# This tag requires that the tag HAVE_DOT is set to YES.
269236ac495dSmrg
269336ac495dSmrgGENERATE_LEGEND        = YES
269436ac495dSmrg
26958feb0f0bSmrg# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
269636ac495dSmrg# files that are used to generate the various graphs.
269736ac495dSmrg# The default value is: YES.
269836ac495dSmrg# This tag requires that the tag HAVE_DOT is set to YES.
269936ac495dSmrg
270036ac495dSmrgDOT_CLEANUP            = YES
2701