1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/cmake_infile.doxygen Thu Dec 19 18:40:00 2019 +0100
1.3 @@ -0,0 +1,2312 @@
1.4 +# Doxyfile 1.8.7
1.5 +
1.6 +# This file describes the settings to be used by the documentation system
1.7 +# doxygen (www.doxygen.org) for a project.
1.8 +#
1.9 +# All text after a double hash (##) is considered a comment and is placed in
1.10 +# front of the TAG it is preceding.
1.11 +#
1.12 +# All text after a single hash (#) is considered a comment and will be ignored.
1.13 +# The format is:
1.14 +# TAG = value [value, ...]
1.15 +# For lists, items can also be appended using:
1.16 +# TAG += value [value, ...]
1.17 +# Values that contain spaces should be placed between quotes (\" \").
1.18 +
1.19 +#---------------------------------------------------------------------------
1.20 +# Project related configuration options
1.21 +#---------------------------------------------------------------------------
1.22 +
1.23 +# This tag specifies the encoding used for all characters in the config file
1.24 +# that follow. The default is UTF-8 which is also the encoding used for all text
1.25 +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
1.26 +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
1.27 +# for the list of possible encodings.
1.28 +# The default value is: UTF-8.
1.29 +
1.30 +DOXYFILE_ENCODING = UTF-8
1.31 +
1.32 +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
1.33 +# double-quotes, unless you are using Doxywizard) that should identify the
1.34 +# project for which the documentation is generated. This name is used in the
1.35 +# title of most generated pages and in a few other places.
1.36 +# The default value is: My Project.
1.37 +
1.38 +PROJECT_NAME = "ucx"
1.39 +
1.40 +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
1.41 +# could be handy for archiving the generated documentation or if some version
1.42 +# control system is used.
1.43 +
1.44 +PROJECT_NUMBER =
1.45 +
1.46 +# Using the PROJECT_BRIEF tag one can provide an optional one line description
1.47 +# for a project that appears at the top of each page and should give viewer a
1.48 +# quick idea about the purpose of the project. Keep the description short.
1.49 +
1.50 +PROJECT_BRIEF = "UAP Common Extensions"
1.51 +
1.52 +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
1.53 +# the documentation. The maximum height of the logo should not exceed 55 pixels
1.54 +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
1.55 +# to the output directory.
1.56 +
1.57 +PROJECT_LOGO = @DOXY_PROJECT_LOGO@
1.58 +
1.59 +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
1.60 +# into which the generated documentation will be written. If a relative path is
1.61 +# entered, it will be relative to the location where doxygen was started. If
1.62 +# left blank the current directory will be used.
1.63 +
1.64 +OUTPUT_DIRECTORY = @DOXY_OUTPUT_DIRECTORY@
1.65 +
1.66 +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
1.67 +# directories (in 2 levels) under the output directory of each output format and
1.68 +# will distribute the generated files over these directories. Enabling this
1.69 +# option can be useful when feeding doxygen a huge amount of source files, where
1.70 +# putting all generated files in the same directory would otherwise causes
1.71 +# performance problems for the file system.
1.72 +# The default value is: NO.
1.73 +
1.74 +CREATE_SUBDIRS = NO
1.75 +
1.76 +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
1.77 +# characters to appear in the names of generated files. If set to NO, non-ASCII
1.78 +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
1.79 +# U+3044.
1.80 +# The default value is: NO.
1.81 +
1.82 +ALLOW_UNICODE_NAMES = NO
1.83 +
1.84 +# The OUTPUT_LANGUAGE tag is used to specify the language in which all
1.85 +# documentation generated by doxygen is written. Doxygen will use this
1.86 +# information to generate all constant output in the proper language.
1.87 +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
1.88 +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
1.89 +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
1.90 +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
1.91 +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
1.92 +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
1.93 +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
1.94 +# Ukrainian and Vietnamese.
1.95 +# The default value is: English.
1.96 +
1.97 +OUTPUT_LANGUAGE = English
1.98 +
1.99 +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
1.100 +# descriptions after the members that are listed in the file and class
1.101 +# documentation (similar to Javadoc). Set to NO to disable this.
1.102 +# The default value is: YES.
1.103 +
1.104 +BRIEF_MEMBER_DESC = YES
1.105 +
1.106 +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
1.107 +# description of a member or function before the detailed description
1.108 +#
1.109 +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
1.110 +# brief descriptions will be completely suppressed.
1.111 +# The default value is: YES.
1.112 +
1.113 +REPEAT_BRIEF = YES
1.114 +
1.115 +# This tag implements a quasi-intelligent brief description abbreviator that is
1.116 +# used to form the text in various listings. Each string in this list, if found
1.117 +# as the leading text of the brief description, will be stripped from the text
1.118 +# and the result, after processing the whole list, is used as the annotated
1.119 +# text. Otherwise, the brief description is used as-is. If left blank, the
1.120 +# following values are used ($name is automatically replaced with the name of
1.121 +# the entity):The $name class, The $name widget, The $name file, is, provides,
1.122 +# specifies, contains, represents, a, an and the.
1.123 +
1.124 +ABBREVIATE_BRIEF =
1.125 +
1.126 +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
1.127 +# doxygen will generate a detailed section even if there is only a brief
1.128 +# description.
1.129 +# The default value is: NO.
1.130 +
1.131 +ALWAYS_DETAILED_SEC = NO
1.132 +
1.133 +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
1.134 +# inherited members of a class in the documentation of that class as if those
1.135 +# members were ordinary class members. Constructors, destructors and assignment
1.136 +# operators of the base classes will not be shown.
1.137 +# The default value is: NO.
1.138 +
1.139 +INLINE_INHERITED_MEMB = NO
1.140 +
1.141 +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
1.142 +# before files name in the file list and in the header files. If set to NO the
1.143 +# shortest path that makes the file name unique will be used
1.144 +# The default value is: YES.
1.145 +
1.146 +FULL_PATH_NAMES = YES
1.147 +
1.148 +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
1.149 +# Stripping is only done if one of the specified strings matches the left-hand
1.150 +# part of the path. The tag can be used to show relative paths in the file list.
1.151 +# If left blank the directory from which doxygen is run is used as the path to
1.152 +# strip.
1.153 +#
1.154 +# Note that you can specify absolute paths here, but also relative paths, which
1.155 +# will be relative from the directory where doxygen is started.
1.156 +# This tag requires that the tag FULL_PATH_NAMES is set to YES.
1.157 +
1.158 +STRIP_FROM_PATH =
1.159 +
1.160 +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
1.161 +# path mentioned in the documentation of a class, which tells the reader which
1.162 +# header file to include in order to use a class. If left blank only the name of
1.163 +# the header file containing the class definition is used. Otherwise one should
1.164 +# specify the list of include paths that are normally passed to the compiler
1.165 +# using the -I flag.
1.166 +
1.167 +STRIP_FROM_INC_PATH =
1.168 +
1.169 +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
1.170 +# less readable) file names. This can be useful is your file systems doesn't
1.171 +# support long names like on DOS, Mac, or CD-ROM.
1.172 +# The default value is: NO.
1.173 +
1.174 +SHORT_NAMES = NO
1.175 +
1.176 +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
1.177 +# first line (until the first dot) of a Javadoc-style comment as the brief
1.178 +# description. If set to NO, the Javadoc-style will behave just like regular Qt-
1.179 +# style comments (thus requiring an explicit @brief command for a brief
1.180 +# description.)
1.181 +# The default value is: NO.
1.182 +
1.183 +JAVADOC_AUTOBRIEF = YES
1.184 +
1.185 +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
1.186 +# line (until the first dot) of a Qt-style comment as the brief description. If
1.187 +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
1.188 +# requiring an explicit \brief command for a brief description.)
1.189 +# The default value is: NO.
1.190 +
1.191 +QT_AUTOBRIEF = NO
1.192 +
1.193 +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
1.194 +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
1.195 +# a brief description. This used to be the default behavior. The new default is
1.196 +# to treat a multi-line C++ comment block as a detailed description. Set this
1.197 +# tag to YES if you prefer the old behavior instead.
1.198 +#
1.199 +# Note that setting this tag to YES also means that rational rose comments are
1.200 +# not recognized any more.
1.201 +# The default value is: NO.
1.202 +
1.203 +MULTILINE_CPP_IS_BRIEF = NO
1.204 +
1.205 +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
1.206 +# documentation from any documented member that it re-implements.
1.207 +# The default value is: YES.
1.208 +
1.209 +INHERIT_DOCS = YES
1.210 +
1.211 +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
1.212 +# new page for each member. If set to NO, the documentation of a member will be
1.213 +# part of the file/class/namespace that contains it.
1.214 +# The default value is: NO.
1.215 +
1.216 +SEPARATE_MEMBER_PAGES = NO
1.217 +
1.218 +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
1.219 +# uses this value to replace tabs by spaces in code fragments.
1.220 +# Minimum value: 1, maximum value: 16, default value: 4.
1.221 +
1.222 +TAB_SIZE = 4
1.223 +
1.224 +# This tag can be used to specify a number of aliases that act as commands in
1.225 +# the documentation. An alias has the form:
1.226 +# name=value
1.227 +# For example adding
1.228 +# "sideeffect=@par Side Effects:\n"
1.229 +# will allow you to put the command \sideeffect (or @sideeffect) in the
1.230 +# documentation, which will result in a user-defined paragraph with heading
1.231 +# "Side Effects:". You can put \n's in the value part of an alias to insert
1.232 +# newlines.
1.233 +
1.234 +ALIASES =
1.235 +
1.236 +# This tag can be used to specify a number of word-keyword mappings (TCL only).
1.237 +# A mapping has the form "name=value". For example adding "class=itcl::class"
1.238 +# will allow you to use the command class in the itcl::class meaning.
1.239 +
1.240 +TCL_SUBST =
1.241 +
1.242 +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
1.243 +# only. Doxygen will then generate output that is more tailored for C. For
1.244 +# instance, some of the names that are used will be different. The list of all
1.245 +# members will be omitted, etc.
1.246 +# The default value is: NO.
1.247 +
1.248 +OPTIMIZE_OUTPUT_FOR_C = YES
1.249 +
1.250 +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
1.251 +# Python sources only. Doxygen will then generate output that is more tailored
1.252 +# for that language. For instance, namespaces will be presented as packages,
1.253 +# qualified scopes will look different, etc.
1.254 +# The default value is: NO.
1.255 +
1.256 +OPTIMIZE_OUTPUT_JAVA = NO
1.257 +
1.258 +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
1.259 +# sources. Doxygen will then generate output that is tailored for Fortran.
1.260 +# The default value is: NO.
1.261 +
1.262 +OPTIMIZE_FOR_FORTRAN = NO
1.263 +
1.264 +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
1.265 +# sources. Doxygen will then generate output that is tailored for VHDL.
1.266 +# The default value is: NO.
1.267 +
1.268 +OPTIMIZE_OUTPUT_VHDL = NO
1.269 +
1.270 +# Doxygen selects the parser to use depending on the extension of the files it
1.271 +# parses. With this tag you can assign which parser to use for a given
1.272 +# extension. Doxygen has a built-in mapping, but you can override or extend it
1.273 +# using this tag. The format is ext=language, where ext is a file extension, and
1.274 +# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
1.275 +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
1.276 +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
1.277 +# Fortran. In the later case the parser tries to guess whether the code is fixed
1.278 +# or free formatted code, this is the default for Fortran type files), VHDL. For
1.279 +# instance to make doxygen treat .inc files as Fortran files (default is PHP),
1.280 +# and .f files as C (default is Fortran), use: inc=Fortran f=C.
1.281 +#
1.282 +# Note For files without extension you can use no_extension as a placeholder.
1.283 +#
1.284 +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
1.285 +# the files are not read by doxygen.
1.286 +
1.287 +EXTENSION_MAPPING =
1.288 +
1.289 +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
1.290 +# according to the Markdown format, which allows for more readable
1.291 +# documentation. See http://daringfireball.net/projects/markdown/ for details.
1.292 +# The output of markdown processing is further processed by doxygen, so you can
1.293 +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
1.294 +# case of backward compatibilities issues.
1.295 +# The default value is: YES.
1.296 +
1.297 +MARKDOWN_SUPPORT = YES
1.298 +
1.299 +# When enabled doxygen tries to link words that correspond to documented
1.300 +# classes, or namespaces to their corresponding documentation. Such a link can
1.301 +# be prevented in individual cases by by putting a % sign in front of the word
1.302 +# or globally by setting AUTOLINK_SUPPORT to NO.
1.303 +# The default value is: YES.
1.304 +
1.305 +AUTOLINK_SUPPORT = YES
1.306 +
1.307 +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
1.308 +# to include (a tag file for) the STL sources as input, then you should set this
1.309 +# tag to YES in order to let doxygen match functions declarations and
1.310 +# definitions whose arguments contain STL classes (e.g. func(std::string);
1.311 +# versus func(std::string) {}). This also make the inheritance and collaboration
1.312 +# diagrams that involve STL classes more complete and accurate.
1.313 +# The default value is: NO.
1.314 +
1.315 +BUILTIN_STL_SUPPORT = NO
1.316 +
1.317 +# If you use Microsoft's C++/CLI language, you should set this option to YES to
1.318 +# enable parsing support.
1.319 +# The default value is: NO.
1.320 +
1.321 +CPP_CLI_SUPPORT = NO
1.322 +
1.323 +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
1.324 +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
1.325 +# will parse them like normal C++ but will assume all classes use public instead
1.326 +# of private inheritance when no explicit protection keyword is present.
1.327 +# The default value is: NO.
1.328 +
1.329 +SIP_SUPPORT = NO
1.330 +
1.331 +# For Microsoft's IDL there are propget and propput attributes to indicate
1.332 +# getter and setter methods for a property. Setting this option to YES will make
1.333 +# doxygen to replace the get and set methods by a property in the documentation.
1.334 +# This will only work if the methods are indeed getting or setting a simple
1.335 +# type. If this is not the case, or you want to show the methods anyway, you
1.336 +# should set this option to NO.
1.337 +# The default value is: YES.
1.338 +
1.339 +IDL_PROPERTY_SUPPORT = YES
1.340 +
1.341 +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
1.342 +# tag is set to YES, then doxygen will reuse the documentation of the first
1.343 +# member in the group (if any) for the other members of the group. By default
1.344 +# all members of a group must be documented explicitly.
1.345 +# The default value is: NO.
1.346 +
1.347 +DISTRIBUTE_GROUP_DOC = NO
1.348 +
1.349 +# Set the SUBGROUPING tag to YES to allow class member groups of the same type
1.350 +# (for instance a group of public functions) to be put as a subgroup of that
1.351 +# type (e.g. under the Public Functions section). Set it to NO to prevent
1.352 +# subgrouping. Alternatively, this can be done per class using the
1.353 +# \nosubgrouping command.
1.354 +# The default value is: YES.
1.355 +
1.356 +SUBGROUPING = YES
1.357 +
1.358 +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
1.359 +# are shown inside the group in which they are included (e.g. using \ingroup)
1.360 +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
1.361 +# and RTF).
1.362 +#
1.363 +# Note that this feature does not work in combination with
1.364 +# SEPARATE_MEMBER_PAGES.
1.365 +# The default value is: NO.
1.366 +
1.367 +INLINE_GROUPED_CLASSES = NO
1.368 +
1.369 +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
1.370 +# with only public data fields or simple typedef fields will be shown inline in
1.371 +# the documentation of the scope in which they are defined (i.e. file,
1.372 +# namespace, or group documentation), provided this scope is documented. If set
1.373 +# to NO, structs, classes, and unions are shown on a separate page (for HTML and
1.374 +# Man pages) or section (for LaTeX and RTF).
1.375 +# The default value is: NO.
1.376 +
1.377 +INLINE_SIMPLE_STRUCTS = NO
1.378 +
1.379 +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
1.380 +# enum is documented as struct, union, or enum with the name of the typedef. So
1.381 +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
1.382 +# with name TypeT. When disabled the typedef will appear as a member of a file,
1.383 +# namespace, or class. And the struct will be named TypeS. This can typically be
1.384 +# useful for C code in case the coding convention dictates that all compound
1.385 +# types are typedef'ed and only the typedef is referenced, never the tag name.
1.386 +# The default value is: NO.
1.387 +
1.388 +TYPEDEF_HIDES_STRUCT = NO
1.389 +
1.390 +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
1.391 +# cache is used to resolve symbols given their name and scope. Since this can be
1.392 +# an expensive process and often the same symbol appears multiple times in the
1.393 +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
1.394 +# doxygen will become slower. If the cache is too large, memory is wasted. The
1.395 +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
1.396 +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
1.397 +# symbols. At the end of a run doxygen will report the cache usage and suggest
1.398 +# the optimal cache size from a speed point of view.
1.399 +# Minimum value: 0, maximum value: 9, default value: 0.
1.400 +
1.401 +LOOKUP_CACHE_SIZE = 0
1.402 +
1.403 +#---------------------------------------------------------------------------
1.404 +# Build related configuration options
1.405 +#---------------------------------------------------------------------------
1.406 +
1.407 +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
1.408 +# documentation are documented, even if no documentation was available. Private
1.409 +# class members and static file members will be hidden unless the
1.410 +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
1.411 +# Note: This will also disable the warnings about undocumented members that are
1.412 +# normally produced when WARNINGS is set to YES.
1.413 +# The default value is: NO.
1.414 +
1.415 +EXTRACT_ALL = NO
1.416 +
1.417 +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
1.418 +# be included in the documentation.
1.419 +# The default value is: NO.
1.420 +
1.421 +EXTRACT_PRIVATE = NO
1.422 +
1.423 +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
1.424 +# scope will be included in the documentation.
1.425 +# The default value is: NO.
1.426 +
1.427 +EXTRACT_PACKAGE = NO
1.428 +
1.429 +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
1.430 +# included in the documentation.
1.431 +# The default value is: NO.
1.432 +
1.433 +EXTRACT_STATIC = NO
1.434 +
1.435 +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
1.436 +# locally in source files will be included in the documentation. If set to NO
1.437 +# only classes defined in header files are included. Does not have any effect
1.438 +# for Java sources.
1.439 +# The default value is: YES.
1.440 +
1.441 +EXTRACT_LOCAL_CLASSES = YES
1.442 +
1.443 +# This flag is only useful for Objective-C code. When set to YES local methods,
1.444 +# which are defined in the implementation section but not in the interface are
1.445 +# included in the documentation. If set to NO only methods in the interface are
1.446 +# included.
1.447 +# The default value is: NO.
1.448 +
1.449 +EXTRACT_LOCAL_METHODS = NO
1.450 +
1.451 +# If this flag is set to YES, the members of anonymous namespaces will be
1.452 +# extracted and appear in the documentation as a namespace called
1.453 +# 'anonymous_namespace{file}', where file will be replaced with the base name of
1.454 +# the file that contains the anonymous namespace. By default anonymous namespace
1.455 +# are hidden.
1.456 +# The default value is: NO.
1.457 +
1.458 +EXTRACT_ANON_NSPACES = NO
1.459 +
1.460 +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
1.461 +# undocumented members inside documented classes or files. If set to NO these
1.462 +# members will be included in the various overviews, but no documentation
1.463 +# section is generated. This option has no effect if EXTRACT_ALL is enabled.
1.464 +# The default value is: NO.
1.465 +
1.466 +HIDE_UNDOC_MEMBERS = NO
1.467 +
1.468 +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
1.469 +# undocumented classes that are normally visible in the class hierarchy. If set
1.470 +# to NO these classes will be included in the various overviews. This option has
1.471 +# no effect if EXTRACT_ALL is enabled.
1.472 +# The default value is: NO.
1.473 +
1.474 +HIDE_UNDOC_CLASSES = NO
1.475 +
1.476 +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
1.477 +# (class|struct|union) declarations. If set to NO these declarations will be
1.478 +# included in the documentation.
1.479 +# The default value is: NO.
1.480 +
1.481 +HIDE_FRIEND_COMPOUNDS = NO
1.482 +
1.483 +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
1.484 +# documentation blocks found inside the body of a function. If set to NO these
1.485 +# blocks will be appended to the function's detailed documentation block.
1.486 +# The default value is: NO.
1.487 +
1.488 +HIDE_IN_BODY_DOCS = NO
1.489 +
1.490 +# The INTERNAL_DOCS tag determines if documentation that is typed after a
1.491 +# \internal command is included. If the tag is set to NO then the documentation
1.492 +# will be excluded. Set it to YES to include the internal documentation.
1.493 +# The default value is: NO.
1.494 +
1.495 +INTERNAL_DOCS = NO
1.496 +
1.497 +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
1.498 +# names in lower-case letters. If set to YES upper-case letters are also
1.499 +# allowed. This is useful if you have classes or files whose names only differ
1.500 +# in case and if your file system supports case sensitive file names. Windows
1.501 +# and Mac users are advised to set this option to NO.
1.502 +# The default value is: system dependent.
1.503 +
1.504 +CASE_SENSE_NAMES = YES
1.505 +
1.506 +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
1.507 +# their full class and namespace scopes in the documentation. If set to YES the
1.508 +# scope will be hidden.
1.509 +# The default value is: NO.
1.510 +
1.511 +HIDE_SCOPE_NAMES = NO
1.512 +
1.513 +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
1.514 +# the files that are included by a file in the documentation of that file.
1.515 +# The default value is: YES.
1.516 +
1.517 +SHOW_INCLUDE_FILES = YES
1.518 +
1.519 +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
1.520 +# grouped member an include statement to the documentation, telling the reader
1.521 +# which file to include in order to use the member.
1.522 +# The default value is: NO.
1.523 +
1.524 +SHOW_GROUPED_MEMB_INC = NO
1.525 +
1.526 +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
1.527 +# files with double quotes in the documentation rather than with sharp brackets.
1.528 +# The default value is: NO.
1.529 +
1.530 +FORCE_LOCAL_INCLUDES = NO
1.531 +
1.532 +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
1.533 +# documentation for inline members.
1.534 +# The default value is: YES.
1.535 +
1.536 +INLINE_INFO = YES
1.537 +
1.538 +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
1.539 +# (detailed) documentation of file and class members alphabetically by member
1.540 +# name. If set to NO the members will appear in declaration order.
1.541 +# The default value is: YES.
1.542 +
1.543 +SORT_MEMBER_DOCS = YES
1.544 +
1.545 +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
1.546 +# descriptions of file, namespace and class members alphabetically by member
1.547 +# name. If set to NO the members will appear in declaration order. Note that
1.548 +# this will also influence the order of the classes in the class list.
1.549 +# The default value is: NO.
1.550 +
1.551 +SORT_BRIEF_DOCS = NO
1.552 +
1.553 +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
1.554 +# (brief and detailed) documentation of class members so that constructors and
1.555 +# destructors are listed first. If set to NO the constructors will appear in the
1.556 +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
1.557 +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
1.558 +# member documentation.
1.559 +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
1.560 +# detailed member documentation.
1.561 +# The default value is: NO.
1.562 +
1.563 +SORT_MEMBERS_CTORS_1ST = NO
1.564 +
1.565 +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
1.566 +# of group names into alphabetical order. If set to NO the group names will
1.567 +# appear in their defined order.
1.568 +# The default value is: NO.
1.569 +
1.570 +SORT_GROUP_NAMES = NO
1.571 +
1.572 +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
1.573 +# fully-qualified names, including namespaces. If set to NO, the class list will
1.574 +# be sorted only by class name, not including the namespace part.
1.575 +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
1.576 +# Note: This option applies only to the class list, not to the alphabetical
1.577 +# list.
1.578 +# The default value is: NO.
1.579 +
1.580 +SORT_BY_SCOPE_NAME = NO
1.581 +
1.582 +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
1.583 +# type resolution of all parameters of a function it will reject a match between
1.584 +# the prototype and the implementation of a member function even if there is
1.585 +# only one candidate or it is obvious which candidate to choose by doing a
1.586 +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
1.587 +# accept a match between prototype and implementation in such cases.
1.588 +# The default value is: NO.
1.589 +
1.590 +STRICT_PROTO_MATCHING = NO
1.591 +
1.592 +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
1.593 +# todo list. This list is created by putting \todo commands in the
1.594 +# documentation.
1.595 +# The default value is: YES.
1.596 +
1.597 +GENERATE_TODOLIST = YES
1.598 +
1.599 +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
1.600 +# test list. This list is created by putting \test commands in the
1.601 +# documentation.
1.602 +# The default value is: YES.
1.603 +
1.604 +GENERATE_TESTLIST = YES
1.605 +
1.606 +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
1.607 +# list. This list is created by putting \bug commands in the documentation.
1.608 +# The default value is: YES.
1.609 +
1.610 +GENERATE_BUGLIST = YES
1.611 +
1.612 +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
1.613 +# the deprecated list. This list is created by putting \deprecated commands in
1.614 +# the documentation.
1.615 +# The default value is: YES.
1.616 +
1.617 +GENERATE_DEPRECATEDLIST= YES
1.618 +
1.619 +# The ENABLED_SECTIONS tag can be used to enable conditional documentation
1.620 +# sections, marked by \if <section_label> ... \endif and \cond <section_label>
1.621 +# ... \endcond blocks.
1.622 +
1.623 +ENABLED_SECTIONS =
1.624 +
1.625 +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
1.626 +# initial value of a variable or macro / define can have for it to appear in the
1.627 +# documentation. If the initializer consists of more lines than specified here
1.628 +# it will be hidden. Use a value of 0 to hide initializers completely. The
1.629 +# appearance of the value of individual variables and macros / defines can be
1.630 +# controlled using \showinitializer or \hideinitializer command in the
1.631 +# documentation regardless of this setting.
1.632 +# Minimum value: 0, maximum value: 10000, default value: 30.
1.633 +
1.634 +MAX_INITIALIZER_LINES = 30
1.635 +
1.636 +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
1.637 +# the bottom of the documentation of classes and structs. If set to YES the list
1.638 +# will mention the files that were used to generate the documentation.
1.639 +# The default value is: YES.
1.640 +
1.641 +SHOW_USED_FILES = YES
1.642 +
1.643 +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
1.644 +# will remove the Files entry from the Quick Index and from the Folder Tree View
1.645 +# (if specified).
1.646 +# The default value is: YES.
1.647 +
1.648 +SHOW_FILES = YES
1.649 +
1.650 +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
1.651 +# page. This will remove the Namespaces entry from the Quick Index and from the
1.652 +# Folder Tree View (if specified).
1.653 +# The default value is: YES.
1.654 +
1.655 +SHOW_NAMESPACES = YES
1.656 +
1.657 +# The FILE_VERSION_FILTER tag can be used to specify a program or script that
1.658 +# doxygen should invoke to get the current version for each file (typically from
1.659 +# the version control system). Doxygen will invoke the program by executing (via
1.660 +# popen()) the command command input-file, where command is the value of the
1.661 +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
1.662 +# by doxygen. Whatever the program writes to standard output is used as the file
1.663 +# version. For an example see the documentation.
1.664 +
1.665 +FILE_VERSION_FILTER =
1.666 +
1.667 +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
1.668 +# by doxygen. The layout file controls the global structure of the generated
1.669 +# output files in an output format independent way. To create the layout file
1.670 +# that represents doxygen's defaults, run doxygen with the -l option. You can
1.671 +# optionally specify a file name after the option, if omitted DoxygenLayout.xml
1.672 +# will be used as the name of the layout file.
1.673 +#
1.674 +# Note that if you run doxygen from a directory containing a file called
1.675 +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
1.676 +# tag is left empty.
1.677 +
1.678 +LAYOUT_FILE =
1.679 +
1.680 +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
1.681 +# the reference definitions. This must be a list of .bib files. The .bib
1.682 +# extension is automatically appended if omitted. This requires the bibtex tool
1.683 +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
1.684 +# For LaTeX the style of the bibliography can be controlled using
1.685 +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
1.686 +# search path. Do not use file names with spaces, bibtex cannot handle them. See
1.687 +# also \cite for info how to create references.
1.688 +
1.689 +CITE_BIB_FILES =
1.690 +
1.691 +#---------------------------------------------------------------------------
1.692 +# Configuration options related to warning and progress messages
1.693 +#---------------------------------------------------------------------------
1.694 +
1.695 +# The QUIET tag can be used to turn on/off the messages that are generated to
1.696 +# standard output by doxygen. If QUIET is set to YES this implies that the
1.697 +# messages are off.
1.698 +# The default value is: NO.
1.699 +
1.700 +QUIET = YES
1.701 +
1.702 +# The WARNINGS tag can be used to turn on/off the warning messages that are
1.703 +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
1.704 +# this implies that the warnings are on.
1.705 +#
1.706 +# Tip: Turn warnings on while writing the documentation.
1.707 +# The default value is: YES.
1.708 +
1.709 +WARNINGS = YES
1.710 +
1.711 +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
1.712 +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
1.713 +# will automatically be disabled.
1.714 +# The default value is: YES.
1.715 +
1.716 +WARN_IF_UNDOCUMENTED = YES
1.717 +
1.718 +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
1.719 +# potential errors in the documentation, such as not documenting some parameters
1.720 +# in a documented function, or documenting parameters that don't exist or using
1.721 +# markup commands wrongly.
1.722 +# The default value is: YES.
1.723 +
1.724 +WARN_IF_DOC_ERROR = YES
1.725 +
1.726 +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
1.727 +# are documented, but have no documentation for their parameters or return
1.728 +# value. If set to NO doxygen will only warn about wrong or incomplete parameter
1.729 +# documentation, but not about the absence of documentation.
1.730 +# The default value is: NO.
1.731 +
1.732 +WARN_NO_PARAMDOC = YES
1.733 +
1.734 +# The WARN_FORMAT tag determines the format of the warning messages that doxygen
1.735 +# can produce. The string should contain the $file, $line, and $text tags, which
1.736 +# will be replaced by the file and line number from which the warning originated
1.737 +# and the warning text. Optionally the format may contain $version, which will
1.738 +# be replaced by the version of the file (if it could be obtained via
1.739 +# FILE_VERSION_FILTER)
1.740 +# The default value is: $file:$line: $text.
1.741 +
1.742 +WARN_FORMAT = "$file:$line: $text"
1.743 +
1.744 +# The WARN_LOGFILE tag can be used to specify a file to which warning and error
1.745 +# messages should be written. If left blank the output is written to standard
1.746 +# error (stderr).
1.747 +
1.748 +WARN_LOGFILE =
1.749 +
1.750 +#---------------------------------------------------------------------------
1.751 +# Configuration options related to the input files
1.752 +#---------------------------------------------------------------------------
1.753 +
1.754 +# The INPUT tag is used to specify the files and/or directories that contain
1.755 +# documented source files. You may enter file names like myfile.cpp or
1.756 +# directories like /usr/src/myproject. Separate the files or directories with
1.757 +# spaces.
1.758 +# Note: If this tag is empty the current directory is searched.
1.759 +
1.760 +INPUT = @DOXY_INPUT@
1.761 +
1.762 +# This tag can be used to specify the character encoding of the source files
1.763 +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
1.764 +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
1.765 +# documentation (see: http://www.gnu.org/software/libiconv) for the list of
1.766 +# possible encodings.
1.767 +# The default value is: UTF-8.
1.768 +
1.769 +INPUT_ENCODING = UTF-8
1.770 +
1.771 +# If the value of the INPUT tag contains directories, you can use the
1.772 +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
1.773 +# *.h) to filter out the source-files in the directories. If left blank the
1.774 +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
1.775 +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
1.776 +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
1.777 +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
1.778 +# *.qsf, *.as and *.js.
1.779 +
1.780 +FILE_PATTERNS =
1.781 +
1.782 +# The RECURSIVE tag can be used to specify whether or not subdirectories should
1.783 +# be searched for input files as well.
1.784 +# The default value is: NO.
1.785 +
1.786 +RECURSIVE = YES
1.787 +
1.788 +# The EXCLUDE tag can be used to specify files and/or directories that should be
1.789 +# excluded from the INPUT source files. This way you can easily exclude a
1.790 +# subdirectory from a directory tree whose root is specified with the INPUT tag.
1.791 +#
1.792 +# Note that relative paths are relative to the directory from which doxygen is
1.793 +# run.
1.794 +
1.795 +EXCLUDE =
1.796 +
1.797 +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
1.798 +# directories that are symbolic links (a Unix file system feature) are excluded
1.799 +# from the input.
1.800 +# The default value is: NO.
1.801 +
1.802 +EXCLUDE_SYMLINKS = NO
1.803 +
1.804 +# If the value of the INPUT tag contains directories, you can use the
1.805 +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
1.806 +# certain files from those directories.
1.807 +#
1.808 +# Note that the wildcards are matched against the file with absolute path, so to
1.809 +# exclude all test directories for example use the pattern */test/*
1.810 +
1.811 +EXCLUDE_PATTERNS =
1.812 +
1.813 +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
1.814 +# (namespaces, classes, functions, etc.) that should be excluded from the
1.815 +# output. The symbol name can be a fully qualified name, a word, or if the
1.816 +# wildcard * is used, a substring. Examples: ANamespace, AClass,
1.817 +# AClass::ANamespace, ANamespace::*Test
1.818 +#
1.819 +# Note that the wildcards are matched against the file with absolute path, so to
1.820 +# exclude all test directories use the pattern */test/*
1.821 +
1.822 +EXCLUDE_SYMBOLS =
1.823 +
1.824 +# The EXAMPLE_PATH tag can be used to specify one or more files or directories
1.825 +# that contain example code fragments that are included (see the \include
1.826 +# command).
1.827 +
1.828 +EXAMPLE_PATH =
1.829 +
1.830 +# If the value of the EXAMPLE_PATH tag contains directories, you can use the
1.831 +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
1.832 +# *.h) to filter out the source-files in the directories. If left blank all
1.833 +# files are included.
1.834 +
1.835 +EXAMPLE_PATTERNS =
1.836 +
1.837 +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1.838 +# searched for input files to be used with the \include or \dontinclude commands
1.839 +# irrespective of the value of the RECURSIVE tag.
1.840 +# The default value is: NO.
1.841 +
1.842 +EXAMPLE_RECURSIVE = NO
1.843 +
1.844 +# The IMAGE_PATH tag can be used to specify one or more files or directories
1.845 +# that contain images that are to be included in the documentation (see the
1.846 +# \image command).
1.847 +
1.848 +IMAGE_PATH =
1.849 +
1.850 +# The INPUT_FILTER tag can be used to specify a program that doxygen should
1.851 +# invoke to filter for each input file. Doxygen will invoke the filter program
1.852 +# by executing (via popen()) the command:
1.853 +#
1.854 +# <filter> <input-file>
1.855 +#
1.856 +# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1.857 +# name of an input file. Doxygen will then use the output that the filter
1.858 +# program writes to standard output. If FILTER_PATTERNS is specified, this tag
1.859 +# will be ignored.
1.860 +#
1.861 +# Note that the filter must not add or remove lines; it is applied before the
1.862 +# code is scanned, but not when the output code is generated. If lines are added
1.863 +# or removed, the anchors will not be placed correctly.
1.864 +
1.865 +INPUT_FILTER =
1.866 +
1.867 +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1.868 +# basis. Doxygen will compare the file name with each pattern and apply the
1.869 +# filter if there is a match. The filters are a list of the form: pattern=filter
1.870 +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
1.871 +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1.872 +# patterns match the file name, INPUT_FILTER is applied.
1.873 +
1.874 +FILTER_PATTERNS =
1.875 +
1.876 +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1.877 +# INPUT_FILTER ) will also be used to filter the input files that are used for
1.878 +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1.879 +# The default value is: NO.
1.880 +
1.881 +FILTER_SOURCE_FILES = NO
1.882 +
1.883 +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1.884 +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1.885 +# it is also possible to disable source filtering for a specific pattern using
1.886 +# *.ext= (so without naming a filter).
1.887 +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1.888 +
1.889 +FILTER_SOURCE_PATTERNS =
1.890 +
1.891 +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1.892 +# is part of the input, its contents will be placed on the main page
1.893 +# (index.html). This can be useful if you have a project on for instance GitHub
1.894 +# and want to reuse the introduction page also for the doxygen output.
1.895 +
1.896 +USE_MDFILE_AS_MAINPAGE =
1.897 +
1.898 +#---------------------------------------------------------------------------
1.899 +# Configuration options related to source browsing
1.900 +#---------------------------------------------------------------------------
1.901 +
1.902 +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1.903 +# generated. Documented entities will be cross-referenced with these sources.
1.904 +#
1.905 +# Note: To get rid of all source code in the generated output, make sure that
1.906 +# also VERBATIM_HEADERS is set to NO.
1.907 +# The default value is: NO.
1.908 +
1.909 +SOURCE_BROWSER = NO
1.910 +
1.911 +# Setting the INLINE_SOURCES tag to YES will include the body of functions,
1.912 +# classes and enums directly into the documentation.
1.913 +# The default value is: NO.
1.914 +
1.915 +INLINE_SOURCES = NO
1.916 +
1.917 +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1.918 +# special comment blocks from generated source code fragments. Normal C, C++ and
1.919 +# Fortran comments will always remain visible.
1.920 +# The default value is: YES.
1.921 +
1.922 +STRIP_CODE_COMMENTS = YES
1.923 +
1.924 +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1.925 +# function all documented functions referencing it will be listed.
1.926 +# The default value is: NO.
1.927 +
1.928 +REFERENCED_BY_RELATION = NO
1.929 +
1.930 +# If the REFERENCES_RELATION tag is set to YES then for each documented function
1.931 +# all documented entities called/used by that function will be listed.
1.932 +# The default value is: NO.
1.933 +
1.934 +REFERENCES_RELATION = NO
1.935 +
1.936 +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1.937 +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
1.938 +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1.939 +# link to the documentation.
1.940 +# The default value is: YES.
1.941 +
1.942 +REFERENCES_LINK_SOURCE = YES
1.943 +
1.944 +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1.945 +# source code will show a tooltip with additional information such as prototype,
1.946 +# brief description and links to the definition and documentation. Since this
1.947 +# will make the HTML file larger and loading of large files a bit slower, you
1.948 +# can opt to disable this feature.
1.949 +# The default value is: YES.
1.950 +# This tag requires that the tag SOURCE_BROWSER is set to YES.
1.951 +
1.952 +SOURCE_TOOLTIPS = YES
1.953 +
1.954 +# If the USE_HTAGS tag is set to YES then the references to source code will
1.955 +# point to the HTML generated by the htags(1) tool instead of doxygen built-in
1.956 +# source browser. The htags tool is part of GNU's global source tagging system
1.957 +# (see http://www.gnu.org/software/global/global.html). You will need version
1.958 +# 4.8.6 or higher.
1.959 +#
1.960 +# To use it do the following:
1.961 +# - Install the latest version of global
1.962 +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
1.963 +# - Make sure the INPUT points to the root of the source tree
1.964 +# - Run doxygen as normal
1.965 +#
1.966 +# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1.967 +# tools must be available from the command line (i.e. in the search path).
1.968 +#
1.969 +# The result: instead of the source browser generated by doxygen, the links to
1.970 +# source code will now point to the output of htags.
1.971 +# The default value is: NO.
1.972 +# This tag requires that the tag SOURCE_BROWSER is set to YES.
1.973 +
1.974 +USE_HTAGS = NO
1.975 +
1.976 +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1.977 +# verbatim copy of the header file for each class for which an include is
1.978 +# specified. Set to NO to disable this.
1.979 +# See also: Section \class.
1.980 +# The default value is: YES.
1.981 +
1.982 +VERBATIM_HEADERS = YES
1.983 +
1.984 +#---------------------------------------------------------------------------
1.985 +# Configuration options related to the alphabetical class index
1.986 +#---------------------------------------------------------------------------
1.987 +
1.988 +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1.989 +# compounds will be generated. Enable this if the project contains a lot of
1.990 +# classes, structs, unions or interfaces.
1.991 +# The default value is: YES.
1.992 +
1.993 +ALPHABETICAL_INDEX = YES
1.994 +
1.995 +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1.996 +# which the alphabetical index list will be split.
1.997 +# Minimum value: 1, maximum value: 20, default value: 5.
1.998 +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1.999 +
1.1000 +COLS_IN_ALPHA_INDEX = 5
1.1001 +
1.1002 +# In case all classes in a project start with a common prefix, all classes will
1.1003 +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1.1004 +# can be used to specify a prefix (or a list of prefixes) that should be ignored
1.1005 +# while generating the index headers.
1.1006 +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1.1007 +
1.1008 +IGNORE_PREFIX =
1.1009 +
1.1010 +#---------------------------------------------------------------------------
1.1011 +# Configuration options related to the HTML output
1.1012 +#---------------------------------------------------------------------------
1.1013 +
1.1014 +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1.1015 +# The default value is: YES.
1.1016 +
1.1017 +GENERATE_HTML = YES
1.1018 +
1.1019 +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1.1020 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1.1021 +# it.
1.1022 +# The default directory is: html.
1.1023 +# This tag requires that the tag GENERATE_HTML is set to YES.
1.1024 +
1.1025 +HTML_OUTPUT = web/api
1.1026 +
1.1027 +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1.1028 +# generated HTML page (for example: .htm, .php, .asp).
1.1029 +# The default value is: .html.
1.1030 +# This tag requires that the tag GENERATE_HTML is set to YES.
1.1031 +
1.1032 +HTML_FILE_EXTENSION = .html
1.1033 +
1.1034 +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1.1035 +# each generated HTML page. If the tag is left blank doxygen will generate a
1.1036 +# standard header.
1.1037 +#
1.1038 +# To get valid HTML the header file that includes any scripts and style sheets
1.1039 +# that doxygen needs, which is dependent on the configuration options used (e.g.
1.1040 +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1.1041 +# default header using
1.1042 +# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1.1043 +# YourConfigFile
1.1044 +# and then modify the file new_header.html. See also section "Doxygen usage"
1.1045 +# for information on how to generate the default header that doxygen normally
1.1046 +# uses.
1.1047 +# Note: The header is subject to change so you typically have to regenerate the
1.1048 +# default header when upgrading to a newer version of doxygen. For a description
1.1049 +# of the possible markers and block names see the documentation.
1.1050 +# This tag requires that the tag GENERATE_HTML is set to YES.
1.1051 +
1.1052 +HTML_HEADER =
1.1053 +
1.1054 +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1.1055 +# generated HTML page. If the tag is left blank doxygen will generate a standard
1.1056 +# footer. See HTML_HEADER for more information on how to generate a default
1.1057 +# footer and what special commands can be used inside the footer. See also
1.1058 +# section "Doxygen usage" for information on how to generate the default footer
1.1059 +# that doxygen normally uses.
1.1060 +# This tag requires that the tag GENERATE_HTML is set to YES.
1.1061 +
1.1062 +HTML_FOOTER =
1.1063 +
1.1064 +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1.1065 +# sheet that is used by each HTML page. It can be used to fine-tune the look of
1.1066 +# the HTML output. If left blank doxygen will generate a default style sheet.
1.1067 +# See also section "Doxygen usage" for information on how to generate the style
1.1068 +# sheet that doxygen normally uses.
1.1069 +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1.1070 +# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1.1071 +# obsolete.
1.1072 +# This tag requires that the tag GENERATE_HTML is set to YES.
1.1073 +
1.1074 +HTML_STYLESHEET =
1.1075 +
1.1076 +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1.1077 +# defined cascading style sheet that is included after the standard style sheets
1.1078 +# created by doxygen. Using this option one can overrule certain style aspects.
1.1079 +# This is preferred over using HTML_STYLESHEET since it does not replace the
1.1080 +# standard style sheet and is therefor more robust against future updates.
1.1081 +# Doxygen will copy the style sheet file to the output directory. For an example
1.1082 +# see the documentation.
1.1083 +# This tag requires that the tag GENERATE_HTML is set to YES.
1.1084 +
1.1085 +HTML_EXTRA_STYLESHEET =
1.1086 +
1.1087 +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1.1088 +# other source files which should be copied to the HTML output directory. Note
1.1089 +# that these files will be copied to the base HTML output directory. Use the
1.1090 +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1.1091 +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1.1092 +# files will be copied as-is; there are no commands or markers available.
1.1093 +# This tag requires that the tag GENERATE_HTML is set to YES.
1.1094 +
1.1095 +HTML_EXTRA_FILES =
1.1096 +
1.1097 +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1.1098 +# will adjust the colors in the stylesheet and background images according to
1.1099 +# this color. Hue is specified as an angle on a colorwheel, see
1.1100 +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1.1101 +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1.1102 +# purple, and 360 is red again.
1.1103 +# Minimum value: 0, maximum value: 359, default value: 220.
1.1104 +# This tag requires that the tag GENERATE_HTML is set to YES.
1.1105 +
1.1106 +HTML_COLORSTYLE_HUE = 220
1.1107 +
1.1108 +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1.1109 +# in the HTML output. For a value of 0 the output will use grayscales only. A
1.1110 +# value of 255 will produce the most vivid colors.
1.1111 +# Minimum value: 0, maximum value: 255, default value: 100.
1.1112 +# This tag requires that the tag GENERATE_HTML is set to YES.
1.1113 +
1.1114 +HTML_COLORSTYLE_SAT = 100
1.1115 +
1.1116 +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1.1117 +# luminance component of the colors in the HTML output. Values below 100
1.1118 +# gradually make the output lighter, whereas values above 100 make the output
1.1119 +# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1.1120 +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1.1121 +# change the gamma.
1.1122 +# Minimum value: 40, maximum value: 240, default value: 80.
1.1123 +# This tag requires that the tag GENERATE_HTML is set to YES.
1.1124 +
1.1125 +HTML_COLORSTYLE_GAMMA = 80
1.1126 +
1.1127 +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1.1128 +# page will contain the date and time when the page was generated. Setting this
1.1129 +# to NO can help when comparing the output of multiple runs.
1.1130 +# The default value is: YES.
1.1131 +# This tag requires that the tag GENERATE_HTML is set to YES.
1.1132 +
1.1133 +HTML_TIMESTAMP = YES
1.1134 +
1.1135 +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1.1136 +# documentation will contain sections that can be hidden and shown after the
1.1137 +# page has loaded.
1.1138 +# The default value is: NO.
1.1139 +# This tag requires that the tag GENERATE_HTML is set to YES.
1.1140 +
1.1141 +HTML_DYNAMIC_SECTIONS = NO
1.1142 +
1.1143 +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1.1144 +# shown in the various tree structured indices initially; the user can expand
1.1145 +# and collapse entries dynamically later on. Doxygen will expand the tree to
1.1146 +# such a level that at most the specified number of entries are visible (unless
1.1147 +# a fully collapsed tree already exceeds this amount). So setting the number of
1.1148 +# entries 1 will produce a full collapsed tree by default. 0 is a special value
1.1149 +# representing an infinite number of entries and will result in a full expanded
1.1150 +# tree by default.
1.1151 +# Minimum value: 0, maximum value: 9999, default value: 100.
1.1152 +# This tag requires that the tag GENERATE_HTML is set to YES.
1.1153 +
1.1154 +HTML_INDEX_NUM_ENTRIES = 100
1.1155 +
1.1156 +# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1.1157 +# generated that can be used as input for Apple's Xcode 3 integrated development
1.1158 +# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1.1159 +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1.1160 +# Makefile in the HTML output directory. Running make will produce the docset in
1.1161 +# that directory and running make install will install the docset in
1.1162 +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1.1163 +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1.1164 +# for more information.
1.1165 +# The default value is: NO.
1.1166 +# This tag requires that the tag GENERATE_HTML is set to YES.
1.1167 +
1.1168 +GENERATE_DOCSET = NO
1.1169 +
1.1170 +# This tag determines the name of the docset feed. A documentation feed provides
1.1171 +# an umbrella under which multiple documentation sets from a single provider
1.1172 +# (such as a company or product suite) can be grouped.
1.1173 +# The default value is: Doxygen generated docs.
1.1174 +# This tag requires that the tag GENERATE_DOCSET is set to YES.
1.1175 +
1.1176 +DOCSET_FEEDNAME = "Doxygen generated docs"
1.1177 +
1.1178 +# This tag specifies a string that should uniquely identify the documentation
1.1179 +# set bundle. This should be a reverse domain-name style string, e.g.
1.1180 +# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1.1181 +# The default value is: org.doxygen.Project.
1.1182 +# This tag requires that the tag GENERATE_DOCSET is set to YES.
1.1183 +
1.1184 +DOCSET_BUNDLE_ID = org.doxygen.Project
1.1185 +
1.1186 +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1.1187 +# the documentation publisher. This should be a reverse domain-name style
1.1188 +# string, e.g. com.mycompany.MyDocSet.documentation.
1.1189 +# The default value is: org.doxygen.Publisher.
1.1190 +# This tag requires that the tag GENERATE_DOCSET is set to YES.
1.1191 +
1.1192 +DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1.1193 +
1.1194 +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1.1195 +# The default value is: Publisher.
1.1196 +# This tag requires that the tag GENERATE_DOCSET is set to YES.
1.1197 +
1.1198 +DOCSET_PUBLISHER_NAME = Publisher
1.1199 +
1.1200 +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1.1201 +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1.1202 +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1.1203 +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1.1204 +# Windows.
1.1205 +#
1.1206 +# The HTML Help Workshop contains a compiler that can convert all HTML output
1.1207 +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1.1208 +# files are now used as the Windows 98 help format, and will replace the old
1.1209 +# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1.1210 +# HTML files also contain an index, a table of contents, and you can search for
1.1211 +# words in the documentation. The HTML workshop also contains a viewer for
1.1212 +# compressed HTML files.
1.1213 +# The default value is: NO.
1.1214 +# This tag requires that the tag GENERATE_HTML is set to YES.
1.1215 +
1.1216 +GENERATE_HTMLHELP = NO
1.1217 +
1.1218 +# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1.1219 +# file. You can add a path in front of the file if the result should not be
1.1220 +# written to the html output directory.
1.1221 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1.1222 +
1.1223 +CHM_FILE =
1.1224 +
1.1225 +# The HHC_LOCATION tag can be used to specify the location (absolute path
1.1226 +# including file name) of the HTML help compiler ( hhc.exe). If non-empty
1.1227 +# doxygen will try to run the HTML help compiler on the generated index.hhp.
1.1228 +# The file has to be specified with full path.
1.1229 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1.1230 +
1.1231 +HHC_LOCATION =
1.1232 +
1.1233 +# The GENERATE_CHI flag controls if a separate .chi index file is generated (
1.1234 +# YES) or that it should be included in the master .chm file ( NO).
1.1235 +# The default value is: NO.
1.1236 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1.1237 +
1.1238 +GENERATE_CHI = NO
1.1239 +
1.1240 +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1.1241 +# and project file content.
1.1242 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1.1243 +
1.1244 +CHM_INDEX_ENCODING =
1.1245 +
1.1246 +# The BINARY_TOC flag controls whether a binary table of contents is generated (
1.1247 +# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it
1.1248 +# enables the Previous and Next buttons.
1.1249 +# The default value is: NO.
1.1250 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1.1251 +
1.1252 +BINARY_TOC = NO
1.1253 +
1.1254 +# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1.1255 +# the table of contents of the HTML help documentation and to the tree view.
1.1256 +# The default value is: NO.
1.1257 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1.1258 +
1.1259 +TOC_EXPAND = NO
1.1260 +
1.1261 +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1.1262 +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1.1263 +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1.1264 +# (.qch) of the generated HTML documentation.
1.1265 +# The default value is: NO.
1.1266 +# This tag requires that the tag GENERATE_HTML is set to YES.
1.1267 +
1.1268 +GENERATE_QHP = NO
1.1269 +
1.1270 +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1.1271 +# the file name of the resulting .qch file. The path specified is relative to
1.1272 +# the HTML output folder.
1.1273 +# This tag requires that the tag GENERATE_QHP is set to YES.
1.1274 +
1.1275 +QCH_FILE =
1.1276 +
1.1277 +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1.1278 +# Project output. For more information please see Qt Help Project / Namespace
1.1279 +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1.1280 +# The default value is: org.doxygen.Project.
1.1281 +# This tag requires that the tag GENERATE_QHP is set to YES.
1.1282 +
1.1283 +QHP_NAMESPACE = org.doxygen.Project
1.1284 +
1.1285 +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1.1286 +# Help Project output. For more information please see Qt Help Project / Virtual
1.1287 +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1.1288 +# folders).
1.1289 +# The default value is: doc.
1.1290 +# This tag requires that the tag GENERATE_QHP is set to YES.
1.1291 +
1.1292 +QHP_VIRTUAL_FOLDER = doc
1.1293 +
1.1294 +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1.1295 +# filter to add. For more information please see Qt Help Project / Custom
1.1296 +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1.1297 +# filters).
1.1298 +# This tag requires that the tag GENERATE_QHP is set to YES.
1.1299 +
1.1300 +QHP_CUST_FILTER_NAME =
1.1301 +
1.1302 +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1.1303 +# custom filter to add. For more information please see Qt Help Project / Custom
1.1304 +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1.1305 +# filters).
1.1306 +# This tag requires that the tag GENERATE_QHP is set to YES.
1.1307 +
1.1308 +QHP_CUST_FILTER_ATTRS =
1.1309 +
1.1310 +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1.1311 +# project's filter section matches. Qt Help Project / Filter Attributes (see:
1.1312 +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1.1313 +# This tag requires that the tag GENERATE_QHP is set to YES.
1.1314 +
1.1315 +QHP_SECT_FILTER_ATTRS =
1.1316 +
1.1317 +# The QHG_LOCATION tag can be used to specify the location of Qt's
1.1318 +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1.1319 +# generated .qhp file.
1.1320 +# This tag requires that the tag GENERATE_QHP is set to YES.
1.1321 +
1.1322 +QHG_LOCATION =
1.1323 +
1.1324 +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1.1325 +# generated, together with the HTML files, they form an Eclipse help plugin. To
1.1326 +# install this plugin and make it available under the help contents menu in
1.1327 +# Eclipse, the contents of the directory containing the HTML and XML files needs
1.1328 +# to be copied into the plugins directory of eclipse. The name of the directory
1.1329 +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1.1330 +# After copying Eclipse needs to be restarted before the help appears.
1.1331 +# The default value is: NO.
1.1332 +# This tag requires that the tag GENERATE_HTML is set to YES.
1.1333 +
1.1334 +GENERATE_ECLIPSEHELP = NO
1.1335 +
1.1336 +# A unique identifier for the Eclipse help plugin. When installing the plugin
1.1337 +# the directory name containing the HTML and XML files should also have this
1.1338 +# name. Each documentation set should have its own identifier.
1.1339 +# The default value is: org.doxygen.Project.
1.1340 +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1.1341 +
1.1342 +ECLIPSE_DOC_ID = org.doxygen.Project
1.1343 +
1.1344 +# If you want full control over the layout of the generated HTML pages it might
1.1345 +# be necessary to disable the index and replace it with your own. The
1.1346 +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1.1347 +# of each HTML page. A value of NO enables the index and the value YES disables
1.1348 +# it. Since the tabs in the index contain the same information as the navigation
1.1349 +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1.1350 +# The default value is: NO.
1.1351 +# This tag requires that the tag GENERATE_HTML is set to YES.
1.1352 +
1.1353 +DISABLE_INDEX = NO
1.1354 +
1.1355 +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1.1356 +# structure should be generated to display hierarchical information. If the tag
1.1357 +# value is set to YES, a side panel will be generated containing a tree-like
1.1358 +# index structure (just like the one that is generated for HTML Help). For this
1.1359 +# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1.1360 +# (i.e. any modern browser). Windows users are probably better off using the
1.1361 +# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
1.1362 +# further fine-tune the look of the index. As an example, the default style
1.1363 +# sheet generated by doxygen has an example that shows how to put an image at
1.1364 +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1.1365 +# the same information as the tab index, you could consider setting
1.1366 +# DISABLE_INDEX to YES when enabling this option.
1.1367 +# The default value is: NO.
1.1368 +# This tag requires that the tag GENERATE_HTML is set to YES.
1.1369 +
1.1370 +GENERATE_TREEVIEW = NO
1.1371 +
1.1372 +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1.1373 +# doxygen will group on one line in the generated HTML documentation.
1.1374 +#
1.1375 +# Note that a value of 0 will completely suppress the enum values from appearing
1.1376 +# in the overview section.
1.1377 +# Minimum value: 0, maximum value: 20, default value: 4.
1.1378 +# This tag requires that the tag GENERATE_HTML is set to YES.
1.1379 +
1.1380 +ENUM_VALUES_PER_LINE = 4
1.1381 +
1.1382 +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1.1383 +# to set the initial width (in pixels) of the frame in which the tree is shown.
1.1384 +# Minimum value: 0, maximum value: 1500, default value: 250.
1.1385 +# This tag requires that the tag GENERATE_HTML is set to YES.
1.1386 +
1.1387 +TREEVIEW_WIDTH = 250
1.1388 +
1.1389 +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1.1390 +# external symbols imported via tag files in a separate window.
1.1391 +# The default value is: NO.
1.1392 +# This tag requires that the tag GENERATE_HTML is set to YES.
1.1393 +
1.1394 +EXT_LINKS_IN_WINDOW = NO
1.1395 +
1.1396 +# Use this tag to change the font size of LaTeX formulas included as images in
1.1397 +# the HTML documentation. When you change the font size after a successful
1.1398 +# doxygen run you need to manually remove any form_*.png images from the HTML
1.1399 +# output directory to force them to be regenerated.
1.1400 +# Minimum value: 8, maximum value: 50, default value: 10.
1.1401 +# This tag requires that the tag GENERATE_HTML is set to YES.
1.1402 +
1.1403 +FORMULA_FONTSIZE = 10
1.1404 +
1.1405 +# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1.1406 +# generated for formulas are transparent PNGs. Transparent PNGs are not
1.1407 +# supported properly for IE 6.0, but are supported on all modern browsers.
1.1408 +#
1.1409 +# Note that when changing this option you need to delete any form_*.png files in
1.1410 +# the HTML output directory before the changes have effect.
1.1411 +# The default value is: YES.
1.1412 +# This tag requires that the tag GENERATE_HTML is set to YES.
1.1413 +
1.1414 +FORMULA_TRANSPARENT = YES
1.1415 +
1.1416 +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1.1417 +# http://www.mathjax.org) which uses client side Javascript for the rendering
1.1418 +# instead of using prerendered bitmaps. Use this if you do not have LaTeX
1.1419 +# installed or if you want to formulas look prettier in the HTML output. When
1.1420 +# enabled you may also need to install MathJax separately and configure the path
1.1421 +# to it using the MATHJAX_RELPATH option.
1.1422 +# The default value is: NO.
1.1423 +# This tag requires that the tag GENERATE_HTML is set to YES.
1.1424 +
1.1425 +USE_MATHJAX = NO
1.1426 +
1.1427 +# When MathJax is enabled you can set the default output format to be used for
1.1428 +# the MathJax output. See the MathJax site (see:
1.1429 +# http://docs.mathjax.org/en/latest/output.html) for more details.
1.1430 +# Possible values are: HTML-CSS (which is slower, but has the best
1.1431 +# compatibility), NativeMML (i.e. MathML) and SVG.
1.1432 +# The default value is: HTML-CSS.
1.1433 +# This tag requires that the tag USE_MATHJAX is set to YES.
1.1434 +
1.1435 +MATHJAX_FORMAT = HTML-CSS
1.1436 +
1.1437 +# When MathJax is enabled you need to specify the location relative to the HTML
1.1438 +# output directory using the MATHJAX_RELPATH option. The destination directory
1.1439 +# should contain the MathJax.js script. For instance, if the mathjax directory
1.1440 +# is located at the same level as the HTML output directory, then
1.1441 +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1.1442 +# Content Delivery Network so you can quickly see the result without installing
1.1443 +# MathJax. However, it is strongly recommended to install a local copy of
1.1444 +# MathJax from http://www.mathjax.org before deployment.
1.1445 +# The default value is: http://cdn.mathjax.org/mathjax/latest.
1.1446 +# This tag requires that the tag USE_MATHJAX is set to YES.
1.1447 +
1.1448 +MATHJAX_RELPATH = http://www.mathjax.org/mathjax
1.1449 +
1.1450 +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1.1451 +# extension names that should be enabled during MathJax rendering. For example
1.1452 +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1.1453 +# This tag requires that the tag USE_MATHJAX is set to YES.
1.1454 +
1.1455 +MATHJAX_EXTENSIONS =
1.1456 +
1.1457 +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1.1458 +# of code that will be used on startup of the MathJax code. See the MathJax site
1.1459 +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1.1460 +# example see the documentation.
1.1461 +# This tag requires that the tag USE_MATHJAX is set to YES.
1.1462 +
1.1463 +MATHJAX_CODEFILE =
1.1464 +
1.1465 +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1.1466 +# the HTML output. The underlying search engine uses javascript and DHTML and
1.1467 +# should work on any modern browser. Note that when using HTML help
1.1468 +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1.1469 +# there is already a search function so this one should typically be disabled.
1.1470 +# For large projects the javascript based search engine can be slow, then
1.1471 +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1.1472 +# search using the keyboard; to jump to the search box use <access key> + S
1.1473 +# (what the <access key> is depends on the OS and browser, but it is typically
1.1474 +# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1.1475 +# key> to jump into the search results window, the results can be navigated
1.1476 +# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1.1477 +# the search. The filter options can be selected when the cursor is inside the
1.1478 +# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1.1479 +# to select a filter and <Enter> or <escape> to activate or cancel the filter
1.1480 +# option.
1.1481 +# The default value is: YES.
1.1482 +# This tag requires that the tag GENERATE_HTML is set to YES.
1.1483 +
1.1484 +SEARCHENGINE = YES
1.1485 +
1.1486 +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1.1487 +# implemented using a web server instead of a web client using Javascript. There
1.1488 +# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1.1489 +# setting. When disabled, doxygen will generate a PHP script for searching and
1.1490 +# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1.1491 +# and searching needs to be provided by external tools. See the section
1.1492 +# "External Indexing and Searching" for details.
1.1493 +# The default value is: NO.
1.1494 +# This tag requires that the tag SEARCHENGINE is set to YES.
1.1495 +
1.1496 +SERVER_BASED_SEARCH = NO
1.1497 +
1.1498 +# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1.1499 +# script for searching. Instead the search results are written to an XML file
1.1500 +# which needs to be processed by an external indexer. Doxygen will invoke an
1.1501 +# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1.1502 +# search results.
1.1503 +#
1.1504 +# Doxygen ships with an example indexer ( doxyindexer) and search engine
1.1505 +# (doxysearch.cgi) which are based on the open source search engine library
1.1506 +# Xapian (see: http://xapian.org/).
1.1507 +#
1.1508 +# See the section "External Indexing and Searching" for details.
1.1509 +# The default value is: NO.
1.1510 +# This tag requires that the tag SEARCHENGINE is set to YES.
1.1511 +
1.1512 +EXTERNAL_SEARCH = NO
1.1513 +
1.1514 +# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1.1515 +# which will return the search results when EXTERNAL_SEARCH is enabled.
1.1516 +#
1.1517 +# Doxygen ships with an example indexer ( doxyindexer) and search engine
1.1518 +# (doxysearch.cgi) which are based on the open source search engine library
1.1519 +# Xapian (see: http://xapian.org/). See the section "External Indexing and
1.1520 +# Searching" for details.
1.1521 +# This tag requires that the tag SEARCHENGINE is set to YES.
1.1522 +
1.1523 +SEARCHENGINE_URL =
1.1524 +
1.1525 +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1.1526 +# search data is written to a file for indexing by an external tool. With the
1.1527 +# SEARCHDATA_FILE tag the name of this file can be specified.
1.1528 +# The default file is: searchdata.xml.
1.1529 +# This tag requires that the tag SEARCHENGINE is set to YES.
1.1530 +
1.1531 +SEARCHDATA_FILE = searchdata.xml
1.1532 +
1.1533 +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1.1534 +# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1.1535 +# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1.1536 +# projects and redirect the results back to the right project.
1.1537 +# This tag requires that the tag SEARCHENGINE is set to YES.
1.1538 +
1.1539 +EXTERNAL_SEARCH_ID =
1.1540 +
1.1541 +# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1.1542 +# projects other than the one defined by this configuration file, but that are
1.1543 +# all added to the same external search index. Each project needs to have a
1.1544 +# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1.1545 +# to a relative location where the documentation can be found. The format is:
1.1546 +# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1.1547 +# This tag requires that the tag SEARCHENGINE is set to YES.
1.1548 +
1.1549 +EXTRA_SEARCH_MAPPINGS =
1.1550 +
1.1551 +#---------------------------------------------------------------------------
1.1552 +# Configuration options related to the LaTeX output
1.1553 +#---------------------------------------------------------------------------
1.1554 +
1.1555 +# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1.1556 +# The default value is: YES.
1.1557 +
1.1558 +GENERATE_LATEX = NO
1.1559 +
1.1560 +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1.1561 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1.1562 +# it.
1.1563 +# The default directory is: latex.
1.1564 +# This tag requires that the tag GENERATE_LATEX is set to YES.
1.1565 +
1.1566 +LATEX_OUTPUT = latex
1.1567 +
1.1568 +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1.1569 +# invoked.
1.1570 +#
1.1571 +# Note that when enabling USE_PDFLATEX this option is only used for generating
1.1572 +# bitmaps for formulas in the HTML output, but not in the Makefile that is
1.1573 +# written to the output directory.
1.1574 +# The default file is: latex.
1.1575 +# This tag requires that the tag GENERATE_LATEX is set to YES.
1.1576 +
1.1577 +LATEX_CMD_NAME = latex
1.1578 +
1.1579 +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1.1580 +# index for LaTeX.
1.1581 +# The default file is: makeindex.
1.1582 +# This tag requires that the tag GENERATE_LATEX is set to YES.
1.1583 +
1.1584 +MAKEINDEX_CMD_NAME = makeindex
1.1585 +
1.1586 +# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1.1587 +# documents. This may be useful for small projects and may help to save some
1.1588 +# trees in general.
1.1589 +# The default value is: NO.
1.1590 +# This tag requires that the tag GENERATE_LATEX is set to YES.
1.1591 +
1.1592 +COMPACT_LATEX = NO
1.1593 +
1.1594 +# The PAPER_TYPE tag can be used to set the paper type that is used by the
1.1595 +# printer.
1.1596 +# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1.1597 +# 14 inches) and executive (7.25 x 10.5 inches).
1.1598 +# The default value is: a4.
1.1599 +# This tag requires that the tag GENERATE_LATEX is set to YES.
1.1600 +
1.1601 +PAPER_TYPE = a4
1.1602 +
1.1603 +# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1.1604 +# that should be included in the LaTeX output. To get the times font for
1.1605 +# instance you can specify
1.1606 +# EXTRA_PACKAGES=times
1.1607 +# If left blank no extra packages will be included.
1.1608 +# This tag requires that the tag GENERATE_LATEX is set to YES.
1.1609 +
1.1610 +EXTRA_PACKAGES =
1.1611 +
1.1612 +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1.1613 +# generated LaTeX document. The header should contain everything until the first
1.1614 +# chapter. If it is left blank doxygen will generate a standard header. See
1.1615 +# section "Doxygen usage" for information on how to let doxygen write the
1.1616 +# default header to a separate file.
1.1617 +#
1.1618 +# Note: Only use a user-defined header if you know what you are doing! The
1.1619 +# following commands have a special meaning inside the header: $title,
1.1620 +# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
1.1621 +# replace them by respectively the title of the page, the current date and time,
1.1622 +# only the current date, the version number of doxygen, the project name (see
1.1623 +# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
1.1624 +# This tag requires that the tag GENERATE_LATEX is set to YES.
1.1625 +
1.1626 +LATEX_HEADER =
1.1627 +
1.1628 +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1.1629 +# generated LaTeX document. The footer should contain everything after the last
1.1630 +# chapter. If it is left blank doxygen will generate a standard footer.
1.1631 +#
1.1632 +# Note: Only use a user-defined footer if you know what you are doing!
1.1633 +# This tag requires that the tag GENERATE_LATEX is set to YES.
1.1634 +
1.1635 +LATEX_FOOTER =
1.1636 +
1.1637 +# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1.1638 +# other source files which should be copied to the LATEX_OUTPUT output
1.1639 +# directory. Note that the files will be copied as-is; there are no commands or
1.1640 +# markers available.
1.1641 +# This tag requires that the tag GENERATE_LATEX is set to YES.
1.1642 +
1.1643 +LATEX_EXTRA_FILES =
1.1644 +
1.1645 +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1.1646 +# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1.1647 +# contain links (just like the HTML output) instead of page references. This
1.1648 +# makes the output suitable for online browsing using a PDF viewer.
1.1649 +# The default value is: YES.
1.1650 +# This tag requires that the tag GENERATE_LATEX is set to YES.
1.1651 +
1.1652 +PDF_HYPERLINKS = YES
1.1653 +
1.1654 +# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1.1655 +# the PDF file directly from the LaTeX files. Set this option to YES to get a
1.1656 +# higher quality PDF documentation.
1.1657 +# The default value is: YES.
1.1658 +# This tag requires that the tag GENERATE_LATEX is set to YES.
1.1659 +
1.1660 +USE_PDFLATEX = YES
1.1661 +
1.1662 +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1.1663 +# command to the generated LaTeX files. This will instruct LaTeX to keep running
1.1664 +# if errors occur, instead of asking the user for help. This option is also used
1.1665 +# when generating formulas in HTML.
1.1666 +# The default value is: NO.
1.1667 +# This tag requires that the tag GENERATE_LATEX is set to YES.
1.1668 +
1.1669 +LATEX_BATCHMODE = NO
1.1670 +
1.1671 +# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1.1672 +# index chapters (such as File Index, Compound Index, etc.) in the output.
1.1673 +# The default value is: NO.
1.1674 +# This tag requires that the tag GENERATE_LATEX is set to YES.
1.1675 +
1.1676 +LATEX_HIDE_INDICES = NO
1.1677 +
1.1678 +# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1.1679 +# code with syntax highlighting in the LaTeX output.
1.1680 +#
1.1681 +# Note that which sources are shown also depends on other settings such as
1.1682 +# SOURCE_BROWSER.
1.1683 +# The default value is: NO.
1.1684 +# This tag requires that the tag GENERATE_LATEX is set to YES.
1.1685 +
1.1686 +LATEX_SOURCE_CODE = NO
1.1687 +
1.1688 +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1.1689 +# bibliography, e.g. plainnat, or ieeetr. See
1.1690 +# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1.1691 +# The default value is: plain.
1.1692 +# This tag requires that the tag GENERATE_LATEX is set to YES.
1.1693 +
1.1694 +LATEX_BIB_STYLE = plain
1.1695 +
1.1696 +#---------------------------------------------------------------------------
1.1697 +# Configuration options related to the RTF output
1.1698 +#---------------------------------------------------------------------------
1.1699 +
1.1700 +# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1.1701 +# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1.1702 +# readers/editors.
1.1703 +# The default value is: NO.
1.1704 +
1.1705 +GENERATE_RTF = NO
1.1706 +
1.1707 +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1.1708 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1.1709 +# it.
1.1710 +# The default directory is: rtf.
1.1711 +# This tag requires that the tag GENERATE_RTF is set to YES.
1.1712 +
1.1713 +RTF_OUTPUT = rtf
1.1714 +
1.1715 +# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1.1716 +# documents. This may be useful for small projects and may help to save some
1.1717 +# trees in general.
1.1718 +# The default value is: NO.
1.1719 +# This tag requires that the tag GENERATE_RTF is set to YES.
1.1720 +
1.1721 +COMPACT_RTF = NO
1.1722 +
1.1723 +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1.1724 +# contain hyperlink fields. The RTF file will contain links (just like the HTML
1.1725 +# output) instead of page references. This makes the output suitable for online
1.1726 +# browsing using Word or some other Word compatible readers that support those
1.1727 +# fields.
1.1728 +#
1.1729 +# Note: WordPad (write) and others do not support links.
1.1730 +# The default value is: NO.
1.1731 +# This tag requires that the tag GENERATE_RTF is set to YES.
1.1732 +
1.1733 +RTF_HYPERLINKS = NO
1.1734 +
1.1735 +# Load stylesheet definitions from file. Syntax is similar to doxygen's config
1.1736 +# file, i.e. a series of assignments. You only have to provide replacements,
1.1737 +# missing definitions are set to their default value.
1.1738 +#
1.1739 +# See also section "Doxygen usage" for information on how to generate the
1.1740 +# default style sheet that doxygen normally uses.
1.1741 +# This tag requires that the tag GENERATE_RTF is set to YES.
1.1742 +
1.1743 +RTF_STYLESHEET_FILE =
1.1744 +
1.1745 +# Set optional variables used in the generation of an RTF document. Syntax is
1.1746 +# similar to doxygen's config file. A template extensions file can be generated
1.1747 +# using doxygen -e rtf extensionFile.
1.1748 +# This tag requires that the tag GENERATE_RTF is set to YES.
1.1749 +
1.1750 +RTF_EXTENSIONS_FILE =
1.1751 +
1.1752 +#---------------------------------------------------------------------------
1.1753 +# Configuration options related to the man page output
1.1754 +#---------------------------------------------------------------------------
1.1755 +
1.1756 +# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1.1757 +# classes and files.
1.1758 +# The default value is: NO.
1.1759 +
1.1760 +GENERATE_MAN = NO
1.1761 +
1.1762 +# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1.1763 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1.1764 +# it. A directory man3 will be created inside the directory specified by
1.1765 +# MAN_OUTPUT.
1.1766 +# The default directory is: man.
1.1767 +# This tag requires that the tag GENERATE_MAN is set to YES.
1.1768 +
1.1769 +MAN_OUTPUT = man
1.1770 +
1.1771 +# The MAN_EXTENSION tag determines the extension that is added to the generated
1.1772 +# man pages. In case the manual section does not start with a number, the number
1.1773 +# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1.1774 +# optional.
1.1775 +# The default value is: .3.
1.1776 +# This tag requires that the tag GENERATE_MAN is set to YES.
1.1777 +
1.1778 +MAN_EXTENSION = .3
1.1779 +
1.1780 +# The MAN_SUBDIR tag determines the name of the directory created within
1.1781 +# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1.1782 +# MAN_EXTENSION with the initial . removed.
1.1783 +# This tag requires that the tag GENERATE_MAN is set to YES.
1.1784 +
1.1785 +MAN_SUBDIR =
1.1786 +
1.1787 +# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1.1788 +# will generate one additional man file for each entity documented in the real
1.1789 +# man page(s). These additional files only source the real man page, but without
1.1790 +# them the man command would be unable to find the correct page.
1.1791 +# The default value is: NO.
1.1792 +# This tag requires that the tag GENERATE_MAN is set to YES.
1.1793 +
1.1794 +MAN_LINKS = NO
1.1795 +
1.1796 +#---------------------------------------------------------------------------
1.1797 +# Configuration options related to the XML output
1.1798 +#---------------------------------------------------------------------------
1.1799 +
1.1800 +# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1.1801 +# captures the structure of the code including all documentation.
1.1802 +# The default value is: NO.
1.1803 +
1.1804 +GENERATE_XML = NO
1.1805 +
1.1806 +# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1.1807 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1.1808 +# it.
1.1809 +# The default directory is: xml.
1.1810 +# This tag requires that the tag GENERATE_XML is set to YES.
1.1811 +
1.1812 +XML_OUTPUT = xml
1.1813 +
1.1814 +# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1.1815 +# listings (including syntax highlighting and cross-referencing information) to
1.1816 +# the XML output. Note that enabling this will significantly increase the size
1.1817 +# of the XML output.
1.1818 +# The default value is: YES.
1.1819 +# This tag requires that the tag GENERATE_XML is set to YES.
1.1820 +
1.1821 +XML_PROGRAMLISTING = YES
1.1822 +
1.1823 +#---------------------------------------------------------------------------
1.1824 +# Configuration options related to the DOCBOOK output
1.1825 +#---------------------------------------------------------------------------
1.1826 +
1.1827 +# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1.1828 +# that can be used to generate PDF.
1.1829 +# The default value is: NO.
1.1830 +
1.1831 +GENERATE_DOCBOOK = NO
1.1832 +
1.1833 +# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1.1834 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1.1835 +# front of it.
1.1836 +# The default directory is: docbook.
1.1837 +# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1.1838 +
1.1839 +DOCBOOK_OUTPUT = docbook
1.1840 +
1.1841 +#---------------------------------------------------------------------------
1.1842 +# Configuration options for the AutoGen Definitions output
1.1843 +#---------------------------------------------------------------------------
1.1844 +
1.1845 +# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1.1846 +# Definitions (see http://autogen.sf.net) file that captures the structure of
1.1847 +# the code including all documentation. Note that this feature is still
1.1848 +# experimental and incomplete at the moment.
1.1849 +# The default value is: NO.
1.1850 +
1.1851 +GENERATE_AUTOGEN_DEF = NO
1.1852 +
1.1853 +#---------------------------------------------------------------------------
1.1854 +# Configuration options related to the Perl module output
1.1855 +#---------------------------------------------------------------------------
1.1856 +
1.1857 +# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1.1858 +# file that captures the structure of the code including all documentation.
1.1859 +#
1.1860 +# Note that this feature is still experimental and incomplete at the moment.
1.1861 +# The default value is: NO.
1.1862 +
1.1863 +GENERATE_PERLMOD = NO
1.1864 +
1.1865 +# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1.1866 +# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1.1867 +# output from the Perl module output.
1.1868 +# The default value is: NO.
1.1869 +# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1.1870 +
1.1871 +PERLMOD_LATEX = NO
1.1872 +
1.1873 +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1.1874 +# formatted so it can be parsed by a human reader. This is useful if you want to
1.1875 +# understand what is going on. On the other hand, if this tag is set to NO the
1.1876 +# size of the Perl module output will be much smaller and Perl will parse it
1.1877 +# just the same.
1.1878 +# The default value is: YES.
1.1879 +# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1.1880 +
1.1881 +PERLMOD_PRETTY = YES
1.1882 +
1.1883 +# The names of the make variables in the generated doxyrules.make file are
1.1884 +# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1.1885 +# so different doxyrules.make files included by the same Makefile don't
1.1886 +# overwrite each other's variables.
1.1887 +# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1.1888 +
1.1889 +PERLMOD_MAKEVAR_PREFIX =
1.1890 +
1.1891 +#---------------------------------------------------------------------------
1.1892 +# Configuration options related to the preprocessor
1.1893 +#---------------------------------------------------------------------------
1.1894 +
1.1895 +# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1.1896 +# C-preprocessor directives found in the sources and include files.
1.1897 +# The default value is: YES.
1.1898 +
1.1899 +ENABLE_PREPROCESSING = YES
1.1900 +
1.1901 +# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1.1902 +# in the source code. If set to NO only conditional compilation will be
1.1903 +# performed. Macro expansion can be done in a controlled way by setting
1.1904 +# EXPAND_ONLY_PREDEF to YES.
1.1905 +# The default value is: NO.
1.1906 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1.1907 +
1.1908 +MACRO_EXPANSION = NO
1.1909 +
1.1910 +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1.1911 +# the macro expansion is limited to the macros specified with the PREDEFINED and
1.1912 +# EXPAND_AS_DEFINED tags.
1.1913 +# The default value is: NO.
1.1914 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1.1915 +
1.1916 +EXPAND_ONLY_PREDEF = NO
1.1917 +
1.1918 +# If the SEARCH_INCLUDES tag is set to YES the includes files in the
1.1919 +# INCLUDE_PATH will be searched if a #include is found.
1.1920 +# The default value is: YES.
1.1921 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1.1922 +
1.1923 +SEARCH_INCLUDES = YES
1.1924 +
1.1925 +# The INCLUDE_PATH tag can be used to specify one or more directories that
1.1926 +# contain include files that are not input files but should be processed by the
1.1927 +# preprocessor.
1.1928 +# This tag requires that the tag SEARCH_INCLUDES is set to YES.
1.1929 +
1.1930 +INCLUDE_PATH =
1.1931 +
1.1932 +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1.1933 +# patterns (like *.h and *.hpp) to filter out the header-files in the
1.1934 +# directories. If left blank, the patterns specified with FILE_PATTERNS will be
1.1935 +# used.
1.1936 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1.1937 +
1.1938 +INCLUDE_FILE_PATTERNS =
1.1939 +
1.1940 +# The PREDEFINED tag can be used to specify one or more macro names that are
1.1941 +# defined before the preprocessor is started (similar to the -D option of e.g.
1.1942 +# gcc). The argument of the tag is a list of macros of the form: name or
1.1943 +# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
1.1944 +# is assumed. To prevent a macro definition from being undefined via #undef or
1.1945 +# recursively expanded use the := operator instead of the = operator.
1.1946 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1.1947 +
1.1948 +PREDEFINED =
1.1949 +
1.1950 +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
1.1951 +# tag can be used to specify a list of macro names that should be expanded. The
1.1952 +# macro definition that is found in the sources will be used. Use the PREDEFINED
1.1953 +# tag if you want to use a different macro definition that overrules the
1.1954 +# definition found in the source code.
1.1955 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1.1956 +
1.1957 +EXPAND_AS_DEFINED =
1.1958 +
1.1959 +# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
1.1960 +# remove all references to function-like macros that are alone on a line, have
1.1961 +# an all uppercase name, and do not end with a semicolon. Such function macros
1.1962 +# are typically used for boiler-plate code, and will confuse the parser if not
1.1963 +# removed.
1.1964 +# The default value is: YES.
1.1965 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1.1966 +
1.1967 +SKIP_FUNCTION_MACROS = YES
1.1968 +
1.1969 +#---------------------------------------------------------------------------
1.1970 +# Configuration options related to external references
1.1971 +#---------------------------------------------------------------------------
1.1972 +
1.1973 +# The TAGFILES tag can be used to specify one or more tag files. For each tag
1.1974 +# file the location of the external documentation should be added. The format of
1.1975 +# a tag file without this location is as follows:
1.1976 +# TAGFILES = file1 file2 ...
1.1977 +# Adding location for the tag files is done as follows:
1.1978 +# TAGFILES = file1=loc1 "file2 = loc2" ...
1.1979 +# where loc1 and loc2 can be relative or absolute paths or URLs. See the
1.1980 +# section "Linking to external documentation" for more information about the use
1.1981 +# of tag files.
1.1982 +# Note: Each tag file must have a unique name (where the name does NOT include
1.1983 +# the path). If a tag file is not located in the directory in which doxygen is
1.1984 +# run, you must also specify the path to the tagfile here.
1.1985 +
1.1986 +TAGFILES =
1.1987 +
1.1988 +# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
1.1989 +# tag file that is based on the input files it reads. See section "Linking to
1.1990 +# external documentation" for more information about the usage of tag files.
1.1991 +
1.1992 +GENERATE_TAGFILE =
1.1993 +
1.1994 +# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
1.1995 +# class index. If set to NO only the inherited external classes will be listed.
1.1996 +# The default value is: NO.
1.1997 +
1.1998 +ALLEXTERNALS = NO
1.1999 +
1.2000 +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
1.2001 +# the modules index. If set to NO, only the current project's groups will be
1.2002 +# listed.
1.2003 +# The default value is: YES.
1.2004 +
1.2005 +EXTERNAL_GROUPS = YES
1.2006 +
1.2007 +# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
1.2008 +# the related pages index. If set to NO, only the current project's pages will
1.2009 +# be listed.
1.2010 +# The default value is: YES.
1.2011 +
1.2012 +EXTERNAL_PAGES = YES
1.2013 +
1.2014 +# The PERL_PATH should be the absolute path and name of the perl script
1.2015 +# interpreter (i.e. the result of 'which perl').
1.2016 +# The default file (with absolute path) is: /usr/bin/perl.
1.2017 +
1.2018 +PERL_PATH = /usr/bin/perl
1.2019 +
1.2020 +#---------------------------------------------------------------------------
1.2021 +# Configuration options related to the dot tool
1.2022 +#---------------------------------------------------------------------------
1.2023 +
1.2024 +# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
1.2025 +# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
1.2026 +# NO turns the diagrams off. Note that this option also works with HAVE_DOT
1.2027 +# disabled, but it is recommended to install and use dot, since it yields more
1.2028 +# powerful graphs.
1.2029 +# The default value is: YES.
1.2030 +
1.2031 +CLASS_DIAGRAMS = YES
1.2032 +
1.2033 +# You can define message sequence charts within doxygen comments using the \msc
1.2034 +# command. Doxygen will then run the mscgen tool (see:
1.2035 +# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
1.2036 +# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1.2037 +# the mscgen tool resides. If left empty the tool is assumed to be found in the
1.2038 +# default search path.
1.2039 +
1.2040 +MSCGEN_PATH =
1.2041 +
1.2042 +# You can include diagrams made with dia in doxygen documentation. Doxygen will
1.2043 +# then run dia to produce the diagram and insert it in the documentation. The
1.2044 +# DIA_PATH tag allows you to specify the directory where the dia binary resides.
1.2045 +# If left empty dia is assumed to be found in the default search path.
1.2046 +
1.2047 +DIA_PATH =
1.2048 +
1.2049 +# If set to YES, the inheritance and collaboration graphs will hide inheritance
1.2050 +# and usage relations if the target is undocumented or is not a class.
1.2051 +# The default value is: YES.
1.2052 +
1.2053 +HIDE_UNDOC_RELATIONS = YES
1.2054 +
1.2055 +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1.2056 +# available from the path. This tool is part of Graphviz (see:
1.2057 +# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
1.2058 +# Bell Labs. The other options in this section have no effect if this option is
1.2059 +# set to NO
1.2060 +# The default value is: YES.
1.2061 +
1.2062 +HAVE_DOT = NO
1.2063 +
1.2064 +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
1.2065 +# to run in parallel. When set to 0 doxygen will base this on the number of
1.2066 +# processors available in the system. You can set it explicitly to a value
1.2067 +# larger than 0 to get control over the balance between CPU load and processing
1.2068 +# speed.
1.2069 +# Minimum value: 0, maximum value: 32, default value: 0.
1.2070 +# This tag requires that the tag HAVE_DOT is set to YES.
1.2071 +
1.2072 +DOT_NUM_THREADS = 0
1.2073 +
1.2074 +# When you want a differently looking font n the dot files that doxygen
1.2075 +# generates you can specify the font name using DOT_FONTNAME. You need to make
1.2076 +# sure dot is able to find the font, which can be done by putting it in a
1.2077 +# standard location or by setting the DOTFONTPATH environment variable or by
1.2078 +# setting DOT_FONTPATH to the directory containing the font.
1.2079 +# The default value is: Helvetica.
1.2080 +# This tag requires that the tag HAVE_DOT is set to YES.
1.2081 +
1.2082 +DOT_FONTNAME = Helvetica
1.2083 +
1.2084 +# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
1.2085 +# dot graphs.
1.2086 +# Minimum value: 4, maximum value: 24, default value: 10.
1.2087 +# This tag requires that the tag HAVE_DOT is set to YES.
1.2088 +
1.2089 +DOT_FONTSIZE = 10
1.2090 +
1.2091 +# By default doxygen will tell dot to use the default font as specified with
1.2092 +# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
1.2093 +# the path where dot can find it using this tag.
1.2094 +# This tag requires that the tag HAVE_DOT is set to YES.
1.2095 +
1.2096 +DOT_FONTPATH =
1.2097 +
1.2098 +# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
1.2099 +# each documented class showing the direct and indirect inheritance relations.
1.2100 +# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
1.2101 +# The default value is: YES.
1.2102 +# This tag requires that the tag HAVE_DOT is set to YES.
1.2103 +
1.2104 +CLASS_GRAPH = YES
1.2105 +
1.2106 +# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
1.2107 +# graph for each documented class showing the direct and indirect implementation
1.2108 +# dependencies (inheritance, containment, and class references variables) of the
1.2109 +# class with other documented classes.
1.2110 +# The default value is: YES.
1.2111 +# This tag requires that the tag HAVE_DOT is set to YES.
1.2112 +
1.2113 +COLLABORATION_GRAPH = YES
1.2114 +
1.2115 +# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
1.2116 +# groups, showing the direct groups dependencies.
1.2117 +# The default value is: YES.
1.2118 +# This tag requires that the tag HAVE_DOT is set to YES.
1.2119 +
1.2120 +GROUP_GRAPHS = YES
1.2121 +
1.2122 +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1.2123 +# collaboration diagrams in a style similar to the OMG's Unified Modeling
1.2124 +# Language.
1.2125 +# The default value is: NO.
1.2126 +# This tag requires that the tag HAVE_DOT is set to YES.
1.2127 +
1.2128 +UML_LOOK = NO
1.2129 +
1.2130 +# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
1.2131 +# class node. If there are many fields or methods and many nodes the graph may
1.2132 +# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
1.2133 +# number of items for each type to make the size more manageable. Set this to 0
1.2134 +# for no limit. Note that the threshold may be exceeded by 50% before the limit
1.2135 +# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
1.2136 +# but if the number exceeds 15, the total amount of fields shown is limited to
1.2137 +# 10.
1.2138 +# Minimum value: 0, maximum value: 100, default value: 10.
1.2139 +# This tag requires that the tag HAVE_DOT is set to YES.
1.2140 +
1.2141 +UML_LIMIT_NUM_FIELDS = 10
1.2142 +
1.2143 +# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
1.2144 +# collaboration graphs will show the relations between templates and their
1.2145 +# instances.
1.2146 +# The default value is: NO.
1.2147 +# This tag requires that the tag HAVE_DOT is set to YES.
1.2148 +
1.2149 +TEMPLATE_RELATIONS = NO
1.2150 +
1.2151 +# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
1.2152 +# YES then doxygen will generate a graph for each documented file showing the
1.2153 +# direct and indirect include dependencies of the file with other documented
1.2154 +# files.
1.2155 +# The default value is: YES.
1.2156 +# This tag requires that the tag HAVE_DOT is set to YES.
1.2157 +
1.2158 +INCLUDE_GRAPH = YES
1.2159 +
1.2160 +# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
1.2161 +# set to YES then doxygen will generate a graph for each documented file showing
1.2162 +# the direct and indirect include dependencies of the file with other documented
1.2163 +# files.
1.2164 +# The default value is: YES.
1.2165 +# This tag requires that the tag HAVE_DOT is set to YES.
1.2166 +
1.2167 +INCLUDED_BY_GRAPH = YES
1.2168 +
1.2169 +# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
1.2170 +# dependency graph for every global function or class method.
1.2171 +#
1.2172 +# Note that enabling this option will significantly increase the time of a run.
1.2173 +# So in most cases it will be better to enable call graphs for selected
1.2174 +# functions only using the \callgraph command.
1.2175 +# The default value is: NO.
1.2176 +# This tag requires that the tag HAVE_DOT is set to YES.
1.2177 +
1.2178 +CALL_GRAPH = NO
1.2179 +
1.2180 +# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
1.2181 +# dependency graph for every global function or class method.
1.2182 +#
1.2183 +# Note that enabling this option will significantly increase the time of a run.
1.2184 +# So in most cases it will be better to enable caller graphs for selected
1.2185 +# functions only using the \callergraph command.
1.2186 +# The default value is: NO.
1.2187 +# This tag requires that the tag HAVE_DOT is set to YES.
1.2188 +
1.2189 +CALLER_GRAPH = NO
1.2190 +
1.2191 +# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
1.2192 +# hierarchy of all classes instead of a textual one.
1.2193 +# The default value is: YES.
1.2194 +# This tag requires that the tag HAVE_DOT is set to YES.
1.2195 +
1.2196 +GRAPHICAL_HIERARCHY = YES
1.2197 +
1.2198 +# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
1.2199 +# dependencies a directory has on other directories in a graphical way. The
1.2200 +# dependency relations are determined by the #include relations between the
1.2201 +# files in the directories.
1.2202 +# The default value is: YES.
1.2203 +# This tag requires that the tag HAVE_DOT is set to YES.
1.2204 +
1.2205 +DIRECTORY_GRAPH = YES
1.2206 +
1.2207 +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1.2208 +# generated by dot.
1.2209 +# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
1.2210 +# to make the SVG files visible in IE 9+ (other browsers do not have this
1.2211 +# requirement).
1.2212 +# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
1.2213 +# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
1.2214 +# gif:cairo:gd, gif:gd, gif:gd:gd and svg.
1.2215 +# The default value is: png.
1.2216 +# This tag requires that the tag HAVE_DOT is set to YES.
1.2217 +
1.2218 +DOT_IMAGE_FORMAT = png
1.2219 +
1.2220 +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1.2221 +# enable generation of interactive SVG images that allow zooming and panning.
1.2222 +#
1.2223 +# Note that this requires a modern browser other than Internet Explorer. Tested
1.2224 +# and working are Firefox, Chrome, Safari, and Opera.
1.2225 +# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
1.2226 +# the SVG files visible. Older versions of IE do not have SVG support.
1.2227 +# The default value is: NO.
1.2228 +# This tag requires that the tag HAVE_DOT is set to YES.
1.2229 +
1.2230 +INTERACTIVE_SVG = NO
1.2231 +
1.2232 +# The DOT_PATH tag can be used to specify the path where the dot tool can be
1.2233 +# found. If left blank, it is assumed the dot tool can be found in the path.
1.2234 +# This tag requires that the tag HAVE_DOT is set to YES.
1.2235 +
1.2236 +DOT_PATH =
1.2237 +
1.2238 +# The DOTFILE_DIRS tag can be used to specify one or more directories that
1.2239 +# contain dot files that are included in the documentation (see the \dotfile
1.2240 +# command).
1.2241 +# This tag requires that the tag HAVE_DOT is set to YES.
1.2242 +
1.2243 +DOTFILE_DIRS =
1.2244 +
1.2245 +# The MSCFILE_DIRS tag can be used to specify one or more directories that
1.2246 +# contain msc files that are included in the documentation (see the \mscfile
1.2247 +# command).
1.2248 +
1.2249 +MSCFILE_DIRS =
1.2250 +
1.2251 +# The DIAFILE_DIRS tag can be used to specify one or more directories that
1.2252 +# contain dia files that are included in the documentation (see the \diafile
1.2253 +# command).
1.2254 +
1.2255 +DIAFILE_DIRS =
1.2256 +
1.2257 +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
1.2258 +# that will be shown in the graph. If the number of nodes in a graph becomes
1.2259 +# larger than this value, doxygen will truncate the graph, which is visualized
1.2260 +# by representing a node as a red box. Note that doxygen if the number of direct
1.2261 +# children of the root node in a graph is already larger than
1.2262 +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
1.2263 +# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1.2264 +# Minimum value: 0, maximum value: 10000, default value: 50.
1.2265 +# This tag requires that the tag HAVE_DOT is set to YES.
1.2266 +
1.2267 +DOT_GRAPH_MAX_NODES = 50
1.2268 +
1.2269 +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
1.2270 +# generated by dot. A depth value of 3 means that only nodes reachable from the
1.2271 +# root by following a path via at most 3 edges will be shown. Nodes that lay
1.2272 +# further from the root node will be omitted. Note that setting this option to 1
1.2273 +# or 2 may greatly reduce the computation time needed for large code bases. Also
1.2274 +# note that the size of a graph can be further restricted by
1.2275 +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1.2276 +# Minimum value: 0, maximum value: 1000, default value: 0.
1.2277 +# This tag requires that the tag HAVE_DOT is set to YES.
1.2278 +
1.2279 +MAX_DOT_GRAPH_DEPTH = 0
1.2280 +
1.2281 +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1.2282 +# background. This is disabled by default, because dot on Windows does not seem
1.2283 +# to support this out of the box.
1.2284 +#
1.2285 +# Warning: Depending on the platform used, enabling this option may lead to
1.2286 +# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1.2287 +# read).
1.2288 +# The default value is: NO.
1.2289 +# This tag requires that the tag HAVE_DOT is set to YES.
1.2290 +
1.2291 +DOT_TRANSPARENT = NO
1.2292 +
1.2293 +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1.2294 +# files in one run (i.e. multiple -o and -T options on the command line). This
1.2295 +# makes dot run faster, but since only newer versions of dot (>1.8.10) support
1.2296 +# this, this feature is disabled by default.
1.2297 +# The default value is: NO.
1.2298 +# This tag requires that the tag HAVE_DOT is set to YES.
1.2299 +
1.2300 +DOT_MULTI_TARGETS = YES
1.2301 +
1.2302 +# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
1.2303 +# explaining the meaning of the various boxes and arrows in the dot generated
1.2304 +# graphs.
1.2305 +# The default value is: YES.
1.2306 +# This tag requires that the tag HAVE_DOT is set to YES.
1.2307 +
1.2308 +GENERATE_LEGEND = YES
1.2309 +
1.2310 +# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
1.2311 +# files that are used to generate the various graphs.
1.2312 +# The default value is: YES.
1.2313 +# This tag requires that the tag HAVE_DOT is set to YES.
1.2314 +
1.2315 +DOT_CLEANUP = YES
