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