Mercurial > hg > ucx / changeset

     1.1 --- a/Doxyfile	Sun May 21 16:22:09 2023 +0200
     1.2 +++ b/Doxyfile	Tue Jun 20 18:26:35 2023 +0200
     1.3 @@ -1,4 +1,4 @@
     1.4 -# Doxyfile 1.8.7
     1.5 +# Doxyfile 1.9.6
     1.6  
     1.7  # This file describes the settings to be used by the documentation system
     1.8  # doxygen (www.doxygen.org) for a project.
     1.9 @@ -12,16 +12,26 @@
    1.10  # For lists, items can also be appended using:
    1.11  # TAG += value [value, ...]
    1.12  # Values that contain spaces should be placed between quotes (\" \").
    1.13 +#
    1.14 +# Note:
    1.15 +#
    1.16 +# Use doxygen to compare the used configuration file with the template
    1.17 +# configuration file:
    1.18 +# doxygen -x [configFile]
    1.19 +# Use doxygen to compare the used configuration file with the template
    1.20 +# configuration file without replacing the environment variables or CMake type
    1.21 +# replacement variables:
    1.22 +# doxygen -x_noenv [configFile]
    1.23  
    1.24  #---------------------------------------------------------------------------
    1.25  # Project related configuration options
    1.26  #---------------------------------------------------------------------------
    1.27  
    1.28 -# This tag specifies the encoding used for all characters in the config file
    1.29 -# that follow. The default is UTF-8 which is also the encoding used for all text
    1.30 -# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
    1.31 -# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
    1.32 -# for the list of possible encodings.
    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 @@ -32,7 +42,7 @@
    1.42  # title of most generated pages and in a few other places.
    1.43  # The default value is: My Project.
    1.44  
    1.45 -PROJECT_NAME           = "ucx"
    1.46 +PROJECT_NAME           = ucx
    1.47  
    1.48  # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
    1.49  # could be handy for archiving the generated documentation or if some version
    1.50 @@ -46,10 +56,10 @@
    1.51  
    1.52  PROJECT_BRIEF          = "UAP Common Extensions"
    1.53  
    1.54 -# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
    1.55 -# the documentation. The maximum height of the logo should not exceed 55 pixels
    1.56 -# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
    1.57 -# to the output directory.
    1.58 +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
    1.59 +# in the documentation. The maximum height of the logo should not exceed 55
    1.60 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
    1.61 +# the logo to the output directory.
    1.62  
    1.63  PROJECT_LOGO           = ./uaplogo.png
    1.64  
    1.65 @@ -60,16 +70,28 @@
    1.66  
    1.67  OUTPUT_DIRECTORY       = docs
    1.68  
    1.69 -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
    1.70 -# directories (in 2 levels) under the output directory of each output format and
    1.71 -# will distribute the generated files over these directories. Enabling this
    1.72 +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
    1.73 +# sub-directories (in 2 levels) under the output directory of each output format
    1.74 +# and will distribute the generated files over these directories. Enabling this
    1.75  # option can be useful when feeding doxygen a huge amount of source files, where
    1.76  # putting all generated files in the same directory would otherwise causes
    1.77 -# performance problems for the file system.
    1.78 +# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to
    1.79 +# control the number of sub-directories.
    1.80  # The default value is: NO.
    1.81  
    1.82  CREATE_SUBDIRS         = NO
    1.83  
    1.84 +# Controls the number of sub-directories that will be created when
    1.85 +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every
    1.86 +# level increment doubles the number of directories, resulting in 4096
    1.87 +# directories at level 8 which is the default and also the maximum value. The
    1.88 +# sub-directories are organized in 2 levels, the first level always has a fixed
    1.89 +# number of 16 directories.
    1.90 +# Minimum value: 0, maximum value: 8, default value: 8.
    1.91 +# This tag requires that the tag CREATE_SUBDIRS is set to YES.
    1.92 +
    1.93 +CREATE_SUBDIRS_LEVEL   = 8
    1.94 +
    1.95  # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
    1.96  # characters to appear in the names of generated files. If set to NO, non-ASCII
    1.97  # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
    1.98 @@ -81,26 +103,26 @@
    1.99  # The OUTPUT_LANGUAGE tag is used to specify the language in which all
   1.100  # documentation generated by doxygen is written. Doxygen will use this
   1.101  # information to generate all constant output in the proper language.
   1.102 -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
   1.103 -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
   1.104 -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
   1.105 -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
   1.106 -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
   1.107 -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
   1.108 -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
   1.109 -# Ukrainian and Vietnamese.
   1.110 +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian,
   1.111 +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English
   1.112 +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek,
   1.113 +# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with
   1.114 +# English messages), Korean, Korean-en (Korean with English messages), Latvian,
   1.115 +# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese,
   1.116 +# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish,
   1.117 +# Swedish, Turkish, Ukrainian and Vietnamese.
   1.118  # The default value is: English.
   1.119  
   1.120  OUTPUT_LANGUAGE        = English
   1.121  
   1.122 -# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
   1.123 +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
   1.124  # descriptions after the members that are listed in the file and class
   1.125  # documentation (similar to Javadoc). Set to NO to disable this.
   1.126  # The default value is: YES.
   1.127  
   1.128  BRIEF_MEMBER_DESC      = YES
   1.129  
   1.130 -# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
   1.131 +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
   1.132  # description of a member or function before the detailed description
   1.133  #
   1.134  # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
   1.135 @@ -135,7 +157,7 @@
   1.136  
   1.137  INLINE_INHERITED_MEMB  = NO
   1.138  
   1.139 -# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
   1.140 +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
   1.141  # before files name in the file list and in the header files. If set to NO the
   1.142  # shortest path that makes the file name unique will be used
   1.143  # The default value is: YES.
   1.144 @@ -179,6 +201,16 @@
   1.145  
   1.146  JAVADOC_AUTOBRIEF      = YES
   1.147  
   1.148 +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
   1.149 +# such as
   1.150 +# /***************
   1.151 +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
   1.152 +# Javadoc-style will behave just like regular comments and it will not be
   1.153 +# interpreted by doxygen.
   1.154 +# The default value is: NO.
   1.155 +
   1.156 +JAVADOC_BANNER         = NO
   1.157 +
   1.158  # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
   1.159  # line (until the first dot) of a Qt-style comment as the brief description. If
   1.160  # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
   1.161 @@ -199,15 +231,23 @@
   1.162  
   1.163  MULTILINE_CPP_IS_BRIEF = NO
   1.164  
   1.165 +# By default Python docstrings are displayed as preformatted text and doxygen's
   1.166 +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
   1.167 +# doxygen's special commands can be used and the contents of the docstring
   1.168 +# documentation blocks is shown as doxygen documentation.
   1.169 +# The default value is: YES.
   1.170 +
   1.171 +PYTHON_DOCSTRING       = YES
   1.172 +
   1.173  # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
   1.174  # documentation from any documented member that it re-implements.
   1.175  # The default value is: YES.
   1.176  
   1.177  INHERIT_DOCS           = YES
   1.178  
   1.179 -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
   1.180 -# new page for each member. If set to NO, the documentation of a member will be
   1.181 -# part of the file/class/namespace that contains it.
   1.182 +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
   1.183 +# page for each member. If set to NO, the documentation of a member will be part
   1.184 +# of the file/class/namespace that contains it.
   1.185  # The default value is: NO.
   1.186  
   1.187  SEPARATE_MEMBER_PAGES  = NO
   1.188 @@ -222,11 +262,16 @@
   1.189  # the documentation. An alias has the form:
   1.190  # name=value
   1.191  # For example adding
   1.192 -# "sideeffect=@par Side Effects:\n"
   1.193 +# "sideeffect=@par Side Effects:^^"
   1.194  # will allow you to put the command \sideeffect (or @sideeffect) in the
   1.195  # documentation, which will result in a user-defined paragraph with heading
   1.196 -# "Side Effects:". You can put \n's in the value part of an alias to insert
   1.197 -# newlines.
   1.198 +# "Side Effects:". Note that you cannot put \n's in the value part of an alias
   1.199 +# to insert newlines (in the resulting output). You can put ^^ in the value part
   1.200 +# of an alias to insert a newline as if a physical newline was in the original
   1.201 +# file. When you need a literal { or } or , in the value part of an alias you
   1.202 +# have to escape them by means of a backslash (\), this can lead to conflicts
   1.203 +# with the commands \{ and \} for these it is advised to use the version @{ and
   1.204 +# @} or use a double escape (\\{ and \\})
   1.205  
   1.206  ALIASES                =
   1.207  
   1.208 @@ -258,28 +303,40 @@
   1.209  
   1.210  OPTIMIZE_OUTPUT_VHDL   = NO
   1.211  
   1.212 +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
   1.213 +# sources only. Doxygen will then generate output that is more tailored for that
   1.214 +# language. For instance, namespaces will be presented as modules, types will be
   1.215 +# separated into more groups, etc.
   1.216 +# The default value is: NO.
   1.217 +
   1.218 +OPTIMIZE_OUTPUT_SLICE  = NO
   1.219 +
   1.220  # Doxygen selects the parser to use depending on the extension of the files it
   1.221  # parses. With this tag you can assign which parser to use for a given
   1.222  # extension. Doxygen has a built-in mapping, but you can override or extend it
   1.223  # using this tag. The format is ext=language, where ext is a file extension, and
   1.224 -# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
   1.225 -# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
   1.226 -# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
   1.227 -# Fortran. In the later case the parser tries to guess whether the code is fixed
   1.228 -# or free formatted code, this is the default for Fortran type files), VHDL. For
   1.229 -# instance to make doxygen treat .inc files as Fortran files (default is PHP),
   1.230 -# and .f files as C (default is Fortran), use: inc=Fortran f=C.
   1.231 +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
   1.232 +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,
   1.233 +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
   1.234 +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
   1.235 +# tries to guess whether the code is fixed or free formatted code, this is the
   1.236 +# default for Fortran type files). For instance to make doxygen treat .inc files
   1.237 +# as Fortran files (default is PHP), and .f files as C (default is Fortran),
   1.238 +# use: inc=Fortran f=C.
   1.239  #
   1.240 -# Note For files without extension you can use no_extension as a placeholder.
   1.241 +# Note: For files without extension you can use no_extension as a placeholder.
   1.242  #
   1.243  # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
   1.244 -# the files are not read by doxygen.
   1.245 +# the files are not read by doxygen. When specifying no_extension you should add
   1.246 +# * to the FILE_PATTERNS.
   1.247 +#
   1.248 +# Note see also the list of default file extension mappings.
   1.249  
   1.250  EXTENSION_MAPPING      =
   1.251  
   1.252  # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
   1.253  # according to the Markdown format, which allows for more readable
   1.254 -# documentation. See http://daringfireball.net/projects/markdown/ for details.
   1.255 +# documentation. See https://daringfireball.net/projects/markdown/ for details.
   1.256  # The output of markdown processing is further processed by doxygen, so you can
   1.257  # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
   1.258  # case of backward compatibilities issues.
   1.259 @@ -287,10 +344,19 @@
   1.260  
   1.261  MARKDOWN_SUPPORT       = YES
   1.262  
   1.263 +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
   1.264 +# to that level are automatically included in the table of contents, even if
   1.265 +# they do not have an id attribute.
   1.266 +# Note: This feature currently applies only to Markdown headings.
   1.267 +# Minimum value: 0, maximum value: 99, default value: 5.
   1.268 +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
   1.269 +
   1.270 +TOC_INCLUDE_HEADINGS   = 5
   1.271 +
   1.272  # When enabled doxygen tries to link words that correspond to documented
   1.273  # classes, or namespaces to their corresponding documentation. Such a link can
   1.274 -# be prevented in individual cases by by putting a % sign in front of the word
   1.275 -# or globally by setting AUTOLINK_SUPPORT to NO.
   1.276 +# be prevented in individual cases by putting a % sign in front of the word or
   1.277 +# globally by setting AUTOLINK_SUPPORT to NO.
   1.278  # The default value is: YES.
   1.279  
   1.280  AUTOLINK_SUPPORT       = YES
   1.281 @@ -312,7 +378,7 @@
   1.282  CPP_CLI_SUPPORT        = NO
   1.283  
   1.284  # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
   1.285 -# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
   1.286 +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
   1.287  # will parse them like normal C++ but will assume all classes use public instead
   1.288  # of private inheritance when no explicit protection keyword is present.
   1.289  # The default value is: NO.
   1.290 @@ -330,13 +396,20 @@
   1.291  IDL_PROPERTY_SUPPORT   = YES
   1.292  
   1.293  # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
   1.294 -# tag is set to YES, then doxygen will reuse the documentation of the first
   1.295 +# tag is set to YES then doxygen will reuse the documentation of the first
   1.296  # member in the group (if any) for the other members of the group. By default
   1.297  # all members of a group must be documented explicitly.
   1.298  # The default value is: NO.
   1.299  
   1.300  DISTRIBUTE_GROUP_DOC   = NO
   1.301  
   1.302 +# If one adds a struct or class to a group and this option is enabled, then also
   1.303 +# any nested class or struct is added to the same group. By default this option
   1.304 +# is disabled and one has to add nested compounds explicitly via \ingroup.
   1.305 +# The default value is: NO.
   1.306 +
   1.307 +GROUP_NESTED_COMPOUNDS = NO
   1.308 +
   1.309  # Set the SUBGROUPING tag to YES to allow class member groups of the same type
   1.310  # (for instance a group of public functions) to be put as a subgroup of that
   1.311  # type (e.g. under the Public Functions section). Set it to NO to prevent
   1.312 @@ -391,11 +464,24 @@
   1.313  
   1.314  LOOKUP_CACHE_SIZE      = 0
   1.315  
   1.316 +# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use
   1.317 +# during processing. When set to 0 doxygen will based this on the number of
   1.318 +# cores available in the system. You can set it explicitly to a value larger
   1.319 +# than 0 to get more control over the balance between CPU load and processing
   1.320 +# speed. At this moment only the input processing can be done using multiple
   1.321 +# threads. Since this is still an experimental feature the default is set to 1,
   1.322 +# which effectively disables parallel processing. Please report any issues you
   1.323 +# encounter. Generating dot graphs in parallel is controlled by the
   1.324 +# DOT_NUM_THREADS setting.
   1.325 +# Minimum value: 0, maximum value: 32, default value: 1.
   1.326 +
   1.327 +NUM_PROC_THREADS       = 1
   1.328 +
   1.329  #---------------------------------------------------------------------------
   1.330  # Build related configuration options
   1.331  #---------------------------------------------------------------------------
   1.332  
   1.333 -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
   1.334 +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
   1.335  # documentation are documented, even if no documentation was available. Private
   1.336  # class members and static file members will be hidden unless the
   1.337  # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
   1.338 @@ -405,35 +491,41 @@
   1.339  
   1.340  EXTRACT_ALL            = NO
   1.341  
   1.342 -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
   1.343 +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
   1.344  # be included in the documentation.
   1.345  # The default value is: NO.
   1.346  
   1.347  EXTRACT_PRIVATE        = NO
   1.348  
   1.349 -# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
   1.350 +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
   1.351 +# methods of a class will be included in the documentation.
   1.352 +# The default value is: NO.
   1.353 +
   1.354 +EXTRACT_PRIV_VIRTUAL   = NO
   1.355 +
   1.356 +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
   1.357  # scope will be included in the documentation.
   1.358  # The default value is: NO.
   1.359  
   1.360  EXTRACT_PACKAGE        = NO
   1.361  
   1.362 -# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
   1.363 +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
   1.364  # included in the documentation.
   1.365  # The default value is: NO.
   1.366  
   1.367  EXTRACT_STATIC         = YES
   1.368  
   1.369 -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
   1.370 -# locally in source files will be included in the documentation. If set to NO
   1.371 +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
   1.372 +# locally in source files will be included in the documentation. If set to NO,
   1.373  # only classes defined in header files are included. Does not have any effect
   1.374  # for Java sources.
   1.375  # The default value is: YES.
   1.376  
   1.377  EXTRACT_LOCAL_CLASSES  = YES
   1.378  
   1.379 -# This flag is only useful for Objective-C code. When set to YES local methods,
   1.380 +# This flag is only useful for Objective-C code. If set to YES, local methods,
   1.381  # which are defined in the implementation section but not in the interface are
   1.382 -# included in the documentation. If set to NO only methods in the interface are
   1.383 +# included in the documentation. If set to NO, only methods in the interface are
   1.384  # included.
   1.385  # The default value is: NO.
   1.386  
   1.387 @@ -448,6 +540,13 @@
   1.388  
   1.389  EXTRACT_ANON_NSPACES   = NO
   1.390  
   1.391 +# If this flag is set to YES, the name of an unnamed parameter in a declaration
   1.392 +# will be determined by the corresponding definition. By default unnamed
   1.393 +# parameters remain unnamed in the output.
   1.394 +# The default value is: YES.
   1.395 +
   1.396 +RESOLVE_UNNAMED_PARAMS = YES
   1.397 +
   1.398  # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
   1.399  # undocumented members inside documented classes or files. If set to NO these
   1.400  # members will be included in the various overviews, but no documentation
   1.401 @@ -458,21 +557,22 @@
   1.402  
   1.403  # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
   1.404  # undocumented classes that are normally visible in the class hierarchy. If set
   1.405 -# to NO these classes will be included in the various overviews. This option has
   1.406 -# no effect if EXTRACT_ALL is enabled.
   1.407 +# to NO, these classes will be included in the various overviews. This option
   1.408 +# will also hide undocumented C++ concepts if enabled. This option has no effect
   1.409 +# if EXTRACT_ALL is enabled.
   1.410  # The default value is: NO.
   1.411  
   1.412  HIDE_UNDOC_CLASSES     = NO
   1.413  
   1.414  # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
   1.415 -# (class|struct|union) declarations. If set to NO these declarations will be
   1.416 -# included in the documentation.
   1.417 +# declarations. If set to NO, these declarations will be included in the
   1.418 +# documentation.
   1.419  # The default value is: NO.
   1.420  
   1.421  HIDE_FRIEND_COMPOUNDS  = NO
   1.422  
   1.423  # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
   1.424 -# documentation blocks found inside the body of a function. If set to NO these
   1.425 +# documentation blocks found inside the body of a function. If set to NO, these
   1.426  # blocks will be appended to the function's detailed documentation block.
   1.427  # The default value is: NO.
   1.428  
   1.429 @@ -485,22 +585,43 @@
   1.430  
   1.431  INTERNAL_DOCS          = NO
   1.432  
   1.433 -# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
   1.434 -# names in lower-case letters. If set to YES upper-case letters are also
   1.435 -# allowed. This is useful if you have classes or files whose names only differ
   1.436 -# in case and if your file system supports case sensitive file names. Windows
   1.437 -# and Mac users are advised to set this option to NO.
   1.438 -# The default value is: system dependent.
   1.439 +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be
   1.440 +# able to match the capabilities of the underlying filesystem. In case the
   1.441 +# filesystem is case sensitive (i.e. it supports files in the same directory
   1.442 +# whose names only differ in casing), the option must be set to YES to properly
   1.443 +# deal with such files in case they appear in the input. For filesystems that
   1.444 +# are not case sensitive the option should be set to NO to properly deal with
   1.445 +# output files written for symbols that only differ in casing, such as for two
   1.446 +# classes, one named CLASS and the other named Class, and to also support
   1.447 +# references to files without having to specify the exact matching casing. On
   1.448 +# Windows (including Cygwin) and MacOS, users should typically set this option
   1.449 +# to NO, whereas on Linux or other Unix flavors it should typically be set to
   1.450 +# YES.
   1.451 +# Possible values are: SYSTEM, NO and YES.
   1.452 +# The default value is: SYSTEM.
   1.453  
   1.454  CASE_SENSE_NAMES       = YES
   1.455  
   1.456  # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
   1.457 -# their full class and namespace scopes in the documentation. If set to YES the
   1.458 +# their full class and namespace scopes in the documentation. If set to YES, the
   1.459  # scope will be hidden.
   1.460  # The default value is: NO.
   1.461  
   1.462  HIDE_SCOPE_NAMES       = NO
   1.463  
   1.464 +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
   1.465 +# append additional text to a page's title, such as Class Reference. If set to
   1.466 +# YES the compound reference will be hidden.
   1.467 +# The default value is: NO.
   1.468 +
   1.469 +HIDE_COMPOUND_REFERENCE= NO
   1.470 +
   1.471 +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
   1.472 +# will show which file needs to be included to use the class.
   1.473 +# The default value is: YES.
   1.474 +
   1.475 +SHOW_HEADERFILE        = YES
   1.476 +
   1.477  # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
   1.478  # the files that are included by a file in the documentation of that file.
   1.479  # The default value is: YES.
   1.480 @@ -528,14 +649,14 @@
   1.481  
   1.482  # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
   1.483  # (detailed) documentation of file and class members alphabetically by member
   1.484 -# name. If set to NO the members will appear in declaration order.
   1.485 +# name. If set to NO, the members will appear in declaration order.
   1.486  # The default value is: YES.
   1.487  
   1.488  SORT_MEMBER_DOCS       = YES
   1.489  
   1.490  # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
   1.491  # descriptions of file, namespace and class members alphabetically by member
   1.492 -# name. If set to NO the members will appear in declaration order. Note that
   1.493 +# name. If set to NO, the members will appear in declaration order. Note that
   1.494  # this will also influence the order of the classes in the class list.
   1.495  # The default value is: NO.
   1.496  
   1.497 @@ -580,27 +701,25 @@
   1.498  
   1.499  STRICT_PROTO_MATCHING  = NO
   1.500  
   1.501 -# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
   1.502 -# todo list. This list is created by putting \todo commands in the
   1.503 -# documentation.
   1.504 +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
   1.505 +# list. This list is created by putting \todo commands in the documentation.
   1.506  # The default value is: YES.
   1.507  
   1.508  GENERATE_TODOLIST      = YES
   1.509  
   1.510 -# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
   1.511 -# test list. This list is created by putting \test commands in the
   1.512 -# documentation.
   1.513 +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
   1.514 +# list. This list is created by putting \test commands in the documentation.
   1.515  # The default value is: YES.
   1.516  
   1.517  GENERATE_TESTLIST      = YES
   1.518  
   1.519 -# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
   1.520 +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
   1.521  # list. This list is created by putting \bug commands in the documentation.
   1.522  # The default value is: YES.
   1.523  
   1.524  GENERATE_BUGLIST       = YES
   1.525  
   1.526 -# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
   1.527 +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
   1.528  # the deprecated list. This list is created by putting \deprecated commands in
   1.529  # the documentation.
   1.530  # The default value is: YES.
   1.531 @@ -625,8 +744,8 @@
   1.532  MAX_INITIALIZER_LINES  = 30
   1.533  
   1.534  # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
   1.535 -# the bottom of the documentation of classes and structs. If set to YES the list
   1.536 -# will mention the files that were used to generate the documentation.
   1.537 +# the bottom of the documentation of classes and structs. If set to YES, the
   1.538 +# list will mention the files that were used to generate the documentation.
   1.539  # The default value is: YES.
   1.540  
   1.541  SHOW_USED_FILES        = YES
   1.542 @@ -660,7 +779,8 @@
   1.543  # output files in an output format independent way. To create the layout file
   1.544  # that represents doxygen's defaults, run doxygen with the -l option. You can
   1.545  # optionally specify a file name after the option, if omitted DoxygenLayout.xml
   1.546 -# will be used as the name of the layout file.
   1.547 +# will be used as the name of the layout file. See also section "Changing the
   1.548 +# layout of pages" for information.
   1.549  #
   1.550  # Note that if you run doxygen from a directory containing a file called
   1.551  # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
   1.552 @@ -671,11 +791,10 @@
   1.553  # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
   1.554  # the reference definitions. This must be a list of .bib files. The .bib
   1.555  # extension is automatically appended if omitted. This requires the bibtex tool
   1.556 -# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
   1.557 +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
   1.558  # For LaTeX the style of the bibliography can be controlled using
   1.559  # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
   1.560 -# search path. Do not use file names with spaces, bibtex cannot handle them. See
   1.561 -# also \cite for info how to create references.
   1.562 +# search path. See also \cite for info how to create references.
   1.563  
   1.564  CITE_BIB_FILES         =
   1.565  
   1.566 @@ -691,7 +810,7 @@
   1.567  QUIET                  = NO
   1.568  
   1.569  # The WARNINGS tag can be used to turn on/off the warning messages that are
   1.570 -# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
   1.571 +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
   1.572  # this implies that the warnings are on.
   1.573  #
   1.574  # Tip: Turn warnings on while writing the documentation.
   1.575 @@ -699,7 +818,7 @@
   1.576  
   1.577  WARNINGS               = YES
   1.578  
   1.579 -# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
   1.580 +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
   1.581  # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
   1.582  # will automatically be disabled.
   1.583  # The default value is: YES.
   1.584 @@ -707,34 +826,74 @@
   1.585  WARN_IF_UNDOCUMENTED   = YES
   1.586  
   1.587  # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
   1.588 -# potential errors in the documentation, such as not documenting some parameters
   1.589 -# in a documented function, or documenting parameters that don't exist or using
   1.590 -# markup commands wrongly.
   1.591 +# potential errors in the documentation, such as documenting some parameters in
   1.592 +# a documented function twice, or documenting parameters that don't exist or
   1.593 +# using markup commands wrongly.
   1.594  # The default value is: YES.
   1.595  
   1.596  WARN_IF_DOC_ERROR      = YES
   1.597  
   1.598 +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
   1.599 +# function parameter documentation. If set to NO, doxygen will accept that some
   1.600 +# parameters have no documentation without warning.
   1.601 +# The default value is: YES.
   1.602 +
   1.603 +WARN_IF_INCOMPLETE_DOC = YES
   1.604 +
   1.605  # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
   1.606  # are documented, but have no documentation for their parameters or return
   1.607 -# value. If set to NO doxygen will only warn about wrong or incomplete parameter
   1.608 -# documentation, but not about the absence of documentation.
   1.609 +# value. If set to NO, doxygen will only warn about wrong parameter
   1.610 +# documentation, but not about the absence of documentation. If EXTRACT_ALL is
   1.611 +# set to YES then this flag will automatically be disabled. See also
   1.612 +# WARN_IF_INCOMPLETE_DOC
   1.613  # The default value is: NO.
   1.614  
   1.615  WARN_NO_PARAMDOC       = YES
   1.616  
   1.617 +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about
   1.618 +# undocumented enumeration values. If set to NO, doxygen will accept
   1.619 +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag
   1.620 +# will automatically be disabled.
   1.621 +# The default value is: NO.
   1.622 +
   1.623 +WARN_IF_UNDOC_ENUM_VAL = NO
   1.624 +
   1.625 +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
   1.626 +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
   1.627 +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
   1.628 +# at the end of the doxygen process doxygen will return with a non-zero status.
   1.629 +# Possible values are: NO, YES and FAIL_ON_WARNINGS.
   1.630 +# The default value is: NO.
   1.631 +
   1.632 +WARN_AS_ERROR          = NO
   1.633 +
   1.634  # The WARN_FORMAT tag determines the format of the warning messages that doxygen
   1.635  # can produce. The string should contain the $file, $line, and $text tags, which
   1.636  # will be replaced by the file and line number from which the warning originated
   1.637  # and the warning text. Optionally the format may contain $version, which will
   1.638  # be replaced by the version of the file (if it could be obtained via
   1.639  # FILE_VERSION_FILTER)
   1.640 +# See also: WARN_LINE_FORMAT
   1.641  # The default value is: $file:$line: $text.
   1.642  
   1.643  WARN_FORMAT            = "$file:$line: $text"
   1.644  
   1.645 +# In the $text part of the WARN_FORMAT command it is possible that a reference
   1.646 +# to a more specific place is given. To make it easier to jump to this place
   1.647 +# (outside of doxygen) the user can define a custom "cut" / "paste" string.
   1.648 +# Example:
   1.649 +# WARN_LINE_FORMAT = "'vi $file +$line'"
   1.650 +# See also: WARN_FORMAT
   1.651 +# The default value is: at line $line of file $file.
   1.652 +
   1.653 +WARN_LINE_FORMAT       = "at line $line of file $file"
   1.654 +
   1.655  # The WARN_LOGFILE tag can be used to specify a file to which warning and error
   1.656  # messages should be written. If left blank the output is written to standard
   1.657 -# error (stderr).
   1.658 +# error (stderr). In case the file specified cannot be opened for writing the
   1.659 +# warning and error messages are written to standard error. When as file - is
   1.660 +# specified the warning and error messages are written to standard output
   1.661 +# (stdout).
   1.662  
   1.663  WARN_LOGFILE           =
   1.664  
   1.665 @@ -745,7 +904,7 @@
   1.666  # The INPUT tag is used to specify the files and/or directories that contain
   1.667  # documented source files. You may enter file names like myfile.cpp or
   1.668  # directories like /usr/src/myproject. Separate the files or directories with
   1.669 -# spaces.
   1.670 +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
   1.671  # Note: If this tag is empty the current directory is searched.
   1.672  
   1.673  INPUT                  = ./src/cx
   1.674 @@ -753,20 +912,40 @@
   1.675  # This tag can be used to specify the character encoding of the source files
   1.676  # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
   1.677  # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
   1.678 -# documentation (see: http://www.gnu.org/software/libiconv) for the list of
   1.679 -# possible encodings.
   1.680 +# documentation (see:
   1.681 +# https://www.gnu.org/software/libiconv/) for the list of possible encodings.
   1.682 +# See also: INPUT_FILE_ENCODING
   1.683  # The default value is: UTF-8.
   1.684  
   1.685  INPUT_ENCODING         = UTF-8
   1.686  
   1.687 +# This tag can be used to specify the character encoding of the source files
   1.688 +# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify
   1.689 +# character encoding on a per file pattern basis. Doxygen will compare the file
   1.690 +# name with each pattern and apply the encoding instead of the default
   1.691 +# INPUT_ENCODING) if there is a match. The character encodings are a list of the
   1.692 +# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding
   1.693 +# "INPUT_ENCODING" for further information on supported encodings.
   1.694 +
   1.695 +INPUT_FILE_ENCODING    =
   1.696 +
   1.697  # If the value of the INPUT tag contains directories, you can use the
   1.698  # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
   1.699 -# *.h) to filter out the source-files in the directories. If left blank the
   1.700 -# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
   1.701 -# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
   1.702 -# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
   1.703 -# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
   1.704 -# *.qsf, *.as and *.js.
   1.705 +# *.h) to filter out the source-files in the directories.
   1.706 +#
   1.707 +# Note that for custom extensions or not directly supported extensions you also
   1.708 +# need to set EXTENSION_MAPPING for the extension otherwise the files are not
   1.709 +# read by doxygen.
   1.710 +#
   1.711 +# Note the list of default checked file patterns might differ from the list of
   1.712 +# default file extension mappings.
   1.713 +#
   1.714 +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
   1.715 +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
   1.716 +# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml,
   1.717 +# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C
   1.718 +# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,
   1.719 +# *.vhdl, *.ucf, *.qsf and *.ice.
   1.720  
   1.721  FILE_PATTERNS          =
   1.722  
   1.723 @@ -805,7 +984,7 @@
   1.724  # (namespaces, classes, functions, etc.) that should be excluded from the
   1.725  # output. The symbol name can be a fully qualified name, a word, or if the
   1.726  # wildcard * is used, a substring. Examples: ANamespace, AClass,
   1.727 -# AClass::ANamespace, ANamespace::*Test
   1.728 +# ANamespace::AClass, ANamespace::*Test
   1.729  #
   1.730  # Note that the wildcards are matched against the file with absolute path, so to
   1.731  # exclude all test directories use the pattern */test/*
   1.732 @@ -852,6 +1031,15 @@
   1.733  # Note that the filter must not add or remove lines; it is applied before the
   1.734  # code is scanned, but not when the output code is generated. If lines are added
   1.735  # or removed, the anchors will not be placed correctly.
   1.736 +#
   1.737 +# Note that doxygen will use the data processed and written to standard output
   1.738 +# for further processing, therefore nothing else, like debug statements or used
   1.739 +# commands (so in case of a Windows batch file always use @echo OFF), should be
   1.740 +# written to standard output.
   1.741 +#
   1.742 +# Note that for custom extensions or not directly supported extensions you also
   1.743 +# need to set EXTENSION_MAPPING for the extension otherwise the files are not
   1.744 +# properly processed by doxygen.
   1.745  
   1.746  INPUT_FILTER           =
   1.747  
   1.748 @@ -861,11 +1049,15 @@
   1.749  # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
   1.750  # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
   1.751  # patterns match the file name, INPUT_FILTER is applied.
   1.752 +#
   1.753 +# Note that for custom extensions or not directly supported extensions you also
   1.754 +# need to set EXTENSION_MAPPING for the extension otherwise the files are not
   1.755 +# properly processed by doxygen.
   1.756  
   1.757  FILTER_PATTERNS        =
   1.758  
   1.759  # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
   1.760 -# INPUT_FILTER ) will also be used to filter the input files that are used for
   1.761 +# INPUT_FILTER) will also be used to filter the input files that are used for
   1.762  # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
   1.763  # The default value is: NO.
   1.764  
   1.765 @@ -886,6 +1078,15 @@
   1.766  
   1.767  USE_MDFILE_AS_MAINPAGE =
   1.768  
   1.769 +# The Fortran standard specifies that for fixed formatted Fortran code all
   1.770 +# characters from position 72 are to be considered as comment. A common
   1.771 +# extension is to allow longer lines before the automatic comment starts. The
   1.772 +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can
   1.773 +# be processed before the automatic comment starts.
   1.774 +# Minimum value: 7, maximum value: 10000, default value: 72.
   1.775 +
   1.776 +FORTRAN_COMMENT_AFTER  = 72
   1.777 +
   1.778  #---------------------------------------------------------------------------
   1.779  # Configuration options related to source browsing
   1.780  #---------------------------------------------------------------------------
   1.781 @@ -913,7 +1114,7 @@
   1.782  STRIP_CODE_COMMENTS    = YES
   1.783  
   1.784  # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
   1.785 -# function all documented functions referencing it will be listed.
   1.786 +# entity all documented functions referencing it will be listed.
   1.787  # The default value is: NO.
   1.788  
   1.789  REFERENCED_BY_RELATION = NO
   1.790 @@ -925,7 +1126,7 @@
   1.791  REFERENCES_RELATION    = NO
   1.792  
   1.793  # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
   1.794 -# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
   1.795 +# to YES then the hyperlinks from functions in REFERENCES_RELATION and
   1.796  # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
   1.797  # link to the documentation.
   1.798  # The default value is: YES.
   1.799 @@ -945,12 +1146,12 @@
   1.800  # If the USE_HTAGS tag is set to YES then the references to source code will
   1.801  # point to the HTML generated by the htags(1) tool instead of doxygen built-in
   1.802  # source browser. The htags tool is part of GNU's global source tagging system
   1.803 -# (see http://www.gnu.org/software/global/global.html). You will need version
   1.804 +# (see https://www.gnu.org/software/global/global.html). You will need version
   1.805  # 4.8.6 or higher.
   1.806  #
   1.807  # To use it do the following:
   1.808  # - Install the latest version of global
   1.809 -# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
   1.810 +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
   1.811  # - Make sure the INPUT points to the root of the source tree
   1.812  # - Run doxygen as normal
   1.813  #
   1.814 @@ -972,6 +1173,46 @@
   1.815  
   1.816  VERBATIM_HEADERS       = YES
   1.817  
   1.818 +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
   1.819 +# clang parser (see:
   1.820 +# http://clang.llvm.org/) for more accurate parsing at the cost of reduced
   1.821 +# performance. This can be particularly helpful with template rich C++ code for
   1.822 +# which doxygen's built-in parser lacks the necessary type information.
   1.823 +# Note: The availability of this option depends on whether or not doxygen was
   1.824 +# generated with the -Duse_libclang=ON option for CMake.
   1.825 +# The default value is: NO.
   1.826 +
   1.827 +CLANG_ASSISTED_PARSING = NO
   1.828 +
   1.829 +# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS
   1.830 +# tag is set to YES then doxygen will add the directory of each input to the
   1.831 +# include path.
   1.832 +# The default value is: YES.
   1.833 +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
   1.834 +
   1.835 +CLANG_ADD_INC_PATHS    = YES
   1.836 +
   1.837 +# If clang assisted parsing is enabled you can provide the compiler with command
   1.838 +# line options that you would normally use when invoking the compiler. Note that
   1.839 +# the include paths will already be set by doxygen for the files and directories
   1.840 +# specified with INPUT and INCLUDE_PATH.
   1.841 +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
   1.842 +
   1.843 +CLANG_OPTIONS          =
   1.844 +
   1.845 +# If clang assisted parsing is enabled you can provide the clang parser with the
   1.846 +# path to the directory containing a file called compile_commands.json. This
   1.847 +# file is the compilation database (see:
   1.848 +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the
   1.849 +# options used when the source files were built. This is equivalent to
   1.850 +# specifying the -p option to a clang tool, such as clang-check. These options
   1.851 +# will then be passed to the parser. Any options specified with CLANG_OPTIONS
   1.852 +# will be added as well.
   1.853 +# Note: The availability of this option depends on whether or not doxygen was
   1.854 +# generated with the -Duse_libclang=ON option for CMake.
   1.855 +
   1.856 +CLANG_DATABASE_PATH    =
   1.857 +
   1.858  #---------------------------------------------------------------------------
   1.859  # Configuration options related to the alphabetical class index
   1.860  #---------------------------------------------------------------------------
   1.861 @@ -983,10 +1224,11 @@
   1.862  
   1.863  ALPHABETICAL_INDEX     = YES
   1.864  
   1.865 -# In case all classes in a project start with a common prefix, all classes will
   1.866 -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
   1.867 -# can be used to specify a prefix (or a list of prefixes) that should be ignored
   1.868 -# while generating the index headers.
   1.869 +# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes)
   1.870 +# that should be ignored while generating the index headers. The IGNORE_PREFIX
   1.871 +# tag works for classes, function and member names. The entity will be placed in
   1.872 +# the alphabetical list under the first letter of the entity name that remains
   1.873 +# after removing the prefix.
   1.874  # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
   1.875  
   1.876  IGNORE_PREFIX          =
   1.877 @@ -995,7 +1237,7 @@
   1.878  # Configuration options related to the HTML output
   1.879  #---------------------------------------------------------------------------
   1.880  
   1.881 -# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
   1.882 +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
   1.883  # The default value is: YES.
   1.884  
   1.885  GENERATE_HTML          = YES
   1.886 @@ -1057,13 +1299,20 @@
   1.887  
   1.888  HTML_STYLESHEET        =
   1.889  
   1.890 -# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
   1.891 -# defined cascading style sheet that is included after the standard style sheets
   1.892 +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
   1.893 +# cascading style sheets that are included after the standard style sheets
   1.894  # created by doxygen. Using this option one can overrule certain style aspects.
   1.895  # This is preferred over using HTML_STYLESHEET since it does not replace the
   1.896 -# standard style sheet and is therefor more robust against future updates.
   1.897 -# Doxygen will copy the style sheet file to the output directory. For an example
   1.898 -# see the documentation.
   1.899 +# standard style sheet and is therefore more robust against future updates.
   1.900 +# Doxygen will copy the style sheet files to the output directory.
   1.901 +# Note: The order of the extra style sheet files is of importance (e.g. the last
   1.902 +# style sheet in the list overrules the setting of the previous ones in the
   1.903 +# list).
   1.904 +# Note: Since the styling of scrollbars can currently not be overruled in
   1.905 +# Webkit/Chromium, the styling will be left out of the default doxygen.css if
   1.906 +# one or more extra stylesheets have been specified. So if scrollbar
   1.907 +# customization is desired it has to be added explicitly. For an example see the
   1.908 +# documentation.
   1.909  # This tag requires that the tag GENERATE_HTML is set to YES.
   1.910  
   1.911  HTML_EXTRA_STYLESHEET  =
   1.912 @@ -1078,10 +1327,23 @@
   1.913  
   1.914  HTML_EXTRA_FILES       =
   1.915  
   1.916 +# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
   1.917 +# should be rendered with a dark or light theme.
   1.918 +# Possible values are: LIGHT always generate light mode output, DARK always
   1.919 +# generate dark mode output, AUTO_LIGHT automatically set the mode according to
   1.920 +# the user preference, use light mode if no preference is set (the default),
   1.921 +# AUTO_DARK automatically set the mode according to the user preference, use
   1.922 +# dark mode if no preference is set and TOGGLE allow to user to switch between
   1.923 +# light and dark mode via a button.
   1.924 +# The default value is: AUTO_LIGHT.
   1.925 +# This tag requires that the tag GENERATE_HTML is set to YES.
   1.926 +
   1.927 +HTML_COLORSTYLE        = AUTO_LIGHT
   1.928 +
   1.929  # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
   1.930 -# will adjust the colors in the stylesheet and background images according to
   1.931 -# this color. Hue is specified as an angle on a colorwheel, see
   1.932 -# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
   1.933 +# will adjust the colors in the style sheet and background images according to
   1.934 +# this color. Hue is specified as an angle on a color-wheel, see
   1.935 +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
   1.936  # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
   1.937  # purple, and 360 is red again.
   1.938  # Minimum value: 0, maximum value: 359, default value: 220.
   1.939 @@ -1090,7 +1352,7 @@
   1.940  HTML_COLORSTYLE_HUE    = 220
   1.941  
   1.942  # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
   1.943 -# in the HTML output. For a value of 0 the output will use grayscales only. A
   1.944 +# in the HTML output. For a value of 0 the output will use gray-scales only. A
   1.945  # value of 255 will produce the most vivid colors.
   1.946  # Minimum value: 0, maximum value: 255, default value: 100.
   1.947  # This tag requires that the tag GENERATE_HTML is set to YES.
   1.948 @@ -1110,11 +1372,23 @@
   1.949  
   1.950  # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
   1.951  # page will contain the date and time when the page was generated. Setting this
   1.952 -# to NO can help when comparing the output of multiple runs.
   1.953 +# to YES can help to show when doxygen was last run and thus if the
   1.954 +# documentation is up to date.
   1.955 +# The default value is: NO.
   1.956 +# This tag requires that the tag GENERATE_HTML is set to YES.
   1.957 +
   1.958 +HTML_TIMESTAMP         = YES
   1.959 +
   1.960 +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
   1.961 +# documentation will contain a main index with vertical navigation menus that
   1.962 +# are dynamically created via JavaScript. If disabled, the navigation index will
   1.963 +# consists of multiple levels of tabs that are statically embedded in every HTML
   1.964 +# page. Disable this option to support browsers that do not have JavaScript,
   1.965 +# like the Qt help browser.
   1.966  # The default value is: YES.
   1.967  # This tag requires that the tag GENERATE_HTML is set to YES.
   1.968  
   1.969 -HTML_TIMESTAMP         = YES
   1.970 +HTML_DYNAMIC_MENUS     = YES
   1.971  
   1.972  # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
   1.973  # documentation will contain sections that can be hidden and shown after the
   1.974 @@ -1139,13 +1413,14 @@
   1.975  
   1.976  # If the GENERATE_DOCSET tag is set to YES, additional index files will be
   1.977  # generated that can be used as input for Apple's Xcode 3 integrated development
   1.978 -# environment (see: http://developer.apple.com/tools/xcode/), introduced with
   1.979 -# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
   1.980 -# Makefile in the HTML output directory. Running make will produce the docset in
   1.981 -# that directory and running make install will install the docset in
   1.982 +# environment (see:
   1.983 +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
   1.984 +# create a documentation set, doxygen will generate a Makefile in the HTML
   1.985 +# output directory. Running make will produce the docset in that directory and
   1.986 +# running make install will install the docset in
   1.987  # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
   1.988 -# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
   1.989 -# for more information.
   1.990 +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
   1.991 +# genXcode/_index.html for more information.
   1.992  # The default value is: NO.
   1.993  # This tag requires that the tag GENERATE_HTML is set to YES.
   1.994  
   1.995 @@ -1159,6 +1434,13 @@
   1.996  
   1.997  DOCSET_FEEDNAME        = "Doxygen generated docs"
   1.998  
   1.999 +# This tag determines the URL of the docset feed. A documentation feed provides
  1.1000 +# an umbrella under which multiple documentation sets from a single provider
  1.1001 +# (such as a company or product suite) can be grouped.
  1.1002 +# This tag requires that the tag GENERATE_DOCSET is set to YES.
  1.1003 +
  1.1004 +DOCSET_FEEDURL         =
  1.1005 +
  1.1006  # This tag specifies a string that should uniquely identify the documentation
  1.1007  # set bundle. This should be a reverse domain-name style string, e.g.
  1.1008  # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
  1.1009 @@ -1184,8 +1466,12 @@
  1.1010  # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
  1.1011  # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
  1.1012  # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
  1.1013 -# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
  1.1014 -# Windows.
  1.1015 +# on Windows. In the beginning of 2021 Microsoft took the original page, with
  1.1016 +# a.o. the download links, offline the HTML help workshop was already many years
  1.1017 +# in maintenance mode). You can download the HTML help workshop from the web
  1.1018 +# archives at Installation executable (see:
  1.1019 +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo
  1.1020 +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
  1.1021  #
  1.1022  # The HTML Help Workshop contains a compiler that can convert all HTML output
  1.1023  # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
  1.1024 @@ -1207,28 +1493,28 @@
  1.1025  CHM_FILE               =
  1.1026  
  1.1027  # The HHC_LOCATION tag can be used to specify the location (absolute path
  1.1028 -# including file name) of the HTML help compiler ( hhc.exe). If non-empty
  1.1029 +# including file name) of the HTML help compiler (hhc.exe). If non-empty,
  1.1030  # doxygen will try to run the HTML help compiler on the generated index.hhp.
  1.1031  # The file has to be specified with full path.
  1.1032  # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1.1033  
  1.1034  HHC_LOCATION           =
  1.1035  
  1.1036 -# The GENERATE_CHI flag controls if a separate .chi index file is generated (
  1.1037 -# YES) or that it should be included in the master .chm file ( NO).
  1.1038 +# The GENERATE_CHI flag controls if a separate .chi index file is generated
  1.1039 +# (YES) or that it should be included in the main .chm file (NO).
  1.1040  # The default value is: NO.
  1.1041  # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1.1042  
  1.1043  GENERATE_CHI           = NO
  1.1044  
  1.1045 -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
  1.1046 +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
  1.1047  # and project file content.
  1.1048  # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1.1049  
  1.1050  CHM_INDEX_ENCODING     =
  1.1051  
  1.1052 -# The BINARY_TOC flag controls whether a binary table of contents is generated (
  1.1053 -# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it
  1.1054 +# The BINARY_TOC flag controls whether a binary table of contents is generated
  1.1055 +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
  1.1056  # enables the Previous and Next buttons.
  1.1057  # The default value is: NO.
  1.1058  # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1.1059 @@ -1260,7 +1546,8 @@
  1.1060  
  1.1061  # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
  1.1062  # Project output. For more information please see Qt Help Project / Namespace
  1.1063 -# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
  1.1064 +# (see:
  1.1065 +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
  1.1066  # The default value is: org.doxygen.Project.
  1.1067  # This tag requires that the tag GENERATE_QHP is set to YES.
  1.1068  
  1.1069 @@ -1268,8 +1555,8 @@
  1.1070  
  1.1071  # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
  1.1072  # Help Project output. For more information please see Qt Help Project / Virtual
  1.1073 -# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
  1.1074 -# folders).
  1.1075 +# Folders (see:
  1.1076 +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
  1.1077  # The default value is: doc.
  1.1078  # This tag requires that the tag GENERATE_QHP is set to YES.
  1.1079  
  1.1080 @@ -1277,30 +1564,30 @@
  1.1081  
  1.1082  # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
  1.1083  # filter to add. For more information please see Qt Help Project / Custom
  1.1084 -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
  1.1085 -# filters).
  1.1086 +# Filters (see:
  1.1087 +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
  1.1088  # This tag requires that the tag GENERATE_QHP is set to YES.
  1.1089  
  1.1090  QHP_CUST_FILTER_NAME   =
  1.1091  
  1.1092  # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
  1.1093  # custom filter to add. For more information please see Qt Help Project / Custom
  1.1094 -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
  1.1095 -# filters).
  1.1096 +# Filters (see:
  1.1097 +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
  1.1098  # This tag requires that the tag GENERATE_QHP is set to YES.
  1.1099  
  1.1100  QHP_CUST_FILTER_ATTRS  =
  1.1101  
  1.1102  # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
  1.1103  # project's filter section matches. Qt Help Project / Filter Attributes (see:
  1.1104 -# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
  1.1105 +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
  1.1106  # This tag requires that the tag GENERATE_QHP is set to YES.
  1.1107  
  1.1108  QHP_SECT_FILTER_ATTRS  =
  1.1109  
  1.1110 -# The QHG_LOCATION tag can be used to specify the location of Qt's
  1.1111 -# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
  1.1112 -# generated .qhp file.
  1.1113 +# The QHG_LOCATION tag can be used to specify the location (absolute path
  1.1114 +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
  1.1115 +# run qhelpgenerator on the generated .qhp file.
  1.1116  # This tag requires that the tag GENERATE_QHP is set to YES.
  1.1117  
  1.1118  QHG_LOCATION           =
  1.1119 @@ -1342,17 +1629,29 @@
  1.1120  # index structure (just like the one that is generated for HTML Help). For this
  1.1121  # to work a browser that supports JavaScript, DHTML, CSS and frames is required
  1.1122  # (i.e. any modern browser). Windows users are probably better off using the
  1.1123 -# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
  1.1124 -# further fine-tune the look of the index. As an example, the default style
  1.1125 -# sheet generated by doxygen has an example that shows how to put an image at
  1.1126 -# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
  1.1127 -# the same information as the tab index, you could consider setting
  1.1128 -# DISABLE_INDEX to YES when enabling this option.
  1.1129 +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
  1.1130 +# further fine tune the look of the index (see "Fine-tuning the output"). As an
  1.1131 +# example, the default style sheet generated by doxygen has an example that
  1.1132 +# shows how to put an image at the root of the tree instead of the PROJECT_NAME.
  1.1133 +# Since the tree basically has the same information as the tab index, you could
  1.1134 +# consider setting DISABLE_INDEX to YES when enabling this option.
  1.1135  # The default value is: NO.
  1.1136  # This tag requires that the tag GENERATE_HTML is set to YES.
  1.1137  
  1.1138  GENERATE_TREEVIEW      = NO
  1.1139  
  1.1140 +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
  1.1141 +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview
  1.1142 +# area (value NO) or if it should extend to the full height of the window (value
  1.1143 +# YES). Setting this to YES gives a layout similar to
  1.1144 +# https://docs.readthedocs.io with more room for contents, but less room for the
  1.1145 +# project logo, title, and description. If either GENERATE_TREEVIEW or
  1.1146 +# DISABLE_INDEX is set to NO, this option has no effect.
  1.1147 +# The default value is: NO.
  1.1148 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1.1149 +
  1.1150 +FULL_SIDEBAR           = NO
  1.1151 +
  1.1152  # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
  1.1153  # doxygen will group on one line in the generated HTML documentation.
  1.1154  #
  1.1155 @@ -1370,13 +1669,31 @@
  1.1156  
  1.1157  TREEVIEW_WIDTH         = 250
  1.1158  
  1.1159 -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
  1.1160 +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
  1.1161  # external symbols imported via tag files in a separate window.
  1.1162  # The default value is: NO.
  1.1163  # This tag requires that the tag GENERATE_HTML is set to YES.
  1.1164  
  1.1165  EXT_LINKS_IN_WINDOW    = NO
  1.1166  
  1.1167 +# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email
  1.1168 +# addresses.
  1.1169 +# The default value is: YES.
  1.1170 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1.1171 +
  1.1172 +OBFUSCATE_EMAILS       = YES
  1.1173 +
  1.1174 +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
  1.1175 +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
  1.1176 +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for
  1.1177 +# the HTML output. These images will generally look nicer at scaled resolutions.
  1.1178 +# Possible values are: png (the default) and svg (looks nicer but requires the
  1.1179 +# pdf2svg or inkscape tool).
  1.1180 +# The default value is: png.
  1.1181 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1.1182 +
  1.1183 +HTML_FORMULA_FORMAT    = png
  1.1184 +
  1.1185  # Use this tag to change the font size of LaTeX formulas included as images in
  1.1186  # the HTML documentation. When you change the font size after a successful
  1.1187  # doxygen run you need to manually remove any form_*.png images from the HTML
  1.1188 @@ -1386,20 +1703,15 @@
  1.1189  
  1.1190  FORMULA_FONTSIZE       = 10
  1.1191  
  1.1192 -# Use the FORMULA_TRANPARENT tag to determine whether or not the images
  1.1193 -# generated for formulas are transparent PNGs. Transparent PNGs are not
  1.1194 -# supported properly for IE 6.0, but are supported on all modern browsers.
  1.1195 -#
  1.1196 -# Note that when changing this option you need to delete any form_*.png files in
  1.1197 -# the HTML output directory before the changes have effect.
  1.1198 -# The default value is: YES.
  1.1199 -# This tag requires that the tag GENERATE_HTML is set to YES.
  1.1200 -
  1.1201 -FORMULA_TRANSPARENT    = YES
  1.1202 +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
  1.1203 +# to create new LaTeX commands to be used in formulas as building blocks. See
  1.1204 +# the section "Including formulas" for details.
  1.1205 +
  1.1206 +FORMULA_MACROFILE      =
  1.1207  
  1.1208  # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
  1.1209 -# http://www.mathjax.org) which uses client side Javascript for the rendering
  1.1210 -# instead of using prerendered bitmaps. Use this if you do not have LaTeX
  1.1211 +# https://www.mathjax.org) which uses client side JavaScript for the rendering
  1.1212 +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
  1.1213  # installed or if you want to formulas look prettier in the HTML output. When
  1.1214  # enabled you may also need to install MathJax separately and configure the path
  1.1215  # to it using the MATHJAX_RELPATH option.
  1.1216 @@ -1408,11 +1720,29 @@
  1.1217  
  1.1218  USE_MATHJAX            = NO
  1.1219  
  1.1220 +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
  1.1221 +# Note that the different versions of MathJax have different requirements with
  1.1222 +# regards to the different settings, so it is possible that also other MathJax
  1.1223 +# settings have to be changed when switching between the different MathJax
  1.1224 +# versions.
  1.1225 +# Possible values are: MathJax_2 and MathJax_3.
  1.1226 +# The default value is: MathJax_2.
  1.1227 +# This tag requires that the tag USE_MATHJAX is set to YES.
  1.1228 +
  1.1229 +MATHJAX_VERSION        = MathJax_2
  1.1230 +
  1.1231  # When MathJax is enabled you can set the default output format to be used for
  1.1232 -# the MathJax output. See the MathJax site (see:
  1.1233 -# http://docs.mathjax.org/en/latest/output.html) for more details.
  1.1234 +# the MathJax output. For more details about the output format see MathJax
  1.1235 +# version 2 (see:
  1.1236 +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
  1.1237 +# (see:
  1.1238 +# http://docs.mathjax.org/en/latest/web/components/output.html).
  1.1239  # Possible values are: HTML-CSS (which is slower, but has the best
  1.1240 -# compatibility), NativeMML (i.e. MathML) and SVG.
  1.1241 +# compatibility. This is the name for Mathjax version 2, for MathJax version 3
  1.1242 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported
  1.1243 +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This
  1.1244 +# is the name for Mathjax version 3, for MathJax version 2 this will be
  1.1245 +# translated into HTML-CSS) and SVG.
  1.1246  # The default value is: HTML-CSS.
  1.1247  # This tag requires that the tag USE_MATHJAX is set to YES.
  1.1248  
  1.1249 @@ -1425,22 +1755,29 @@
  1.1250  # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
  1.1251  # Content Delivery Network so you can quickly see the result without installing
  1.1252  # MathJax. However, it is strongly recommended to install a local copy of
  1.1253 -# MathJax from http://www.mathjax.org before deployment.
  1.1254 -# The default value is: http://cdn.mathjax.org/mathjax/latest.
  1.1255 +# MathJax from https://www.mathjax.org before deployment. The default value is:
  1.1256 +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
  1.1257 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
  1.1258  # This tag requires that the tag USE_MATHJAX is set to YES.
  1.1259  
  1.1260  MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
  1.1261  
  1.1262  # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
  1.1263  # extension names that should be enabled during MathJax rendering. For example
  1.1264 +# for MathJax version 2 (see
  1.1265 +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
  1.1266  # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
  1.1267 +# For example for MathJax version 3 (see
  1.1268 +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):
  1.1269 +# MATHJAX_EXTENSIONS = ams
  1.1270  # This tag requires that the tag USE_MATHJAX is set to YES.
  1.1271  
  1.1272  MATHJAX_EXTENSIONS     =
  1.1273  
  1.1274  # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
  1.1275  # of code that will be used on startup of the MathJax code. See the MathJax site
  1.1276 -# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
  1.1277 +# (see:
  1.1278 +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
  1.1279  # example see the documentation.
  1.1280  # This tag requires that the tag USE_MATHJAX is set to YES.
  1.1281  
  1.1282 @@ -1468,7 +1805,7 @@
  1.1283  SEARCHENGINE           = YES
  1.1284  
  1.1285  # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
  1.1286 -# implemented using a web server instead of a web client using Javascript. There
  1.1287 +# implemented using a web server instead of a web client using JavaScript. There
  1.1288  # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
  1.1289  # setting. When disabled, doxygen will generate a PHP script for searching and
  1.1290  # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
  1.1291 @@ -1485,9 +1822,10 @@
  1.1292  # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
  1.1293  # search results.
  1.1294  #
  1.1295 -# Doxygen ships with an example indexer ( doxyindexer) and search engine
  1.1296 +# Doxygen ships with an example indexer (doxyindexer) and search engine
  1.1297  # (doxysearch.cgi) which are based on the open source search engine library
  1.1298 -# Xapian (see: http://xapian.org/).
  1.1299 +# Xapian (see:
  1.1300 +# https://xapian.org/).
  1.1301  #
  1.1302  # See the section "External Indexing and Searching" for details.
  1.1303  # The default value is: NO.
  1.1304 @@ -1498,10 +1836,11 @@
  1.1305  # The SEARCHENGINE_URL should point to a search engine hosted by a web server
  1.1306  # which will return the search results when EXTERNAL_SEARCH is enabled.
  1.1307  #
  1.1308 -# Doxygen ships with an example indexer ( doxyindexer) and search engine
  1.1309 +# Doxygen ships with an example indexer (doxyindexer) and search engine
  1.1310  # (doxysearch.cgi) which are based on the open source search engine library
  1.1311 -# Xapian (see: http://xapian.org/). See the section "External Indexing and
  1.1312 -# Searching" for details.
  1.1313 +# Xapian (see:
  1.1314 +# https://xapian.org/). See the section "External Indexing and Searching" for
  1.1315 +# details.
  1.1316  # This tag requires that the tag SEARCHENGINE is set to YES.
  1.1317  
  1.1318  SEARCHENGINE_URL       =
  1.1319 @@ -1536,7 +1875,7 @@
  1.1320  # Configuration options related to the LaTeX output
  1.1321  #---------------------------------------------------------------------------
  1.1322  
  1.1323 -# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
  1.1324 +# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
  1.1325  # The default value is: YES.
  1.1326  
  1.1327  GENERATE_LATEX         = NO
  1.1328 @@ -1552,22 +1891,36 @@
  1.1329  # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
  1.1330  # invoked.
  1.1331  #
  1.1332 -# Note that when enabling USE_PDFLATEX this option is only used for generating
  1.1333 -# bitmaps for formulas in the HTML output, but not in the Makefile that is
  1.1334 -# written to the output directory.
  1.1335 -# The default file is: latex.
  1.1336 +# Note that when not enabling USE_PDFLATEX the default is latex when enabling
  1.1337 +# USE_PDFLATEX the default is pdflatex and when in the later case latex is
  1.1338 +# chosen this is overwritten by pdflatex. For specific output languages the
  1.1339 +# default can have been set differently, this depends on the implementation of
  1.1340 +# the output language.
  1.1341  # This tag requires that the tag GENERATE_LATEX is set to YES.
  1.1342  
  1.1343  LATEX_CMD_NAME         = latex
  1.1344  
  1.1345  # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
  1.1346  # index for LaTeX.
  1.1347 +# Note: This tag is used in the Makefile / make.bat.
  1.1348 +# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
  1.1349 +# (.tex).
  1.1350  # The default file is: makeindex.
  1.1351  # This tag requires that the tag GENERATE_LATEX is set to YES.
  1.1352  
  1.1353  MAKEINDEX_CMD_NAME     = makeindex
  1.1354  
  1.1355 -# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
  1.1356 +# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
  1.1357 +# generate index for LaTeX. In case there is no backslash (\) as first character
  1.1358 +# it will be automatically added in the LaTeX code.
  1.1359 +# Note: This tag is used in the generated output file (.tex).
  1.1360 +# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
  1.1361 +# The default value is: makeindex.
  1.1362 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1.1363 +
  1.1364 +LATEX_MAKEINDEX_CMD    = makeindex
  1.1365 +
  1.1366 +# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
  1.1367  # documents. This may be useful for small projects and may help to save some
  1.1368  # trees in general.
  1.1369  # The default value is: NO.
  1.1370 @@ -1585,39 +1938,57 @@
  1.1371  PAPER_TYPE             = a4
  1.1372  
  1.1373  # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
  1.1374 -# that should be included in the LaTeX output. To get the times font for
  1.1375 -# instance you can specify
  1.1376 -# EXTRA_PACKAGES=times
  1.1377 +# that should be included in the LaTeX output. The package can be specified just
  1.1378 +# by its name or with the correct syntax as to be used with the LaTeX
  1.1379 +# \usepackage command. To get the times font for instance you can specify :
  1.1380 +# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
  1.1381 +# To use the option intlimits with the amsmath package you can specify:
  1.1382 +# EXTRA_PACKAGES=[intlimits]{amsmath}
  1.1383  # If left blank no extra packages will be included.
  1.1384  # This tag requires that the tag GENERATE_LATEX is set to YES.
  1.1385  
  1.1386  EXTRA_PACKAGES         =
  1.1387  
  1.1388 -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
  1.1389 -# generated LaTeX document. The header should contain everything until the first
  1.1390 -# chapter. If it is left blank doxygen will generate a standard header. See
  1.1391 -# section "Doxygen usage" for information on how to let doxygen write the
  1.1392 -# default header to a separate file.
  1.1393 +# The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
  1.1394 +# the generated LaTeX document. The header should contain everything until the
  1.1395 +# first chapter. If it is left blank doxygen will generate a standard header. It
  1.1396 +# is highly recommended to start with a default header using
  1.1397 +# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
  1.1398 +# and then modify the file new_header.tex. See also section "Doxygen usage" for
  1.1399 +# information on how to generate the default header that doxygen normally uses.
  1.1400  #
  1.1401 -# Note: Only use a user-defined header if you know what you are doing! The
  1.1402 -# following commands have a special meaning inside the header: $title,
  1.1403 -# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
  1.1404 -# replace them by respectively the title of the page, the current date and time,
  1.1405 -# only the current date, the version number of doxygen, the project name (see
  1.1406 -# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
  1.1407 +# Note: Only use a user-defined header if you know what you are doing!
  1.1408 +# Note: The header is subject to change so you typically have to regenerate the
  1.1409 +# default header when upgrading to a newer version of doxygen. The following
  1.1410 +# commands have a special meaning inside the header (and footer): For a
  1.1411 +# description of the possible markers and block names see the documentation.
  1.1412  # This tag requires that the tag GENERATE_LATEX is set to YES.
  1.1413  
  1.1414  LATEX_HEADER           =
  1.1415  
  1.1416 -# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
  1.1417 -# generated LaTeX document. The footer should contain everything after the last
  1.1418 -# chapter. If it is left blank doxygen will generate a standard footer.
  1.1419 -#
  1.1420 -# Note: Only use a user-defined footer if you know what you are doing!
  1.1421 +# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
  1.1422 +# the generated LaTeX document. The footer should contain everything after the
  1.1423 +# last chapter. If it is left blank doxygen will generate a standard footer. See
  1.1424 +# LATEX_HEADER for more information on how to generate a default footer and what
  1.1425 +# special commands can be used inside the footer. See also section "Doxygen
  1.1426 +# usage" for information on how to generate the default footer that doxygen
  1.1427 +# normally uses. Note: Only use a user-defined footer if you know what you are
  1.1428 +# doing!
  1.1429  # This tag requires that the tag GENERATE_LATEX is set to YES.
  1.1430  
  1.1431  LATEX_FOOTER           =
  1.1432  
  1.1433 +# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
  1.1434 +# LaTeX style sheets that are included after the standard style sheets created
  1.1435 +# by doxygen. Using this option one can overrule certain style aspects. Doxygen
  1.1436 +# will copy the style sheet files to the output directory.
  1.1437 +# Note: The order of the extra style sheet files is of importance (e.g. the last
  1.1438 +# style sheet in the list overrules the setting of the previous ones in the
  1.1439 +# list).
  1.1440 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1.1441 +
  1.1442 +LATEX_EXTRA_STYLESHEET =
  1.1443 +
  1.1444  # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
  1.1445  # other source files which should be copied to the LATEX_OUTPUT output
  1.1446  # directory. Note that the files will be copied as-is; there are no commands or
  1.1447 @@ -1635,9 +2006,11 @@
  1.1448  
  1.1449  PDF_HYPERLINKS         = YES
  1.1450  
  1.1451 -# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
  1.1452 -# the PDF file directly from the LaTeX files. Set this option to YES to get a
  1.1453 -# higher quality PDF documentation.
  1.1454 +# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
  1.1455 +# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
  1.1456 +# files. Set this option to YES, to get a higher quality PDF documentation.
  1.1457 +#
  1.1458 +# See also section LATEX_CMD_NAME for selecting the engine.
  1.1459  # The default value is: YES.
  1.1460  # This tag requires that the tag GENERATE_LATEX is set to YES.
  1.1461  
  1.1462 @@ -1645,8 +2018,7 @@
  1.1463  
  1.1464  # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
  1.1465  # command to the generated LaTeX files. This will instruct LaTeX to keep running
  1.1466 -# if errors occur, instead of asking the user for help. This option is also used
  1.1467 -# when generating formulas in HTML.
  1.1468 +# if errors occur, instead of asking the user for help.
  1.1469  # The default value is: NO.
  1.1470  # This tag requires that the tag GENERATE_LATEX is set to YES.
  1.1471  
  1.1472 @@ -1661,17 +2033,33 @@
  1.1473  
  1.1474  # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
  1.1475  # bibliography, e.g. plainnat, or ieeetr. See
  1.1476 -# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
  1.1477 +# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
  1.1478  # The default value is: plain.
  1.1479  # This tag requires that the tag GENERATE_LATEX is set to YES.
  1.1480  
  1.1481  LATEX_BIB_STYLE        = plain
  1.1482  
  1.1483 +# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
  1.1484 +# page will contain the date and time when the page was generated. Setting this
  1.1485 +# to NO can help when comparing the output of multiple runs.
  1.1486 +# The default value is: NO.
  1.1487 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1.1488 +
  1.1489 +LATEX_TIMESTAMP        = NO
  1.1490 +
  1.1491 +# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
  1.1492 +# path from which the emoji images will be read. If a relative path is entered,
  1.1493 +# it will be relative to the LATEX_OUTPUT directory. If left blank the
  1.1494 +# LATEX_OUTPUT directory will be used.
  1.1495 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1.1496 +
  1.1497 +LATEX_EMOJI_DIRECTORY  =
  1.1498 +
  1.1499  #---------------------------------------------------------------------------
  1.1500  # Configuration options related to the RTF output
  1.1501  #---------------------------------------------------------------------------
  1.1502  
  1.1503 -# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
  1.1504 +# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
  1.1505  # RTF output is optimized for Word 97 and may not look too pretty with other RTF
  1.1506  # readers/editors.
  1.1507  # The default value is: NO.
  1.1508 @@ -1686,7 +2074,7 @@
  1.1509  
  1.1510  RTF_OUTPUT             = rtf
  1.1511  
  1.1512 -# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
  1.1513 +# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
  1.1514  # documents. This may be useful for small projects and may help to save some
  1.1515  # trees in general.
  1.1516  # The default value is: NO.
  1.1517 @@ -1706,9 +2094,9 @@
  1.1518  
  1.1519  RTF_HYPERLINKS         = NO
  1.1520  
  1.1521 -# Load stylesheet definitions from file. Syntax is similar to doxygen's config
  1.1522 -# file, i.e. a series of assignments. You only have to provide replacements,
  1.1523 -# missing definitions are set to their default value.
  1.1524 +# Load stylesheet definitions from file. Syntax is similar to doxygen's
  1.1525 +# configuration file, i.e. a series of assignments. You only have to provide
  1.1526 +# replacements, missing definitions are set to their default value.
  1.1527  #
  1.1528  # See also section "Doxygen usage" for information on how to generate the
  1.1529  # default style sheet that doxygen normally uses.
  1.1530 @@ -1717,8 +2105,8 @@
  1.1531  RTF_STYLESHEET_FILE    =
  1.1532  
  1.1533  # Set optional variables used in the generation of an RTF document. Syntax is
  1.1534 -# similar to doxygen's config file. A template extensions file can be generated
  1.1535 -# using doxygen -e rtf extensionFile.
  1.1536 +# similar to doxygen's configuration file. A template extensions file can be
  1.1537 +# generated using doxygen -e rtf extensionFile.
  1.1538  # This tag requires that the tag GENERATE_RTF is set to YES.
  1.1539  
  1.1540  RTF_EXTENSIONS_FILE    =
  1.1541 @@ -1727,7 +2115,7 @@
  1.1542  # Configuration options related to the man page output
  1.1543  #---------------------------------------------------------------------------
  1.1544  
  1.1545 -# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
  1.1546 +# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
  1.1547  # classes and files.
  1.1548  # The default value is: NO.
  1.1549  
  1.1550 @@ -1771,7 +2159,7 @@
  1.1551  # Configuration options related to the XML output
  1.1552  #---------------------------------------------------------------------------
  1.1553  
  1.1554 -# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
  1.1555 +# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
  1.1556  # captures the structure of the code including all documentation.
  1.1557  # The default value is: NO.
  1.1558  
  1.1559 @@ -1785,7 +2173,7 @@
  1.1560  
  1.1561  XML_OUTPUT             = xml
  1.1562  
  1.1563 -# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
  1.1564 +# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
  1.1565  # listings (including syntax highlighting and cross-referencing information) to
  1.1566  # the XML output. Note that enabling this will significantly increase the size
  1.1567  # of the XML output.
  1.1568 @@ -1794,11 +2182,18 @@
  1.1569  
  1.1570  XML_PROGRAMLISTING     = YES
  1.1571  
  1.1572 +# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
  1.1573 +# namespace members in file scope as well, matching the HTML output.
  1.1574 +# The default value is: NO.
  1.1575 +# This tag requires that the tag GENERATE_XML is set to YES.
  1.1576 +
  1.1577 +XML_NS_MEMB_FILE_SCOPE = NO
  1.1578 +
  1.1579  #---------------------------------------------------------------------------
  1.1580  # Configuration options related to the DOCBOOK output
  1.1581  #---------------------------------------------------------------------------
  1.1582  
  1.1583 -# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
  1.1584 +# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
  1.1585  # that can be used to generate PDF.
  1.1586  # The default value is: NO.
  1.1587  
  1.1588 @@ -1816,10 +2211,10 @@
  1.1589  # Configuration options for the AutoGen Definitions output
  1.1590  #---------------------------------------------------------------------------
  1.1591  
  1.1592 -# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
  1.1593 -# Definitions (see http://autogen.sf.net) file that captures the structure of
  1.1594 -# the code including all documentation. Note that this feature is still
  1.1595 -# experimental and incomplete at the moment.
  1.1596 +# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
  1.1597 +# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
  1.1598 +# the structure of the code including all documentation. Note that this feature
  1.1599 +# is still experimental and incomplete at the moment.
  1.1600  # The default value is: NO.
  1.1601  
  1.1602  GENERATE_AUTOGEN_DEF   = NO
  1.1603 @@ -1828,7 +2223,7 @@
  1.1604  # Configuration options related to the Perl module output
  1.1605  #---------------------------------------------------------------------------
  1.1606  
  1.1607 -# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
  1.1608 +# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
  1.1609  # file that captures the structure of the code including all documentation.
  1.1610  #
  1.1611  # Note that this feature is still experimental and incomplete at the moment.
  1.1612 @@ -1836,7 +2231,7 @@
  1.1613  
  1.1614  GENERATE_PERLMOD       = NO
  1.1615  
  1.1616 -# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
  1.1617 +# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
  1.1618  # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
  1.1619  # output from the Perl module output.
  1.1620  # The default value is: NO.
  1.1621 @@ -1844,9 +2239,9 @@
  1.1622  
  1.1623  PERLMOD_LATEX          = NO
  1.1624  
  1.1625 -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
  1.1626 +# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
  1.1627  # formatted so it can be parsed by a human reader. This is useful if you want to
  1.1628 -# understand what is going on. On the other hand, if this tag is set to NO the
  1.1629 +# understand what is going on. On the other hand, if this tag is set to NO, the
  1.1630  # size of the Perl module output will be much smaller and Perl will parse it
  1.1631  # just the same.
  1.1632  # The default value is: YES.
  1.1633 @@ -1866,14 +2261,14 @@
  1.1634  # Configuration options related to the preprocessor
  1.1635  #---------------------------------------------------------------------------
  1.1636  
  1.1637 -# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
  1.1638 +# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
  1.1639  # C-preprocessor directives found in the sources and include files.
  1.1640  # The default value is: YES.
  1.1641  
  1.1642  ENABLE_PREPROCESSING   = YES
  1.1643  
  1.1644 -# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
  1.1645 -# in the source code. If set to NO only conditional compilation will be
  1.1646 +# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
  1.1647 +# in the source code. If set to NO, only conditional compilation will be
  1.1648  # performed. Macro expansion can be done in a controlled way by setting
  1.1649  # EXPAND_ONLY_PREDEF to YES.
  1.1650  # The default value is: NO.
  1.1651 @@ -1889,7 +2284,7 @@
  1.1652  
  1.1653  EXPAND_ONLY_PREDEF     = YES
  1.1654  
  1.1655 -# If the SEARCH_INCLUDES tag is set to YES the includes files in the
  1.1656 +# If the SEARCH_INCLUDES tag is set to YES, the include files in the
  1.1657  # INCLUDE_PATH will be searched if a #include is found.
  1.1658  # The default value is: YES.
  1.1659  # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1.1660 @@ -1898,7 +2293,8 @@
  1.1661  
  1.1662  # The INCLUDE_PATH tag can be used to specify one or more directories that
  1.1663  # contain include files that are not input files but should be processed by the
  1.1664 -# preprocessor.
  1.1665 +# preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of
  1.1666 +# RECURSIVE has no effect here.
  1.1667  # This tag requires that the tag SEARCH_INCLUDES is set to YES.
  1.1668  
  1.1669  INCLUDE_PATH           =
  1.1670 @@ -1965,20 +2361,21 @@
  1.1671  
  1.1672  GENERATE_TAGFILE       =
  1.1673  
  1.1674 -# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
  1.1675 -# class index. If set to NO only the inherited external classes will be listed.
  1.1676 +# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
  1.1677 +# the class index. If set to NO, only the inherited external classes will be
  1.1678 +# listed.
  1.1679  # The default value is: NO.
  1.1680  
  1.1681  ALLEXTERNALS           = NO
  1.1682  
  1.1683 -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
  1.1684 -# the modules index. If set to NO, only the current project's groups will be
  1.1685 +# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
  1.1686 +# in the modules index. If set to NO, only the current project's groups will be
  1.1687  # listed.
  1.1688  # The default value is: YES.
  1.1689  
  1.1690  EXTERNAL_GROUPS        = YES
  1.1691  
  1.1692 -# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
  1.1693 +# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
  1.1694  # the related pages index. If set to NO, only the current project's pages will
  1.1695  # be listed.
  1.1696  # The default value is: YES.
  1.1697 @@ -1996,7 +2393,7 @@
  1.1698  
  1.1699  DIA_PATH               =
  1.1700  
  1.1701 -# If set to YES, the inheritance and collaboration graphs will hide inheritance
  1.1702 +# If set to YES the inheritance and collaboration graphs will hide inheritance
  1.1703  # and usage relations if the target is undocumented or is not a class.
  1.1704  # The default value is: YES.
  1.1705  
  1.1706 @@ -2007,7 +2404,7 @@
  1.1707  # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
  1.1708  # Bell Labs. The other options in this section have no effect if this option is
  1.1709  # set to NO
  1.1710 -# The default value is: YES.
  1.1711 +# The default value is: NO.
  1.1712  
  1.1713  HAVE_DOT               = NO
  1.1714  
  1.1715 @@ -2021,35 +2418,50 @@
  1.1716  
  1.1717  DOT_NUM_THREADS        = 0
  1.1718  
  1.1719 -# When you want a differently looking font n the dot files that doxygen
  1.1720 -# generates you can specify the font name using DOT_FONTNAME. You need to make
  1.1721 -# sure dot is able to find the font, which can be done by putting it in a
  1.1722 -# standard location or by setting the DOTFONTPATH environment variable or by
  1.1723 -# setting DOT_FONTPATH to the directory containing the font.
  1.1724 -# The default value is: Helvetica.
  1.1725 +# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of
  1.1726 +# subgraphs. When you want a differently looking font in the dot files that
  1.1727 +# doxygen generates you can specify fontname, fontcolor and fontsize attributes.
  1.1728 +# For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node,
  1.1729 +# Edge and Graph Attributes specification</a> You need to make sure dot is able
  1.1730 +# to find the font, which can be done by putting it in a standard location or by
  1.1731 +# setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
  1.1732 +# directory containing the font. Default graphviz fontsize is 14.
  1.1733 +# The default value is: fontname=Helvetica,fontsize=10.
  1.1734  # This tag requires that the tag HAVE_DOT is set to YES.
  1.1735  
  1.1736 -DOT_FONTNAME           = Helvetica
  1.1737 -
  1.1738 -# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
  1.1739 -# dot graphs.
  1.1740 -# Minimum value: 4, maximum value: 24, default value: 10.
  1.1741 +DOT_COMMON_ATTR        = "fontname=Helvetica,fontsize=10"
  1.1742 +
  1.1743 +# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can
  1.1744 +# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a
  1.1745 +# href=https://graphviz.org/doc/info/arrows.html>Complete documentation about
  1.1746 +# arrows shapes.</a>
  1.1747 +# The default value is: labelfontname=Helvetica,labelfontsize=10.
  1.1748  # This tag requires that the tag HAVE_DOT is set to YES.
  1.1749  
  1.1750 -DOT_FONTSIZE           = 10
  1.1751 -
  1.1752 -# By default doxygen will tell dot to use the default font as specified with
  1.1753 -# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
  1.1754 -# the path where dot can find it using this tag.
  1.1755 +DOT_EDGE_ATTR          = "labelfontname=Helvetica,labelfontsize=10"
  1.1756 +
  1.1757 +# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes
  1.1758 +# around nodes set 'shape=plain' or 'shape=plaintext' <a
  1.1759 +# href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a>
  1.1760 +# The default value is: shape=box,height=0.2,width=0.4.
  1.1761  # This tag requires that the tag HAVE_DOT is set to YES.
  1.1762  
  1.1763 +DOT_NODE_ATTR          = "shape=box,height=0.2,width=0.4"
  1.1764 +
  1.1765 +# You can set the path where dot can find font specified with fontname in
  1.1766 +# DOT_COMMON_ATTR and others dot attributes.
  1.1767 +# This tag requires that the tag HAVE_DOT is set to YES.
  1.1768 +
  1.1769  DOT_FONTPATH           =
  1.1770  
  1.1771 -# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
  1.1772 -# each documented class showing the direct and indirect inheritance relations.
  1.1773 -# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
  1.1774 +# If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a
  1.1775 +# graph for each documented class showing the direct and indirect inheritance
  1.1776 +# relations. In case HAVE_DOT is set as well dot will be used to draw the graph,
  1.1777 +# otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set
  1.1778 +# to TEXT the direct and indirect inheritance relations will be shown as texts /
  1.1779 +# links.
  1.1780 +# Possible values are: NO, YES, TEXT and GRAPH.
  1.1781  # The default value is: YES.
  1.1782 -# This tag requires that the tag HAVE_DOT is set to YES.
  1.1783  
  1.1784  CLASS_GRAPH            = YES
  1.1785  
  1.1786 @@ -2063,13 +2475,14 @@
  1.1787  COLLABORATION_GRAPH    = YES
  1.1788  
  1.1789  # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
  1.1790 -# groups, showing the direct groups dependencies.
  1.1791 +# groups, showing the direct groups dependencies. See also the chapter Grouping
  1.1792 +# in the manual.
  1.1793  # The default value is: YES.
  1.1794  # This tag requires that the tag HAVE_DOT is set to YES.
  1.1795  
  1.1796  GROUP_GRAPHS           = YES
  1.1797  
  1.1798 -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
  1.1799 +# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
  1.1800  # collaboration diagrams in a style similar to the OMG's Unified Modeling
  1.1801  # Language.
  1.1802  # The default value is: NO.
  1.1803 @@ -2086,9 +2499,31 @@
  1.1804  # but if the number exceeds 15, the total amount of fields shown is limited to
  1.1805  # 10.
  1.1806  # Minimum value: 0, maximum value: 100, default value: 10.
  1.1807 +# This tag requires that the tag UML_LOOK is set to YES.
  1.1808 +
  1.1809 +UML_LIMIT_NUM_FIELDS   = 10
  1.1810 +
  1.1811 +# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
  1.1812 +# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
  1.1813 +# tag is set to YES, doxygen will add type and arguments for attributes and
  1.1814 +# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
  1.1815 +# will not generate fields with class member information in the UML graphs. The
  1.1816 +# class diagrams will look similar to the default class diagrams but using UML
  1.1817 +# notation for the relationships.
  1.1818 +# Possible values are: NO, YES and NONE.
  1.1819 +# The default value is: NO.
  1.1820 +# This tag requires that the tag UML_LOOK is set to YES.
  1.1821 +
  1.1822 +DOT_UML_DETAILS        = NO
  1.1823 +
  1.1824 +# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
  1.1825 +# to display on a single line. If the actual line length exceeds this threshold
  1.1826 +# significantly it will wrapped across multiple lines. Some heuristics are apply
  1.1827 +# to avoid ugly line breaks.
  1.1828 +# Minimum value: 0, maximum value: 1000, default value: 17.
  1.1829  # This tag requires that the tag HAVE_DOT is set to YES.
  1.1830  
  1.1831 -UML_LIMIT_NUM_FIELDS   = 10
  1.1832 +DOT_WRAP_THRESHOLD     = 17
  1.1833  
  1.1834  # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
  1.1835  # collaboration graphs will show the relations between templates and their
  1.1836 @@ -2121,7 +2556,8 @@
  1.1837  #
  1.1838  # Note that enabling this option will significantly increase the time of a run.
  1.1839  # So in most cases it will be better to enable call graphs for selected
  1.1840 -# functions only using the \callgraph command.
  1.1841 +# functions only using the \callgraph command. Disabling a call graph can be
  1.1842 +# accomplished by means of the command \hidecallgraph.
  1.1843  # The default value is: NO.
  1.1844  # This tag requires that the tag HAVE_DOT is set to YES.
  1.1845  
  1.1846 @@ -2132,7 +2568,8 @@
  1.1847  #
  1.1848  # Note that enabling this option will significantly increase the time of a run.
  1.1849  # So in most cases it will be better to enable caller graphs for selected
  1.1850 -# functions only using the \callergraph command.
  1.1851 +# functions only using the \callergraph command. Disabling a caller graph can be
  1.1852 +# accomplished by means of the command \hidecallergraph.
  1.1853  # The default value is: NO.
  1.1854  # This tag requires that the tag HAVE_DOT is set to YES.
  1.1855  
  1.1856 @@ -2154,14 +2591,23 @@
  1.1857  
  1.1858  DIRECTORY_GRAPH        = YES
  1.1859  
  1.1860 +# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels
  1.1861 +# of child directories generated in directory dependency graphs by dot.
  1.1862 +# Minimum value: 1, maximum value: 25, default value: 1.
  1.1863 +# This tag requires that the tag DIRECTORY_GRAPH is set to YES.
  1.1864 +
  1.1865 +DIR_GRAPH_MAX_DEPTH    = 1
  1.1866 +
  1.1867  # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
  1.1868 -# generated by dot.
  1.1869 +# generated by dot. For an explanation of the image formats see the section
  1.1870 +# output formats in the documentation of the dot tool (Graphviz (see:
  1.1871 +# http://www.graphviz.org/)).
  1.1872  # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
  1.1873  # to make the SVG files visible in IE 9+ (other browsers do not have this
  1.1874  # requirement).
  1.1875 -# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
  1.1876 -# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
  1.1877 -# gif:cairo:gd, gif:gd, gif:gd:gd and svg.
  1.1878 +# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
  1.1879 +# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
  1.1880 +# png:gdiplus:gdiplus.
  1.1881  # The default value is: png.
  1.1882  # This tag requires that the tag HAVE_DOT is set to YES.
  1.1883  
  1.1884 @@ -2204,6 +2650,24 @@
  1.1885  
  1.1886  DIAFILE_DIRS           =
  1.1887  
  1.1888 +# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
  1.1889 +# path where java can find the plantuml.jar file or to the filename of jar file
  1.1890 +# to be used. If left blank, it is assumed PlantUML is not used or called during
  1.1891 +# a preprocessing step. Doxygen will generate a warning when it encounters a
  1.1892 +# \startuml command in this case and will not generate output for the diagram.
  1.1893 +
  1.1894 +PLANTUML_JAR_PATH      =
  1.1895 +
  1.1896 +# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
  1.1897 +# configuration file for plantuml.
  1.1898 +
  1.1899 +PLANTUML_CFG_FILE      =
  1.1900 +
  1.1901 +# When using plantuml, the specified paths are searched for files specified by
  1.1902 +# the !include statement in a plantuml block.
  1.1903 +
  1.1904 +PLANTUML_INCLUDE_PATH  =
  1.1905 +
  1.1906  # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
  1.1907  # that will be shown in the graph. If the number of nodes in a graph becomes
  1.1908  # larger than this value, doxygen will truncate the graph, which is visualized
  1.1909 @@ -2228,19 +2692,7 @@
  1.1910  
  1.1911  MAX_DOT_GRAPH_DEPTH    = 0
  1.1912  
  1.1913 -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
  1.1914 -# background. This is disabled by default, because dot on Windows does not seem
  1.1915 -# to support this out of the box.
  1.1916 -#
  1.1917 -# Warning: Depending on the platform used, enabling this option may lead to
  1.1918 -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
  1.1919 -# read).
  1.1920 -# The default value is: NO.
  1.1921 -# This tag requires that the tag HAVE_DOT is set to YES.
  1.1922 -
  1.1923 -DOT_TRANSPARENT        = NO
  1.1924 -
  1.1925 -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
  1.1926 +# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
  1.1927  # files in one run (i.e. multiple -o and -T options on the command line). This
  1.1928  # makes dot run faster, but since only newer versions of dot (>1.8.10) support
  1.1929  # this, this feature is disabled by default.
  1.1930 @@ -2252,14 +2704,18 @@
  1.1931  # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
  1.1932  # explaining the meaning of the various boxes and arrows in the dot generated
  1.1933  # graphs.
  1.1934 +# Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal
  1.1935 +# graphical representation for inheritance and collaboration diagrams is used.
  1.1936  # The default value is: YES.
  1.1937  # This tag requires that the tag HAVE_DOT is set to YES.
  1.1938  
  1.1939  GENERATE_LEGEND        = YES
  1.1940  
  1.1941 -# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
  1.1942 +# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
  1.1943  # files that are used to generate the various graphs.
  1.1944 +#
  1.1945 +# Note: This setting is not only used for dot files but also for msc temporary
  1.1946 +# files.
  1.1947  # The default value is: YES.
  1.1948 -# This tag requires that the tag HAVE_DOT is set to YES.
  1.1949  
  1.1950  DOT_CLEANUP            = YES

     2.1 --- a/cmake_infile.doxygen	Sun May 21 16:22:09 2023 +0200
     2.2 +++ b/cmake_infile.doxygen	Tue Jun 20 18:26:35 2023 +0200
     2.3 @@ -1,4 +1,4 @@
     2.4 -# Doxyfile 1.8.7
     2.5 +# Doxyfile 1.9.6
     2.6  
     2.7  # This file describes the settings to be used by the documentation system
     2.8  # doxygen (www.doxygen.org) for a project.
     2.9 @@ -12,16 +12,26 @@
    2.10  # For lists, items can also be appended using:
    2.11  # TAG += value [value, ...]
    2.12  # Values that contain spaces should be placed between quotes (\" \").
    2.13 +#
    2.14 +# Note:
    2.15 +#
    2.16 +# Use doxygen to compare the used configuration file with the template
    2.17 +# configuration file:
    2.18 +# doxygen -x [configFile]
    2.19 +# Use doxygen to compare the used configuration file with the template
    2.20 +# configuration file without replacing the environment variables or CMake type
    2.21 +# replacement variables:
    2.22 +# doxygen -x_noenv [configFile]
    2.23  
    2.24  #---------------------------------------------------------------------------
    2.25  # Project related configuration options
    2.26  #---------------------------------------------------------------------------
    2.27  
    2.28 -# This tag specifies the encoding used for all characters in the config file
    2.29 -# that follow. The default is UTF-8 which is also the encoding used for all text
    2.30 -# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
    2.31 -# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
    2.32 -# for the list of possible encodings.
    2.33 +# This tag specifies the encoding used for all characters in the configuration
    2.34 +# file that follow. The default is UTF-8 which is also the encoding used for all
    2.35 +# text before the first occurrence of this tag. Doxygen uses libiconv (or the
    2.36 +# iconv built into libc) for the transcoding. See
    2.37 +# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
    2.38  # The default value is: UTF-8.
    2.39  
    2.40  DOXYFILE_ENCODING      = UTF-8
    2.41 @@ -32,7 +42,7 @@
    2.42  # title of most generated pages and in a few other places.
    2.43  # The default value is: My Project.
    2.44  
    2.45 -PROJECT_NAME           = "ucx"
    2.46 +PROJECT_NAME           = ucx
    2.47  
    2.48  # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
    2.49  # could be handy for archiving the generated documentation or if some version
    2.50 @@ -46,10 +56,10 @@
    2.51  
    2.52  PROJECT_BRIEF          = "UAP Common Extensions"
    2.53  
    2.54 -# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
    2.55 -# the documentation. The maximum height of the logo should not exceed 55 pixels
    2.56 -# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
    2.57 -# to the output directory.
    2.58 +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
    2.59 +# in the documentation. The maximum height of the logo should not exceed 55
    2.60 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
    2.61 +# the logo to the output directory.
    2.62  
    2.63  PROJECT_LOGO           = @DOXY_PROJECT_LOGO@
    2.64  
    2.65 @@ -60,16 +70,28 @@
    2.66  
    2.67  OUTPUT_DIRECTORY       = @DOXY_OUTPUT_DIRECTORY@
    2.68  
    2.69 -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
    2.70 -# directories (in 2 levels) under the output directory of each output format and
    2.71 -# will distribute the generated files over these directories. Enabling this
    2.72 +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
    2.73 +# sub-directories (in 2 levels) under the output directory of each output format
    2.74 +# and will distribute the generated files over these directories. Enabling this
    2.75  # option can be useful when feeding doxygen a huge amount of source files, where
    2.76  # putting all generated files in the same directory would otherwise causes
    2.77 -# performance problems for the file system.
    2.78 +# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to
    2.79 +# control the number of sub-directories.
    2.80  # The default value is: NO.
    2.81  
    2.82  CREATE_SUBDIRS         = NO
    2.83  
    2.84 +# Controls the number of sub-directories that will be created when
    2.85 +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every
    2.86 +# level increment doubles the number of directories, resulting in 4096
    2.87 +# directories at level 8 which is the default and also the maximum value. The
    2.88 +# sub-directories are organized in 2 levels, the first level always has a fixed
    2.89 +# number of 16 directories.
    2.90 +# Minimum value: 0, maximum value: 8, default value: 8.
    2.91 +# This tag requires that the tag CREATE_SUBDIRS is set to YES.
    2.92 +
    2.93 +CREATE_SUBDIRS_LEVEL   = 8
    2.94 +
    2.95  # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
    2.96  # characters to appear in the names of generated files. If set to NO, non-ASCII
    2.97  # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
    2.98 @@ -81,26 +103,26 @@
    2.99  # The OUTPUT_LANGUAGE tag is used to specify the language in which all
   2.100  # documentation generated by doxygen is written. Doxygen will use this
   2.101  # information to generate all constant output in the proper language.
   2.102 -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
   2.103 -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
   2.104 -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
   2.105 -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
   2.106 -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
   2.107 -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
   2.108 -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
   2.109 -# Ukrainian and Vietnamese.
   2.110 +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian,
   2.111 +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English
   2.112 +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek,
   2.113 +# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with
   2.114 +# English messages), Korean, Korean-en (Korean with English messages), Latvian,
   2.115 +# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese,
   2.116 +# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish,
   2.117 +# Swedish, Turkish, Ukrainian and Vietnamese.
   2.118  # The default value is: English.
   2.119  
   2.120  OUTPUT_LANGUAGE        = English
   2.121  
   2.122 -# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
   2.123 +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
   2.124  # descriptions after the members that are listed in the file and class
   2.125  # documentation (similar to Javadoc). Set to NO to disable this.
   2.126  # The default value is: YES.
   2.127  
   2.128  BRIEF_MEMBER_DESC      = YES
   2.129  
   2.130 -# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
   2.131 +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
   2.132  # description of a member or function before the detailed description
   2.133  #
   2.134  # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
   2.135 @@ -135,7 +157,7 @@
   2.136  
   2.137  INLINE_INHERITED_MEMB  = NO
   2.138  
   2.139 -# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
   2.140 +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
   2.141  # before files name in the file list and in the header files. If set to NO the
   2.142  # shortest path that makes the file name unique will be used
   2.143  # The default value is: YES.
   2.144 @@ -179,6 +201,16 @@
   2.145  
   2.146  JAVADOC_AUTOBRIEF      = YES
   2.147  
   2.148 +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
   2.149 +# such as
   2.150 +# /***************
   2.151 +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
   2.152 +# Javadoc-style will behave just like regular comments and it will not be
   2.153 +# interpreted by doxygen.
   2.154 +# The default value is: NO.
   2.155 +
   2.156 +JAVADOC_BANNER         = NO
   2.157 +
   2.158  # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
   2.159  # line (until the first dot) of a Qt-style comment as the brief description. If
   2.160  # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
   2.161 @@ -199,15 +231,23 @@
   2.162  
   2.163  MULTILINE_CPP_IS_BRIEF = NO
   2.164  
   2.165 +# By default Python docstrings are displayed as preformatted text and doxygen's
   2.166 +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
   2.167 +# doxygen's special commands can be used and the contents of the docstring
   2.168 +# documentation blocks is shown as doxygen documentation.
   2.169 +# The default value is: YES.
   2.170 +
   2.171 +PYTHON_DOCSTRING       = YES
   2.172 +
   2.173  # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
   2.174  # documentation from any documented member that it re-implements.
   2.175  # The default value is: YES.
   2.176  
   2.177  INHERIT_DOCS           = YES
   2.178  
   2.179 -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
   2.180 -# new page for each member. If set to NO, the documentation of a member will be
   2.181 -# part of the file/class/namespace that contains it.
   2.182 +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
   2.183 +# page for each member. If set to NO, the documentation of a member will be part
   2.184 +# of the file/class/namespace that contains it.
   2.185  # The default value is: NO.
   2.186  
   2.187  SEPARATE_MEMBER_PAGES  = NO
   2.188 @@ -222,11 +262,16 @@
   2.189  # the documentation. An alias has the form:
   2.190  # name=value
   2.191  # For example adding
   2.192 -# "sideeffect=@par Side Effects:\n"
   2.193 +# "sideeffect=@par Side Effects:^^"
   2.194  # will allow you to put the command \sideeffect (or @sideeffect) in the
   2.195  # documentation, which will result in a user-defined paragraph with heading
   2.196 -# "Side Effects:". You can put \n's in the value part of an alias to insert
   2.197 -# newlines.
   2.198 +# "Side Effects:". Note that you cannot put \n's in the value part of an alias
   2.199 +# to insert newlines (in the resulting output). You can put ^^ in the value part
   2.200 +# of an alias to insert a newline as if a physical newline was in the original
   2.201 +# file. When you need a literal { or } or , in the value part of an alias you
   2.202 +# have to escape them by means of a backslash (\), this can lead to conflicts
   2.203 +# with the commands \{ and \} for these it is advised to use the version @{ and
   2.204 +# @} or use a double escape (\\{ and \\})
   2.205  
   2.206  ALIASES                =
   2.207  
   2.208 @@ -258,28 +303,40 @@
   2.209  
   2.210  OPTIMIZE_OUTPUT_VHDL   = NO
   2.211  
   2.212 +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
   2.213 +# sources only. Doxygen will then generate output that is more tailored for that
   2.214 +# language. For instance, namespaces will be presented as modules, types will be
   2.215 +# separated into more groups, etc.
   2.216 +# The default value is: NO.
   2.217 +
   2.218 +OPTIMIZE_OUTPUT_SLICE  = NO
   2.219 +
   2.220  # Doxygen selects the parser to use depending on the extension of the files it
   2.221  # parses. With this tag you can assign which parser to use for a given
   2.222  # extension. Doxygen has a built-in mapping, but you can override or extend it
   2.223  # using this tag. The format is ext=language, where ext is a file extension, and
   2.224 -# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
   2.225 -# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
   2.226 -# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
   2.227 -# Fortran. In the later case the parser tries to guess whether the code is fixed
   2.228 -# or free formatted code, this is the default for Fortran type files), VHDL. For
   2.229 -# instance to make doxygen treat .inc files as Fortran files (default is PHP),
   2.230 -# and .f files as C (default is Fortran), use: inc=Fortran f=C.
   2.231 +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
   2.232 +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,
   2.233 +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
   2.234 +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
   2.235 +# tries to guess whether the code is fixed or free formatted code, this is the
   2.236 +# default for Fortran type files). For instance to make doxygen treat .inc files
   2.237 +# as Fortran files (default is PHP), and .f files as C (default is Fortran),
   2.238 +# use: inc=Fortran f=C.
   2.239  #
   2.240 -# Note For files without extension you can use no_extension as a placeholder.
   2.241 +# Note: For files without extension you can use no_extension as a placeholder.
   2.242  #
   2.243  # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
   2.244 -# the files are not read by doxygen.
   2.245 +# the files are not read by doxygen. When specifying no_extension you should add
   2.246 +# * to the FILE_PATTERNS.
   2.247 +#
   2.248 +# Note see also the list of default file extension mappings.
   2.249  
   2.250  EXTENSION_MAPPING      =
   2.251  
   2.252  # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
   2.253  # according to the Markdown format, which allows for more readable
   2.254 -# documentation. See http://daringfireball.net/projects/markdown/ for details.
   2.255 +# documentation. See https://daringfireball.net/projects/markdown/ for details.
   2.256  # The output of markdown processing is further processed by doxygen, so you can
   2.257  # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
   2.258  # case of backward compatibilities issues.
   2.259 @@ -287,10 +344,19 @@
   2.260  
   2.261  MARKDOWN_SUPPORT       = YES
   2.262  
   2.263 +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
   2.264 +# to that level are automatically included in the table of contents, even if
   2.265 +# they do not have an id attribute.
   2.266 +# Note: This feature currently applies only to Markdown headings.
   2.267 +# Minimum value: 0, maximum value: 99, default value: 5.
   2.268 +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
   2.269 +
   2.270 +TOC_INCLUDE_HEADINGS   = 5
   2.271 +
   2.272  # When enabled doxygen tries to link words that correspond to documented
   2.273  # classes, or namespaces to their corresponding documentation. Such a link can
   2.274 -# be prevented in individual cases by by putting a % sign in front of the word
   2.275 -# or globally by setting AUTOLINK_SUPPORT to NO.
   2.276 +# be prevented in individual cases by putting a % sign in front of the word or
   2.277 +# globally by setting AUTOLINK_SUPPORT to NO.
   2.278  # The default value is: YES.
   2.279  
   2.280  AUTOLINK_SUPPORT       = YES
   2.281 @@ -312,7 +378,7 @@
   2.282  CPP_CLI_SUPPORT        = NO
   2.283  
   2.284  # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
   2.285 -# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
   2.286 +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
   2.287  # will parse them like normal C++ but will assume all classes use public instead
   2.288  # of private inheritance when no explicit protection keyword is present.
   2.289  # The default value is: NO.
   2.290 @@ -330,13 +396,20 @@
   2.291  IDL_PROPERTY_SUPPORT   = YES
   2.292  
   2.293  # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
   2.294 -# tag is set to YES, then doxygen will reuse the documentation of the first
   2.295 +# tag is set to YES then doxygen will reuse the documentation of the first
   2.296  # member in the group (if any) for the other members of the group. By default
   2.297  # all members of a group must be documented explicitly.
   2.298  # The default value is: NO.
   2.299  
   2.300  DISTRIBUTE_GROUP_DOC   = NO
   2.301  
   2.302 +# If one adds a struct or class to a group and this option is enabled, then also
   2.303 +# any nested class or struct is added to the same group. By default this option
   2.304 +# is disabled and one has to add nested compounds explicitly via \ingroup.
   2.305 +# The default value is: NO.
   2.306 +
   2.307 +GROUP_NESTED_COMPOUNDS = NO
   2.308 +
   2.309  # Set the SUBGROUPING tag to YES to allow class member groups of the same type
   2.310  # (for instance a group of public functions) to be put as a subgroup of that
   2.311  # type (e.g. under the Public Functions section). Set it to NO to prevent
   2.312 @@ -391,11 +464,24 @@
   2.313  
   2.314  LOOKUP_CACHE_SIZE      = 0
   2.315  
   2.316 +# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use
   2.317 +# during processing. When set to 0 doxygen will based this on the number of
   2.318 +# cores available in the system. You can set it explicitly to a value larger
   2.319 +# than 0 to get more control over the balance between CPU load and processing
   2.320 +# speed. At this moment only the input processing can be done using multiple
   2.321 +# threads. Since this is still an experimental feature the default is set to 1,
   2.322 +# which effectively disables parallel processing. Please report any issues you
   2.323 +# encounter. Generating dot graphs in parallel is controlled by the
   2.324 +# DOT_NUM_THREADS setting.
   2.325 +# Minimum value: 0, maximum value: 32, default value: 1.
   2.326 +
   2.327 +NUM_PROC_THREADS       = 1
   2.328 +
   2.329  #---------------------------------------------------------------------------
   2.330  # Build related configuration options
   2.331  #---------------------------------------------------------------------------
   2.332  
   2.333 -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
   2.334 +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
   2.335  # documentation are documented, even if no documentation was available. Private
   2.336  # class members and static file members will be hidden unless the
   2.337  # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
   2.338 @@ -405,35 +491,41 @@
   2.339  
   2.340  EXTRACT_ALL            = NO
   2.341  
   2.342 -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
   2.343 +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
   2.344  # be included in the documentation.
   2.345  # The default value is: NO.
   2.346  
   2.347  EXTRACT_PRIVATE        = NO
   2.348  
   2.349 -# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
   2.350 +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
   2.351 +# methods of a class will be included in the documentation.
   2.352 +# The default value is: NO.
   2.353 +
   2.354 +EXTRACT_PRIV_VIRTUAL   = NO
   2.355 +
   2.356 +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
   2.357  # scope will be included in the documentation.
   2.358  # The default value is: NO.
   2.359  
   2.360  EXTRACT_PACKAGE        = NO
   2.361  
   2.362 -# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
   2.363 +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
   2.364  # included in the documentation.
   2.365  # The default value is: NO.
   2.366  
   2.367  EXTRACT_STATIC         = YES
   2.368  
   2.369 -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
   2.370 -# locally in source files will be included in the documentation. If set to NO
   2.371 +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
   2.372 +# locally in source files will be included in the documentation. If set to NO,
   2.373  # only classes defined in header files are included. Does not have any effect
   2.374  # for Java sources.
   2.375  # The default value is: YES.
   2.376  
   2.377  EXTRACT_LOCAL_CLASSES  = YES
   2.378  
   2.379 -# This flag is only useful for Objective-C code. When set to YES local methods,
   2.380 +# This flag is only useful for Objective-C code. If set to YES, local methods,
   2.381  # which are defined in the implementation section but not in the interface are
   2.382 -# included in the documentation. If set to NO only methods in the interface are
   2.383 +# included in the documentation. If set to NO, only methods in the interface are
   2.384  # included.
   2.385  # The default value is: NO.
   2.386  
   2.387 @@ -448,6 +540,13 @@
   2.388  
   2.389  EXTRACT_ANON_NSPACES   = NO
   2.390  
   2.391 +# If this flag is set to YES, the name of an unnamed parameter in a declaration
   2.392 +# will be determined by the corresponding definition. By default unnamed
   2.393 +# parameters remain unnamed in the output.
   2.394 +# The default value is: YES.
   2.395 +
   2.396 +RESOLVE_UNNAMED_PARAMS = YES
   2.397 +
   2.398  # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
   2.399  # undocumented members inside documented classes or files. If set to NO these
   2.400  # members will be included in the various overviews, but no documentation
   2.401 @@ -458,21 +557,22 @@
   2.402  
   2.403  # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
   2.404  # undocumented classes that are normally visible in the class hierarchy. If set
   2.405 -# to NO these classes will be included in the various overviews. This option has
   2.406 -# no effect if EXTRACT_ALL is enabled.
   2.407 +# to NO, these classes will be included in the various overviews. This option
   2.408 +# will also hide undocumented C++ concepts if enabled. This option has no effect
   2.409 +# if EXTRACT_ALL is enabled.
   2.410  # The default value is: NO.
   2.411  
   2.412  HIDE_UNDOC_CLASSES     = NO
   2.413  
   2.414  # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
   2.415 -# (class|struct|union) declarations. If set to NO these declarations will be
   2.416 -# included in the documentation.
   2.417 +# declarations. If set to NO, these declarations will be included in the
   2.418 +# documentation.
   2.419  # The default value is: NO.
   2.420  
   2.421  HIDE_FRIEND_COMPOUNDS  = NO
   2.422  
   2.423  # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
   2.424 -# documentation blocks found inside the body of a function. If set to NO these
   2.425 +# documentation blocks found inside the body of a function. If set to NO, these
   2.426  # blocks will be appended to the function's detailed documentation block.
   2.427  # The default value is: NO.
   2.428  
   2.429 @@ -485,22 +585,43 @@
   2.430  
   2.431  INTERNAL_DOCS          = NO
   2.432  
   2.433 -# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
   2.434 -# names in lower-case letters. If set to YES upper-case letters are also
   2.435 -# allowed. This is useful if you have classes or files whose names only differ
   2.436 -# in case and if your file system supports case sensitive file names. Windows
   2.437 -# and Mac users are advised to set this option to NO.
   2.438 -# The default value is: system dependent.
   2.439 +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be
   2.440 +# able to match the capabilities of the underlying filesystem. In case the
   2.441 +# filesystem is case sensitive (i.e. it supports files in the same directory
   2.442 +# whose names only differ in casing), the option must be set to YES to properly
   2.443 +# deal with such files in case they appear in the input. For filesystems that
   2.444 +# are not case sensitive the option should be set to NO to properly deal with
   2.445 +# output files written for symbols that only differ in casing, such as for two
   2.446 +# classes, one named CLASS and the other named Class, and to also support
   2.447 +# references to files without having to specify the exact matching casing. On
   2.448 +# Windows (including Cygwin) and MacOS, users should typically set this option
   2.449 +# to NO, whereas on Linux or other Unix flavors it should typically be set to
   2.450 +# YES.
   2.451 +# Possible values are: SYSTEM, NO and YES.
   2.452 +# The default value is: SYSTEM.
   2.453  
   2.454  CASE_SENSE_NAMES       = YES
   2.455  
   2.456  # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
   2.457 -# their full class and namespace scopes in the documentation. If set to YES the
   2.458 +# their full class and namespace scopes in the documentation. If set to YES, the
   2.459  # scope will be hidden.
   2.460  # The default value is: NO.
   2.461  
   2.462  HIDE_SCOPE_NAMES       = NO
   2.463  
   2.464 +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
   2.465 +# append additional text to a page's title, such as Class Reference. If set to
   2.466 +# YES the compound reference will be hidden.
   2.467 +# The default value is: NO.
   2.468 +
   2.469 +HIDE_COMPOUND_REFERENCE= NO
   2.470 +
   2.471 +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
   2.472 +# will show which file needs to be included to use the class.
   2.473 +# The default value is: YES.
   2.474 +
   2.475 +SHOW_HEADERFILE        = YES
   2.476 +
   2.477  # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
   2.478  # the files that are included by a file in the documentation of that file.
   2.479  # The default value is: YES.
   2.480 @@ -528,14 +649,14 @@
   2.481  
   2.482  # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
   2.483  # (detailed) documentation of file and class members alphabetically by member
   2.484 -# name. If set to NO the members will appear in declaration order.
   2.485 +# name. If set to NO, the members will appear in declaration order.
   2.486  # The default value is: YES.
   2.487  
   2.488  SORT_MEMBER_DOCS       = YES
   2.489  
   2.490  # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
   2.491  # descriptions of file, namespace and class members alphabetically by member
   2.492 -# name. If set to NO the members will appear in declaration order. Note that
   2.493 +# name. If set to NO, the members will appear in declaration order. Note that
   2.494  # this will also influence the order of the classes in the class list.
   2.495  # The default value is: NO.
   2.496  
   2.497 @@ -580,27 +701,25 @@
   2.498  
   2.499  STRICT_PROTO_MATCHING  = NO
   2.500  
   2.501 -# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
   2.502 -# todo list. This list is created by putting \todo commands in the
   2.503 -# documentation.
   2.504 +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
   2.505 +# list. This list is created by putting \todo commands in the documentation.
   2.506  # The default value is: YES.
   2.507  
   2.508  GENERATE_TODOLIST      = YES
   2.509  
   2.510 -# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
   2.511 -# test list. This list is created by putting \test commands in the
   2.512 -# documentation.
   2.513 +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
   2.514 +# list. This list is created by putting \test commands in the documentation.
   2.515  # The default value is: YES.
   2.516  
   2.517  GENERATE_TESTLIST      = YES
   2.518  
   2.519 -# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
   2.520 +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
   2.521  # list. This list is created by putting \bug commands in the documentation.
   2.522  # The default value is: YES.
   2.523  
   2.524  GENERATE_BUGLIST       = YES
   2.525  
   2.526 -# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
   2.527 +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
   2.528  # the deprecated list. This list is created by putting \deprecated commands in
   2.529  # the documentation.
   2.530  # The default value is: YES.
   2.531 @@ -625,8 +744,8 @@
   2.532  MAX_INITIALIZER_LINES  = 30
   2.533  
   2.534  # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
   2.535 -# the bottom of the documentation of classes and structs. If set to YES the list
   2.536 -# will mention the files that were used to generate the documentation.
   2.537 +# the bottom of the documentation of classes and structs. If set to YES, the
   2.538 +# list will mention the files that were used to generate the documentation.
   2.539  # The default value is: YES.
   2.540  
   2.541  SHOW_USED_FILES        = YES
   2.542 @@ -660,7 +779,8 @@
   2.543  # output files in an output format independent way. To create the layout file
   2.544  # that represents doxygen's defaults, run doxygen with the -l option. You can
   2.545  # optionally specify a file name after the option, if omitted DoxygenLayout.xml
   2.546 -# will be used as the name of the layout file.
   2.547 +# will be used as the name of the layout file. See also section "Changing the
   2.548 +# layout of pages" for information.
   2.549  #
   2.550  # Note that if you run doxygen from a directory containing a file called
   2.551  # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
   2.552 @@ -671,11 +791,10 @@
   2.553  # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
   2.554  # the reference definitions. This must be a list of .bib files. The .bib
   2.555  # extension is automatically appended if omitted. This requires the bibtex tool
   2.556 -# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
   2.557 +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
   2.558  # For LaTeX the style of the bibliography can be controlled using
   2.559  # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
   2.560 -# search path. Do not use file names with spaces, bibtex cannot handle them. See
   2.561 -# also \cite for info how to create references.
   2.562 +# search path. See also \cite for info how to create references.
   2.563  
   2.564  CITE_BIB_FILES         =
   2.565  
   2.566 @@ -688,10 +807,10 @@
   2.567  # messages are off.
   2.568  # The default value is: NO.
   2.569  
   2.570 -QUIET                  = YES
   2.571 +QUIET                  = NO
   2.572  
   2.573  # The WARNINGS tag can be used to turn on/off the warning messages that are
   2.574 -# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
   2.575 +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
   2.576  # this implies that the warnings are on.
   2.577  #
   2.578  # Tip: Turn warnings on while writing the documentation.
   2.579 @@ -699,7 +818,7 @@
   2.580  
   2.581  WARNINGS               = YES
   2.582  
   2.583 -# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
   2.584 +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
   2.585  # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
   2.586  # will automatically be disabled.
   2.587  # The default value is: YES.
   2.588 @@ -707,34 +826,74 @@
   2.589  WARN_IF_UNDOCUMENTED   = YES
   2.590  
   2.591  # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
   2.592 -# potential errors in the documentation, such as not documenting some parameters
   2.593 -# in a documented function, or documenting parameters that don't exist or using
   2.594 -# markup commands wrongly.
   2.595 +# potential errors in the documentation, such as documenting some parameters in
   2.596 +# a documented function twice, or documenting parameters that don't exist or
   2.597 +# using markup commands wrongly.
   2.598  # The default value is: YES.
   2.599  
   2.600  WARN_IF_DOC_ERROR      = YES
   2.601  
   2.602 +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
   2.603 +# function parameter documentation. If set to NO, doxygen will accept that some
   2.604 +# parameters have no documentation without warning.
   2.605 +# The default value is: YES.
   2.606 +
   2.607 +WARN_IF_INCOMPLETE_DOC = YES
   2.608 +
   2.609  # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
   2.610  # are documented, but have no documentation for their parameters or return
   2.611 -# value. If set to NO doxygen will only warn about wrong or incomplete parameter
   2.612 -# documentation, but not about the absence of documentation.
   2.613 +# value. If set to NO, doxygen will only warn about wrong parameter
   2.614 +# documentation, but not about the absence of documentation. If EXTRACT_ALL is
   2.615 +# set to YES then this flag will automatically be disabled. See also
   2.616 +# WARN_IF_INCOMPLETE_DOC
   2.617  # The default value is: NO.
   2.618  
   2.619  WARN_NO_PARAMDOC       = YES
   2.620  
   2.621 +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about
   2.622 +# undocumented enumeration values. If set to NO, doxygen will accept
   2.623 +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag
   2.624 +# will automatically be disabled.
   2.625 +# The default value is: NO.
   2.626 +
   2.627 +WARN_IF_UNDOC_ENUM_VAL = NO
   2.628 +
   2.629 +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
   2.630 +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
   2.631 +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
   2.632 +# at the end of the doxygen process doxygen will return with a non-zero status.
   2.633 +# Possible values are: NO, YES and FAIL_ON_WARNINGS.
   2.634 +# The default value is: NO.
   2.635 +
   2.636 +WARN_AS_ERROR          = NO
   2.637 +
   2.638  # The WARN_FORMAT tag determines the format of the warning messages that doxygen
   2.639  # can produce. The string should contain the $file, $line, and $text tags, which
   2.640  # will be replaced by the file and line number from which the warning originated
   2.641  # and the warning text. Optionally the format may contain $version, which will
   2.642  # be replaced by the version of the file (if it could be obtained via
   2.643  # FILE_VERSION_FILTER)
   2.644 +# See also: WARN_LINE_FORMAT
   2.645  # The default value is: $file:$line: $text.
   2.646  
   2.647  WARN_FORMAT            = "$file:$line: $text"
   2.648  
   2.649 +# In the $text part of the WARN_FORMAT command it is possible that a reference
   2.650 +# to a more specific place is given. To make it easier to jump to this place
   2.651 +# (outside of doxygen) the user can define a custom "cut" / "paste" string.
   2.652 +# Example:
   2.653 +# WARN_LINE_FORMAT = "'vi $file +$line'"
   2.654 +# See also: WARN_FORMAT
   2.655 +# The default value is: at line $line of file $file.
   2.656 +
   2.657 +WARN_LINE_FORMAT       = "at line $line of file $file"
   2.658 +
   2.659  # The WARN_LOGFILE tag can be used to specify a file to which warning and error
   2.660  # messages should be written. If left blank the output is written to standard
   2.661 -# error (stderr).
   2.662 +# error (stderr). In case the file specified cannot be opened for writing the
   2.663 +# warning and error messages are written to standard error. When as file - is
   2.664 +# specified the warning and error messages are written to standard output
   2.665 +# (stdout).
   2.666  
   2.667  WARN_LOGFILE           =
   2.668  
   2.669 @@ -745,7 +904,7 @@
   2.670  # The INPUT tag is used to specify the files and/or directories that contain
   2.671  # documented source files. You may enter file names like myfile.cpp or
   2.672  # directories like /usr/src/myproject. Separate the files or directories with
   2.673 -# spaces.
   2.674 +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
   2.675  # Note: If this tag is empty the current directory is searched.
   2.676  
   2.677  INPUT                  = @DOXY_INPUT@
   2.678 @@ -753,20 +912,40 @@
   2.679  # This tag can be used to specify the character encoding of the source files
   2.680  # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
   2.681  # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
   2.682 -# documentation (see: http://www.gnu.org/software/libiconv) for the list of
   2.683 -# possible encodings.
   2.684 +# documentation (see:
   2.685 +# https://www.gnu.org/software/libiconv/) for the list of possible encodings.
   2.686 +# See also: INPUT_FILE_ENCODING
   2.687  # The default value is: UTF-8.
   2.688  
   2.689  INPUT_ENCODING         = UTF-8
   2.690  
   2.691 +# This tag can be used to specify the character encoding of the source files
   2.692 +# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify
   2.693 +# character encoding on a per file pattern basis. Doxygen will compare the file
   2.694 +# name with each pattern and apply the encoding instead of the default
   2.695 +# INPUT_ENCODING) if there is a match. The character encodings are a list of the
   2.696 +# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding
   2.697 +# "INPUT_ENCODING" for further information on supported encodings.
   2.698 +
   2.699 +INPUT_FILE_ENCODING    =
   2.700 +
   2.701  # If the value of the INPUT tag contains directories, you can use the
   2.702  # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
   2.703 -# *.h) to filter out the source-files in the directories. If left blank the
   2.704 -# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
   2.705 -# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
   2.706 -# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
   2.707 -# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
   2.708 -# *.qsf, *.as and *.js.
   2.709 +# *.h) to filter out the source-files in the directories.
   2.710 +#
   2.711 +# Note that for custom extensions or not directly supported extensions you also
   2.712 +# need to set EXTENSION_MAPPING for the extension otherwise the files are not
   2.713 +# read by doxygen.
   2.714 +#
   2.715 +# Note the list of default checked file patterns might differ from the list of
   2.716 +# default file extension mappings.
   2.717 +#
   2.718 +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
   2.719 +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
   2.720 +# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml,
   2.721 +# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C
   2.722 +# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,
   2.723 +# *.vhdl, *.ucf, *.qsf and *.ice.
   2.724  
   2.725  FILE_PATTERNS          =
   2.726  
   2.727 @@ -805,7 +984,7 @@
   2.728  # (namespaces, classes, functions, etc.) that should be excluded from the
   2.729  # output. The symbol name can be a fully qualified name, a word, or if the
   2.730  # wildcard * is used, a substring. Examples: ANamespace, AClass,
   2.731 -# AClass::ANamespace, ANamespace::*Test
   2.732 +# ANamespace::AClass, ANamespace::*Test
   2.733  #
   2.734  # Note that the wildcards are matched against the file with absolute path, so to
   2.735  # exclude all test directories use the pattern */test/*
   2.736 @@ -852,6 +1031,15 @@
   2.737  # Note that the filter must not add or remove lines; it is applied before the
   2.738  # code is scanned, but not when the output code is generated. If lines are added
   2.739  # or removed, the anchors will not be placed correctly.
   2.740 +#
   2.741 +# Note that doxygen will use the data processed and written to standard output
   2.742 +# for further processing, therefore nothing else, like debug statements or used
   2.743 +# commands (so in case of a Windows batch file always use @echo OFF), should be
   2.744 +# written to standard output.
   2.745 +#
   2.746 +# Note that for custom extensions or not directly supported extensions you also
   2.747 +# need to set EXTENSION_MAPPING for the extension otherwise the files are not
   2.748 +# properly processed by doxygen.
   2.749  
   2.750  INPUT_FILTER           =
   2.751  
   2.752 @@ -861,11 +1049,15 @@
   2.753  # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
   2.754  # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
   2.755  # patterns match the file name, INPUT_FILTER is applied.
   2.756 +#
   2.757 +# Note that for custom extensions or not directly supported extensions you also
   2.758 +# need to set EXTENSION_MAPPING for the extension otherwise the files are not
   2.759 +# properly processed by doxygen.
   2.760  
   2.761  FILTER_PATTERNS        =
   2.762  
   2.763  # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
   2.764 -# INPUT_FILTER ) will also be used to filter the input files that are used for
   2.765 +# INPUT_FILTER) will also be used to filter the input files that are used for
   2.766  # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
   2.767  # The default value is: NO.
   2.768  
   2.769 @@ -886,6 +1078,15 @@
   2.770  
   2.771  USE_MDFILE_AS_MAINPAGE =
   2.772  
   2.773 +# The Fortran standard specifies that for fixed formatted Fortran code all
   2.774 +# characters from position 72 are to be considered as comment. A common
   2.775 +# extension is to allow longer lines before the automatic comment starts. The
   2.776 +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can
   2.777 +# be processed before the automatic comment starts.
   2.778 +# Minimum value: 7, maximum value: 10000, default value: 72.
   2.779 +
   2.780 +FORTRAN_COMMENT_AFTER  = 72
   2.781 +
   2.782  #---------------------------------------------------------------------------
   2.783  # Configuration options related to source browsing
   2.784  #---------------------------------------------------------------------------
   2.785 @@ -913,7 +1114,7 @@
   2.786  STRIP_CODE_COMMENTS    = YES
   2.787  
   2.788  # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
   2.789 -# function all documented functions referencing it will be listed.
   2.790 +# entity all documented functions referencing it will be listed.
   2.791  # The default value is: NO.
   2.792  
   2.793  REFERENCED_BY_RELATION = NO
   2.794 @@ -925,7 +1126,7 @@
   2.795  REFERENCES_RELATION    = NO
   2.796  
   2.797  # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
   2.798 -# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
   2.799 +# to YES then the hyperlinks from functions in REFERENCES_RELATION and
   2.800  # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
   2.801  # link to the documentation.
   2.802  # The default value is: YES.
   2.803 @@ -945,12 +1146,12 @@
   2.804  # If the USE_HTAGS tag is set to YES then the references to source code will
   2.805  # point to the HTML generated by the htags(1) tool instead of doxygen built-in
   2.806  # source browser. The htags tool is part of GNU's global source tagging system
   2.807 -# (see http://www.gnu.org/software/global/global.html). You will need version
   2.808 +# (see https://www.gnu.org/software/global/global.html). You will need version
   2.809  # 4.8.6 or higher.
   2.810  #
   2.811  # To use it do the following:
   2.812  # - Install the latest version of global
   2.813 -# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
   2.814 +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
   2.815  # - Make sure the INPUT points to the root of the source tree
   2.816  # - Run doxygen as normal
   2.817  #
   2.818 @@ -972,6 +1173,46 @@
   2.819  
   2.820  VERBATIM_HEADERS       = YES
   2.821  
   2.822 +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
   2.823 +# clang parser (see:
   2.824 +# http://clang.llvm.org/) for more accurate parsing at the cost of reduced
   2.825 +# performance. This can be particularly helpful with template rich C++ code for
   2.826 +# which doxygen's built-in parser lacks the necessary type information.
   2.827 +# Note: The availability of this option depends on whether or not doxygen was
   2.828 +# generated with the -Duse_libclang=ON option for CMake.
   2.829 +# The default value is: NO.
   2.830 +
   2.831 +CLANG_ASSISTED_PARSING = NO
   2.832 +
   2.833 +# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS
   2.834 +# tag is set to YES then doxygen will add the directory of each input to the
   2.835 +# include path.
   2.836 +# The default value is: YES.
   2.837 +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
   2.838 +
   2.839 +CLANG_ADD_INC_PATHS    = YES
   2.840 +
   2.841 +# If clang assisted parsing is enabled you can provide the compiler with command
   2.842 +# line options that you would normally use when invoking the compiler. Note that
   2.843 +# the include paths will already be set by doxygen for the files and directories
   2.844 +# specified with INPUT and INCLUDE_PATH.
   2.845 +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
   2.846 +
   2.847 +CLANG_OPTIONS          =
   2.848 +
   2.849 +# If clang assisted parsing is enabled you can provide the clang parser with the
   2.850 +# path to the directory containing a file called compile_commands.json. This
   2.851 +# file is the compilation database (see:
   2.852 +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the
   2.853 +# options used when the source files were built. This is equivalent to
   2.854 +# specifying the -p option to a clang tool, such as clang-check. These options
   2.855 +# will then be passed to the parser. Any options specified with CLANG_OPTIONS
   2.856 +# will be added as well.
   2.857 +# Note: The availability of this option depends on whether or not doxygen was
   2.858 +# generated with the -Duse_libclang=ON option for CMake.
   2.859 +
   2.860 +CLANG_DATABASE_PATH    =
   2.861 +
   2.862  #---------------------------------------------------------------------------
   2.863  # Configuration options related to the alphabetical class index
   2.864  #---------------------------------------------------------------------------
   2.865 @@ -983,10 +1224,11 @@
   2.866  
   2.867  ALPHABETICAL_INDEX     = YES
   2.868  
   2.869 -# In case all classes in a project start with a common prefix, all classes will
   2.870 -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
   2.871 -# can be used to specify a prefix (or a list of prefixes) that should be ignored
   2.872 -# while generating the index headers.
   2.873 +# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes)
   2.874 +# that should be ignored while generating the index headers. The IGNORE_PREFIX
   2.875 +# tag works for classes, function and member names. The entity will be placed in
   2.876 +# the alphabetical list under the first letter of the entity name that remains
   2.877 +# after removing the prefix.
   2.878  # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
   2.879  
   2.880  IGNORE_PREFIX          =
   2.881 @@ -995,7 +1237,7 @@
   2.882  # Configuration options related to the HTML output
   2.883  #---------------------------------------------------------------------------
   2.884  
   2.885 -# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
   2.886 +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
   2.887  # The default value is: YES.
   2.888  
   2.889  GENERATE_HTML          = YES
   2.890 @@ -1057,13 +1299,20 @@
   2.891  
   2.892  HTML_STYLESHEET        =
   2.893  
   2.894 -# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
   2.895 -# defined cascading style sheet that is included after the standard style sheets
   2.896 +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
   2.897 +# cascading style sheets that are included after the standard style sheets
   2.898  # created by doxygen. Using this option one can overrule certain style aspects.
   2.899  # This is preferred over using HTML_STYLESHEET since it does not replace the
   2.900 -# standard style sheet and is therefor more robust against future updates.
   2.901 -# Doxygen will copy the style sheet file to the output directory. For an example
   2.902 -# see the documentation.
   2.903 +# standard style sheet and is therefore more robust against future updates.
   2.904 +# Doxygen will copy the style sheet files to the output directory.
   2.905 +# Note: The order of the extra style sheet files is of importance (e.g. the last
   2.906 +# style sheet in the list overrules the setting of the previous ones in the
   2.907 +# list).
   2.908 +# Note: Since the styling of scrollbars can currently not be overruled in
   2.909 +# Webkit/Chromium, the styling will be left out of the default doxygen.css if
   2.910 +# one or more extra stylesheets have been specified. So if scrollbar
   2.911 +# customization is desired it has to be added explicitly. For an example see the
   2.912 +# documentation.
   2.913  # This tag requires that the tag GENERATE_HTML is set to YES.
   2.914  
   2.915  HTML_EXTRA_STYLESHEET  =
   2.916 @@ -1078,10 +1327,23 @@
   2.917  
   2.918  HTML_EXTRA_FILES       =
   2.919  
   2.920 +# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
   2.921 +# should be rendered with a dark or light theme.
   2.922 +# Possible values are: LIGHT always generate light mode output, DARK always
   2.923 +# generate dark mode output, AUTO_LIGHT automatically set the mode according to
   2.924 +# the user preference, use light mode if no preference is set (the default),
   2.925 +# AUTO_DARK automatically set the mode according to the user preference, use
   2.926 +# dark mode if no preference is set and TOGGLE allow to user to switch between
   2.927 +# light and dark mode via a button.
   2.928 +# The default value is: AUTO_LIGHT.
   2.929 +# This tag requires that the tag GENERATE_HTML is set to YES.
   2.930 +
   2.931 +HTML_COLORSTYLE        = AUTO_LIGHT
   2.932 +
   2.933  # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
   2.934 -# will adjust the colors in the stylesheet and background images according to
   2.935 -# this color. Hue is specified as an angle on a colorwheel, see
   2.936 -# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
   2.937 +# will adjust the colors in the style sheet and background images according to
   2.938 +# this color. Hue is specified as an angle on a color-wheel, see
   2.939 +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
   2.940  # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
   2.941  # purple, and 360 is red again.
   2.942  # Minimum value: 0, maximum value: 359, default value: 220.
   2.943 @@ -1090,7 +1352,7 @@
   2.944  HTML_COLORSTYLE_HUE    = 220
   2.945  
   2.946  # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
   2.947 -# in the HTML output. For a value of 0 the output will use grayscales only. A
   2.948 +# in the HTML output. For a value of 0 the output will use gray-scales only. A
   2.949  # value of 255 will produce the most vivid colors.
   2.950  # Minimum value: 0, maximum value: 255, default value: 100.
   2.951  # This tag requires that the tag GENERATE_HTML is set to YES.
   2.952 @@ -1110,11 +1372,23 @@
   2.953  
   2.954  # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
   2.955  # page will contain the date and time when the page was generated. Setting this
   2.956 -# to NO can help when comparing the output of multiple runs.
   2.957 +# to YES can help to show when doxygen was last run and thus if the
   2.958 +# documentation is up to date.
   2.959 +# The default value is: NO.
   2.960 +# This tag requires that the tag GENERATE_HTML is set to YES.
   2.961 +
   2.962 +HTML_TIMESTAMP         = YES
   2.963 +
   2.964 +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
   2.965 +# documentation will contain a main index with vertical navigation menus that
   2.966 +# are dynamically created via JavaScript. If disabled, the navigation index will
   2.967 +# consists of multiple levels of tabs that are statically embedded in every HTML
   2.968 +# page. Disable this option to support browsers that do not have JavaScript,
   2.969 +# like the Qt help browser.
   2.970  # The default value is: YES.
   2.971  # This tag requires that the tag GENERATE_HTML is set to YES.
   2.972  
   2.973 -HTML_TIMESTAMP         = YES
   2.974 +HTML_DYNAMIC_MENUS     = YES
   2.975  
   2.976  # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
   2.977  # documentation will contain sections that can be hidden and shown after the
   2.978 @@ -1139,13 +1413,14 @@
   2.979  
   2.980  # If the GENERATE_DOCSET tag is set to YES, additional index files will be
   2.981  # generated that can be used as input for Apple's Xcode 3 integrated development
   2.982 -# environment (see: http://developer.apple.com/tools/xcode/), introduced with
   2.983 -# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
   2.984 -# Makefile in the HTML output directory. Running make will produce the docset in
   2.985 -# that directory and running make install will install the docset in
   2.986 +# environment (see:
   2.987 +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
   2.988 +# create a documentation set, doxygen will generate a Makefile in the HTML
   2.989 +# output directory. Running make will produce the docset in that directory and
   2.990 +# running make install will install the docset in
   2.991  # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
   2.992 -# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
   2.993 -# for more information.
   2.994 +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
   2.995 +# genXcode/_index.html for more information.
   2.996  # The default value is: NO.
   2.997  # This tag requires that the tag GENERATE_HTML is set to YES.
   2.998  
   2.999 @@ -1159,6 +1434,13 @@
  2.1000  
  2.1001  DOCSET_FEEDNAME        = "Doxygen generated docs"
  2.1002  
  2.1003 +# This tag determines the URL of the docset feed. A documentation feed provides
  2.1004 +# an umbrella under which multiple documentation sets from a single provider
  2.1005 +# (such as a company or product suite) can be grouped.
  2.1006 +# This tag requires that the tag GENERATE_DOCSET is set to YES.
  2.1007 +
  2.1008 +DOCSET_FEEDURL         =
  2.1009 +
  2.1010  # This tag specifies a string that should uniquely identify the documentation
  2.1011  # set bundle. This should be a reverse domain-name style string, e.g.
  2.1012  # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
  2.1013 @@ -1184,8 +1466,12 @@
  2.1014  # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
  2.1015  # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
  2.1016  # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
  2.1017 -# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
  2.1018 -# Windows.
  2.1019 +# on Windows. In the beginning of 2021 Microsoft took the original page, with
  2.1020 +# a.o. the download links, offline the HTML help workshop was already many years
  2.1021 +# in maintenance mode). You can download the HTML help workshop from the web
  2.1022 +# archives at Installation executable (see:
  2.1023 +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo
  2.1024 +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
  2.1025  #
  2.1026  # The HTML Help Workshop contains a compiler that can convert all HTML output
  2.1027  # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
  2.1028 @@ -1207,28 +1493,28 @@
  2.1029  CHM_FILE               =
  2.1030  
  2.1031  # The HHC_LOCATION tag can be used to specify the location (absolute path
  2.1032 -# including file name) of the HTML help compiler ( hhc.exe). If non-empty
  2.1033 +# including file name) of the HTML help compiler (hhc.exe). If non-empty,
  2.1034  # doxygen will try to run the HTML help compiler on the generated index.hhp.
  2.1035  # The file has to be specified with full path.
  2.1036  # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  2.1037  
  2.1038  HHC_LOCATION           =
  2.1039  
  2.1040 -# The GENERATE_CHI flag controls if a separate .chi index file is generated (
  2.1041 -# YES) or that it should be included in the master .chm file ( NO).
  2.1042 +# The GENERATE_CHI flag controls if a separate .chi index file is generated
  2.1043 +# (YES) or that it should be included in the main .chm file (NO).
  2.1044  # The default value is: NO.
  2.1045  # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  2.1046  
  2.1047  GENERATE_CHI           = NO
  2.1048  
  2.1049 -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
  2.1050 +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
  2.1051  # and project file content.
  2.1052  # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  2.1053  
  2.1054  CHM_INDEX_ENCODING     =
  2.1055  
  2.1056 -# The BINARY_TOC flag controls whether a binary table of contents is generated (
  2.1057 -# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it
  2.1058 +# The BINARY_TOC flag controls whether a binary table of contents is generated
  2.1059 +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
  2.1060  # enables the Previous and Next buttons.
  2.1061  # The default value is: NO.
  2.1062  # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  2.1063 @@ -1260,7 +1546,8 @@
  2.1064  
  2.1065  # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
  2.1066  # Project output. For more information please see Qt Help Project / Namespace
  2.1067 -# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
  2.1068 +# (see:
  2.1069 +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
  2.1070  # The default value is: org.doxygen.Project.
  2.1071  # This tag requires that the tag GENERATE_QHP is set to YES.
  2.1072  
  2.1073 @@ -1268,8 +1555,8 @@
  2.1074  
  2.1075  # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
  2.1076  # Help Project output. For more information please see Qt Help Project / Virtual
  2.1077 -# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
  2.1078 -# folders).
  2.1079 +# Folders (see:
  2.1080 +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
  2.1081  # The default value is: doc.
  2.1082  # This tag requires that the tag GENERATE_QHP is set to YES.
  2.1083  
  2.1084 @@ -1277,30 +1564,30 @@
  2.1085  
  2.1086  # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
  2.1087  # filter to add. For more information please see Qt Help Project / Custom
  2.1088 -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
  2.1089 -# filters).
  2.1090 +# Filters (see:
  2.1091 +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
  2.1092  # This tag requires that the tag GENERATE_QHP is set to YES.
  2.1093  
  2.1094  QHP_CUST_FILTER_NAME   =
  2.1095  
  2.1096  # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
  2.1097  # custom filter to add. For more information please see Qt Help Project / Custom
  2.1098 -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
  2.1099 -# filters).
  2.1100 +# Filters (see:
  2.1101 +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
  2.1102  # This tag requires that the tag GENERATE_QHP is set to YES.
  2.1103  
  2.1104  QHP_CUST_FILTER_ATTRS  =
  2.1105  
  2.1106  # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
  2.1107  # project's filter section matches. Qt Help Project / Filter Attributes (see:
  2.1108 -# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
  2.1109 +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
  2.1110  # This tag requires that the tag GENERATE_QHP is set to YES.
  2.1111  
  2.1112  QHP_SECT_FILTER_ATTRS  =
  2.1113  
  2.1114 -# The QHG_LOCATION tag can be used to specify the location of Qt's
  2.1115 -# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
  2.1116 -# generated .qhp file.
  2.1117 +# The QHG_LOCATION tag can be used to specify the location (absolute path
  2.1118 +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
  2.1119 +# run qhelpgenerator on the generated .qhp file.
  2.1120  # This tag requires that the tag GENERATE_QHP is set to YES.
  2.1121  
  2.1122  QHG_LOCATION           =
  2.1123 @@ -1342,17 +1629,29 @@
  2.1124  # index structure (just like the one that is generated for HTML Help). For this
  2.1125  # to work a browser that supports JavaScript, DHTML, CSS and frames is required
  2.1126  # (i.e. any modern browser). Windows users are probably better off using the
  2.1127 -# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
  2.1128 -# further fine-tune the look of the index. As an example, the default style
  2.1129 -# sheet generated by doxygen has an example that shows how to put an image at
  2.1130 -# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
  2.1131 -# the same information as the tab index, you could consider setting
  2.1132 -# DISABLE_INDEX to YES when enabling this option.
  2.1133 +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
  2.1134 +# further fine tune the look of the index (see "Fine-tuning the output"). As an
  2.1135 +# example, the default style sheet generated by doxygen has an example that
  2.1136 +# shows how to put an image at the root of the tree instead of the PROJECT_NAME.
  2.1137 +# Since the tree basically has the same information as the tab index, you could
  2.1138 +# consider setting DISABLE_INDEX to YES when enabling this option.
  2.1139  # The default value is: NO.
  2.1140  # This tag requires that the tag GENERATE_HTML is set to YES.
  2.1141  
  2.1142  GENERATE_TREEVIEW      = NO
  2.1143  
  2.1144 +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
  2.1145 +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview
  2.1146 +# area (value NO) or if it should extend to the full height of the window (value
  2.1147 +# YES). Setting this to YES gives a layout similar to
  2.1148 +# https://docs.readthedocs.io with more room for contents, but less room for the
  2.1149 +# project logo, title, and description. If either GENERATE_TREEVIEW or
  2.1150 +# DISABLE_INDEX is set to NO, this option has no effect.
  2.1151 +# The default value is: NO.
  2.1152 +# This tag requires that the tag GENERATE_HTML is set to YES.
  2.1153 +
  2.1154 +FULL_SIDEBAR           = NO
  2.1155 +
  2.1156  # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
  2.1157  # doxygen will group on one line in the generated HTML documentation.
  2.1158  #
  2.1159 @@ -1370,13 +1669,31 @@
  2.1160  
  2.1161  TREEVIEW_WIDTH         = 250
  2.1162  
  2.1163 -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
  2.1164 +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
  2.1165  # external symbols imported via tag files in a separate window.
  2.1166  # The default value is: NO.
  2.1167  # This tag requires that the tag GENERATE_HTML is set to YES.
  2.1168  
  2.1169  EXT_LINKS_IN_WINDOW    = NO
  2.1170  
  2.1171 +# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email
  2.1172 +# addresses.
  2.1173 +# The default value is: YES.
  2.1174 +# This tag requires that the tag GENERATE_HTML is set to YES.
  2.1175 +
  2.1176 +OBFUSCATE_EMAILS       = YES
  2.1177 +
  2.1178 +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
  2.1179 +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
  2.1180 +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for
  2.1181 +# the HTML output. These images will generally look nicer at scaled resolutions.
  2.1182 +# Possible values are: png (the default) and svg (looks nicer but requires the
  2.1183 +# pdf2svg or inkscape tool).
  2.1184 +# The default value is: png.
  2.1185 +# This tag requires that the tag GENERATE_HTML is set to YES.
  2.1186 +
  2.1187 +HTML_FORMULA_FORMAT    = png
  2.1188 +
  2.1189  # Use this tag to change the font size of LaTeX formulas included as images in
  2.1190  # the HTML documentation. When you change the font size after a successful
  2.1191  # doxygen run you need to manually remove any form_*.png images from the HTML
  2.1192 @@ -1386,20 +1703,15 @@
  2.1193  
  2.1194  FORMULA_FONTSIZE       = 10
  2.1195  
  2.1196 -# Use the FORMULA_TRANPARENT tag to determine whether or not the images
  2.1197 -# generated for formulas are transparent PNGs. Transparent PNGs are not
  2.1198 -# supported properly for IE 6.0, but are supported on all modern browsers.
  2.1199 -#
  2.1200 -# Note that when changing this option you need to delete any form_*.png files in
  2.1201 -# the HTML output directory before the changes have effect.
  2.1202 -# The default value is: YES.
  2.1203 -# This tag requires that the tag GENERATE_HTML is set to YES.
  2.1204 -
  2.1205 -FORMULA_TRANSPARENT    = YES
  2.1206 +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
  2.1207 +# to create new LaTeX commands to be used in formulas as building blocks. See
  2.1208 +# the section "Including formulas" for details.
  2.1209 +
  2.1210 +FORMULA_MACROFILE      =
  2.1211  
  2.1212  # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
  2.1213 -# http://www.mathjax.org) which uses client side Javascript for the rendering
  2.1214 -# instead of using prerendered bitmaps. Use this if you do not have LaTeX
  2.1215 +# https://www.mathjax.org) which uses client side JavaScript for the rendering
  2.1216 +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
  2.1217  # installed or if you want to formulas look prettier in the HTML output. When
  2.1218  # enabled you may also need to install MathJax separately and configure the path
  2.1219  # to it using the MATHJAX_RELPATH option.
  2.1220 @@ -1408,11 +1720,29 @@
  2.1221  
  2.1222  USE_MATHJAX            = NO
  2.1223  
  2.1224 +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
  2.1225 +# Note that the different versions of MathJax have different requirements with
  2.1226 +# regards to the different settings, so it is possible that also other MathJax
  2.1227 +# settings have to be changed when switching between the different MathJax
  2.1228 +# versions.
  2.1229 +# Possible values are: MathJax_2 and MathJax_3.
  2.1230 +# The default value is: MathJax_2.
  2.1231 +# This tag requires that the tag USE_MATHJAX is set to YES.
  2.1232 +
  2.1233 +MATHJAX_VERSION        = MathJax_2
  2.1234 +
  2.1235  # When MathJax is enabled you can set the default output format to be used for
  2.1236 -# the MathJax output. See the MathJax site (see:
  2.1237 -# http://docs.mathjax.org/en/latest/output.html) for more details.
  2.1238 +# the MathJax output. For more details about the output format see MathJax
  2.1239 +# version 2 (see:
  2.1240 +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
  2.1241 +# (see:
  2.1242 +# http://docs.mathjax.org/en/latest/web/components/output.html).
  2.1243  # Possible values are: HTML-CSS (which is slower, but has the best
  2.1244 -# compatibility), NativeMML (i.e. MathML) and SVG.
  2.1245 +# compatibility. This is the name for Mathjax version 2, for MathJax version 3
  2.1246 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported
  2.1247 +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This
  2.1248 +# is the name for Mathjax version 3, for MathJax version 2 this will be
  2.1249 +# translated into HTML-CSS) and SVG.
  2.1250  # The default value is: HTML-CSS.
  2.1251  # This tag requires that the tag USE_MATHJAX is set to YES.
  2.1252  
  2.1253 @@ -1425,22 +1755,29 @@
  2.1254  # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
  2.1255  # Content Delivery Network so you can quickly see the result without installing
  2.1256  # MathJax. However, it is strongly recommended to install a local copy of
  2.1257 -# MathJax from http://www.mathjax.org before deployment.
  2.1258 -# The default value is: http://cdn.mathjax.org/mathjax/latest.
  2.1259 +# MathJax from https://www.mathjax.org before deployment. The default value is:
  2.1260 +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
  2.1261 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
  2.1262  # This tag requires that the tag USE_MATHJAX is set to YES.
  2.1263  
  2.1264  MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
  2.1265  
  2.1266  # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
  2.1267  # extension names that should be enabled during MathJax rendering. For example
  2.1268 +# for MathJax version 2 (see
  2.1269 +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
  2.1270  # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
  2.1271 +# For example for MathJax version 3 (see
  2.1272 +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):
  2.1273 +# MATHJAX_EXTENSIONS = ams
  2.1274  # This tag requires that the tag USE_MATHJAX is set to YES.
  2.1275  
  2.1276  MATHJAX_EXTENSIONS     =
  2.1277  
  2.1278  # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
  2.1279  # of code that will be used on startup of the MathJax code. See the MathJax site
  2.1280 -# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
  2.1281 +# (see:
  2.1282 +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
  2.1283  # example see the documentation.
  2.1284  # This tag requires that the tag USE_MATHJAX is set to YES.
  2.1285  
  2.1286 @@ -1468,7 +1805,7 @@
  2.1287  SEARCHENGINE           = YES
  2.1288  
  2.1289  # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
  2.1290 -# implemented using a web server instead of a web client using Javascript. There
  2.1291 +# implemented using a web server instead of a web client using JavaScript. There
  2.1292  # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
  2.1293  # setting. When disabled, doxygen will generate a PHP script for searching and
  2.1294  # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
  2.1295 @@ -1485,9 +1822,10 @@
  2.1296  # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
  2.1297  # search results.
  2.1298  #
  2.1299 -# Doxygen ships with an example indexer ( doxyindexer) and search engine
  2.1300 +# Doxygen ships with an example indexer (doxyindexer) and search engine
  2.1301  # (doxysearch.cgi) which are based on the open source search engine library
  2.1302 -# Xapian (see: http://xapian.org/).
  2.1303 +# Xapian (see:
  2.1304 +# https://xapian.org/).
  2.1305  #
  2.1306  # See the section "External Indexing and Searching" for details.
  2.1307  # The default value is: NO.
  2.1308 @@ -1498,10 +1836,11 @@
  2.1309  # The SEARCHENGINE_URL should point to a search engine hosted by a web server
  2.1310  # which will return the search results when EXTERNAL_SEARCH is enabled.
  2.1311  #
  2.1312 -# Doxygen ships with an example indexer ( doxyindexer) and search engine
  2.1313 +# Doxygen ships with an example indexer (doxyindexer) and search engine
  2.1314  # (doxysearch.cgi) which are based on the open source search engine library
  2.1315 -# Xapian (see: http://xapian.org/). See the section "External Indexing and
  2.1316 -# Searching" for details.
  2.1317 +# Xapian (see:
  2.1318 +# https://xapian.org/). See the section "External Indexing and Searching" for
  2.1319 +# details.
  2.1320  # This tag requires that the tag SEARCHENGINE is set to YES.
  2.1321  
  2.1322  SEARCHENGINE_URL       =
  2.1323 @@ -1536,7 +1875,7 @@
  2.1324  # Configuration options related to the LaTeX output
  2.1325  #---------------------------------------------------------------------------
  2.1326  
  2.1327 -# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
  2.1328 +# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
  2.1329  # The default value is: YES.
  2.1330  
  2.1331  GENERATE_LATEX         = NO
  2.1332 @@ -1552,22 +1891,36 @@
  2.1333  # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
  2.1334  # invoked.
  2.1335  #
  2.1336 -# Note that when enabling USE_PDFLATEX this option is only used for generating
  2.1337 -# bitmaps for formulas in the HTML output, but not in the Makefile that is
  2.1338 -# written to the output directory.
  2.1339 -# The default file is: latex.
  2.1340 +# Note that when not enabling USE_PDFLATEX the default is latex when enabling
  2.1341 +# USE_PDFLATEX the default is pdflatex and when in the later case latex is
  2.1342 +# chosen this is overwritten by pdflatex. For specific output languages the
  2.1343 +# default can have been set differently, this depends on the implementation of
  2.1344 +# the output language.
  2.1345  # This tag requires that the tag GENERATE_LATEX is set to YES.
  2.1346  
  2.1347  LATEX_CMD_NAME         = latex
  2.1348  
  2.1349  # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
  2.1350  # index for LaTeX.
  2.1351 +# Note: This tag is used in the Makefile / make.bat.
  2.1352 +# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
  2.1353 +# (.tex).
  2.1354  # The default file is: makeindex.
  2.1355  # This tag requires that the tag GENERATE_LATEX is set to YES.
  2.1356  
  2.1357  MAKEINDEX_CMD_NAME     = makeindex
  2.1358  
  2.1359 -# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
  2.1360 +# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
  2.1361 +# generate index for LaTeX. In case there is no backslash (\) as first character
  2.1362 +# it will be automatically added in the LaTeX code.
  2.1363 +# Note: This tag is used in the generated output file (.tex).
  2.1364 +# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
  2.1365 +# The default value is: makeindex.
  2.1366 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  2.1367 +
  2.1368 +LATEX_MAKEINDEX_CMD    = makeindex
  2.1369 +
  2.1370 +# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
  2.1371  # documents. This may be useful for small projects and may help to save some
  2.1372  # trees in general.
  2.1373  # The default value is: NO.
  2.1374 @@ -1585,39 +1938,57 @@
  2.1375  PAPER_TYPE             = a4
  2.1376  
  2.1377  # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
  2.1378 -# that should be included in the LaTeX output. To get the times font for
  2.1379 -# instance you can specify
  2.1380 -# EXTRA_PACKAGES=times
  2.1381 +# that should be included in the LaTeX output. The package can be specified just
  2.1382 +# by its name or with the correct syntax as to be used with the LaTeX
  2.1383 +# \usepackage command. To get the times font for instance you can specify :
  2.1384 +# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
  2.1385 +# To use the option intlimits with the amsmath package you can specify:
  2.1386 +# EXTRA_PACKAGES=[intlimits]{amsmath}
  2.1387  # If left blank no extra packages will be included.
  2.1388  # This tag requires that the tag GENERATE_LATEX is set to YES.
  2.1389  
  2.1390  EXTRA_PACKAGES         =
  2.1391  
  2.1392 -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
  2.1393 -# generated LaTeX document. The header should contain everything until the first
  2.1394 -# chapter. If it is left blank doxygen will generate a standard header. See
  2.1395 -# section "Doxygen usage" for information on how to let doxygen write the
  2.1396 -# default header to a separate file.
  2.1397 +# The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
  2.1398 +# the generated LaTeX document. The header should contain everything until the
  2.1399 +# first chapter. If it is left blank doxygen will generate a standard header. It
  2.1400 +# is highly recommended to start with a default header using
  2.1401 +# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
  2.1402 +# and then modify the file new_header.tex. See also section "Doxygen usage" for
  2.1403 +# information on how to generate the default header that doxygen normally uses.
  2.1404  #
  2.1405 -# Note: Only use a user-defined header if you know what you are doing! The
  2.1406 -# following commands have a special meaning inside the header: $title,
  2.1407 -# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
  2.1408 -# replace them by respectively the title of the page, the current date and time,
  2.1409 -# only the current date, the version number of doxygen, the project name (see
  2.1410 -# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
  2.1411 +# Note: Only use a user-defined header if you know what you are doing!
  2.1412 +# Note: The header is subject to change so you typically have to regenerate the
  2.1413 +# default header when upgrading to a newer version of doxygen. The following
  2.1414 +# commands have a special meaning inside the header (and footer): For a
  2.1415 +# description of the possible markers and block names see the documentation.
  2.1416  # This tag requires that the tag GENERATE_LATEX is set to YES.
  2.1417  
  2.1418  LATEX_HEADER           =
  2.1419  
  2.1420 -# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
  2.1421 -# generated LaTeX document. The footer should contain everything after the last
  2.1422 -# chapter. If it is left blank doxygen will generate a standard footer.
  2.1423 -#
  2.1424 -# Note: Only use a user-defined footer if you know what you are doing!
  2.1425 +# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
  2.1426 +# the generated LaTeX document. The footer should contain everything after the
  2.1427 +# last chapter. If it is left blank doxygen will generate a standard footer. See
  2.1428 +# LATEX_HEADER for more information on how to generate a default footer and what
  2.1429 +# special commands can be used inside the footer. See also section "Doxygen
  2.1430 +# usage" for information on how to generate the default footer that doxygen
  2.1431 +# normally uses. Note: Only use a user-defined footer if you know what you are
  2.1432 +# doing!
  2.1433  # This tag requires that the tag GENERATE_LATEX is set to YES.
  2.1434  
  2.1435  LATEX_FOOTER           =
  2.1436  
  2.1437 +# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
  2.1438 +# LaTeX style sheets that are included after the standard style sheets created
  2.1439 +# by doxygen. Using this option one can overrule certain style aspects. Doxygen
  2.1440 +# will copy the style sheet files to the output directory.
  2.1441 +# Note: The order of the extra style sheet files is of importance (e.g. the last
  2.1442 +# style sheet in the list overrules the setting of the previous ones in the
  2.1443 +# list).
  2.1444 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  2.1445 +
  2.1446 +LATEX_EXTRA_STYLESHEET =
  2.1447 +
  2.1448  # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
  2.1449  # other source files which should be copied to the LATEX_OUTPUT output
  2.1450  # directory. Note that the files will be copied as-is; there are no commands or
  2.1451 @@ -1635,9 +2006,11 @@
  2.1452  
  2.1453  PDF_HYPERLINKS         = YES
  2.1454  
  2.1455 -# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
  2.1456 -# the PDF file directly from the LaTeX files. Set this option to YES to get a
  2.1457 -# higher quality PDF documentation.
  2.1458 +# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
  2.1459 +# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
  2.1460 +# files. Set this option to YES, to get a higher quality PDF documentation.
  2.1461 +#
  2.1462 +# See also section LATEX_CMD_NAME for selecting the engine.
  2.1463  # The default value is: YES.
  2.1464  # This tag requires that the tag GENERATE_LATEX is set to YES.
  2.1465  
  2.1466 @@ -1645,8 +2018,7 @@
  2.1467  
  2.1468  # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
  2.1469  # command to the generated LaTeX files. This will instruct LaTeX to keep running
  2.1470 -# if errors occur, instead of asking the user for help. This option is also used
  2.1471 -# when generating formulas in HTML.
  2.1472 +# if errors occur, instead of asking the user for help.
  2.1473  # The default value is: NO.
  2.1474  # This tag requires that the tag GENERATE_LATEX is set to YES.
  2.1475  
  2.1476 @@ -1661,17 +2033,33 @@
  2.1477  
  2.1478  # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
  2.1479  # bibliography, e.g. plainnat, or ieeetr. See
  2.1480 -# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
  2.1481 +# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
  2.1482  # The default value is: plain.
  2.1483  # This tag requires that the tag GENERATE_LATEX is set to YES.
  2.1484  
  2.1485  LATEX_BIB_STYLE        = plain
  2.1486  
  2.1487 +# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
  2.1488 +# page will contain the date and time when the page was generated. Setting this
  2.1489 +# to NO can help when comparing the output of multiple runs.
  2.1490 +# The default value is: NO.
  2.1491 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  2.1492 +
  2.1493 +LATEX_TIMESTAMP        = NO
  2.1494 +
  2.1495 +# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
  2.1496 +# path from which the emoji images will be read. If a relative path is entered,
  2.1497 +# it will be relative to the LATEX_OUTPUT directory. If left blank the
  2.1498 +# LATEX_OUTPUT directory will be used.
  2.1499 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  2.1500 +
  2.1501 +LATEX_EMOJI_DIRECTORY  =
  2.1502 +
  2.1503  #---------------------------------------------------------------------------
  2.1504  # Configuration options related to the RTF output
  2.1505  #---------------------------------------------------------------------------
  2.1506  
  2.1507 -# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
  2.1508 +# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
  2.1509  # RTF output is optimized for Word 97 and may not look too pretty with other RTF
  2.1510  # readers/editors.
  2.1511  # The default value is: NO.
  2.1512 @@ -1686,7 +2074,7 @@
  2.1513  
  2.1514  RTF_OUTPUT             = rtf
  2.1515  
  2.1516 -# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
  2.1517 +# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
  2.1518  # documents. This may be useful for small projects and may help to save some
  2.1519  # trees in general.
  2.1520  # The default value is: NO.
  2.1521 @@ -1706,9 +2094,9 @@
  2.1522  
  2.1523  RTF_HYPERLINKS         = NO
  2.1524  
  2.1525 -# Load stylesheet definitions from file. Syntax is similar to doxygen's config
  2.1526 -# file, i.e. a series of assignments. You only have to provide replacements,
  2.1527 -# missing definitions are set to their default value.
  2.1528 +# Load stylesheet definitions from file. Syntax is similar to doxygen's
  2.1529 +# configuration file, i.e. a series of assignments. You only have to provide
  2.1530 +# replacements, missing definitions are set to their default value.
  2.1531  #
  2.1532  # See also section "Doxygen usage" for information on how to generate the
  2.1533  # default style sheet that doxygen normally uses.
  2.1534 @@ -1717,8 +2105,8 @@
  2.1535  RTF_STYLESHEET_FILE    =
  2.1536  
  2.1537  # Set optional variables used in the generation of an RTF document. Syntax is
  2.1538 -# similar to doxygen's config file. A template extensions file can be generated
  2.1539 -# using doxygen -e rtf extensionFile.
  2.1540 +# similar to doxygen's configuration file. A template extensions file can be
  2.1541 +# generated using doxygen -e rtf extensionFile.
  2.1542  # This tag requires that the tag GENERATE_RTF is set to YES.
  2.1543  
  2.1544  RTF_EXTENSIONS_FILE    =
  2.1545 @@ -1727,7 +2115,7 @@
  2.1546  # Configuration options related to the man page output
  2.1547  #---------------------------------------------------------------------------
  2.1548  
  2.1549 -# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
  2.1550 +# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
  2.1551  # classes and files.
  2.1552  # The default value is: NO.
  2.1553  
  2.1554 @@ -1771,7 +2159,7 @@
  2.1555  # Configuration options related to the XML output
  2.1556  #---------------------------------------------------------------------------
  2.1557  
  2.1558 -# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
  2.1559 +# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
  2.1560  # captures the structure of the code including all documentation.
  2.1561  # The default value is: NO.
  2.1562  
  2.1563 @@ -1785,7 +2173,7 @@
  2.1564  
  2.1565  XML_OUTPUT             = xml
  2.1566  
  2.1567 -# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
  2.1568 +# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
  2.1569  # listings (including syntax highlighting and cross-referencing information) to
  2.1570  # the XML output. Note that enabling this will significantly increase the size
  2.1571  # of the XML output.
  2.1572 @@ -1794,11 +2182,18 @@
  2.1573  
  2.1574  XML_PROGRAMLISTING     = YES
  2.1575  
  2.1576 +# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
  2.1577 +# namespace members in file scope as well, matching the HTML output.
  2.1578 +# The default value is: NO.
  2.1579 +# This tag requires that the tag GENERATE_XML is set to YES.
  2.1580 +
  2.1581 +XML_NS_MEMB_FILE_SCOPE = NO
  2.1582 +
  2.1583  #---------------------------------------------------------------------------
  2.1584  # Configuration options related to the DOCBOOK output
  2.1585  #---------------------------------------------------------------------------
  2.1586  
  2.1587 -# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
  2.1588 +# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
  2.1589  # that can be used to generate PDF.
  2.1590  # The default value is: NO.
  2.1591  
  2.1592 @@ -1816,10 +2211,10 @@
  2.1593  # Configuration options for the AutoGen Definitions output
  2.1594  #---------------------------------------------------------------------------
  2.1595  
  2.1596 -# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
  2.1597 -# Definitions (see http://autogen.sf.net) file that captures the structure of
  2.1598 -# the code including all documentation. Note that this feature is still
  2.1599 -# experimental and incomplete at the moment.
  2.1600 +# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
  2.1601 +# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
  2.1602 +# the structure of the code including all documentation. Note that this feature
  2.1603 +# is still experimental and incomplete at the moment.
  2.1604  # The default value is: NO.
  2.1605  
  2.1606  GENERATE_AUTOGEN_DEF   = NO
  2.1607 @@ -1828,7 +2223,7 @@
  2.1608  # Configuration options related to the Perl module output
  2.1609  #---------------------------------------------------------------------------
  2.1610  
  2.1611 -# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
  2.1612 +# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
  2.1613  # file that captures the structure of the code including all documentation.
  2.1614  #
  2.1615  # Note that this feature is still experimental and incomplete at the moment.
  2.1616 @@ -1836,7 +2231,7 @@
  2.1617  
  2.1618  GENERATE_PERLMOD       = NO
  2.1619  
  2.1620 -# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
  2.1621 +# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
  2.1622  # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
  2.1623  # output from the Perl module output.
  2.1624  # The default value is: NO.
  2.1625 @@ -1844,9 +2239,9 @@
  2.1626  
  2.1627  PERLMOD_LATEX          = NO
  2.1628  
  2.1629 -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
  2.1630 +# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
  2.1631  # formatted so it can be parsed by a human reader. This is useful if you want to
  2.1632 -# understand what is going on. On the other hand, if this tag is set to NO the
  2.1633 +# understand what is going on. On the other hand, if this tag is set to NO, the
  2.1634  # size of the Perl module output will be much smaller and Perl will parse it
  2.1635  # just the same.
  2.1636  # The default value is: YES.
  2.1637 @@ -1866,14 +2261,14 @@
  2.1638  # Configuration options related to the preprocessor
  2.1639  #---------------------------------------------------------------------------
  2.1640  
  2.1641 -# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
  2.1642 +# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
  2.1643  # C-preprocessor directives found in the sources and include files.
  2.1644  # The default value is: YES.
  2.1645  
  2.1646  ENABLE_PREPROCESSING   = YES
  2.1647  
  2.1648 -# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
  2.1649 -# in the source code. If set to NO only conditional compilation will be
  2.1650 +# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
  2.1651 +# in the source code. If set to NO, only conditional compilation will be
  2.1652  # performed. Macro expansion can be done in a controlled way by setting
  2.1653  # EXPAND_ONLY_PREDEF to YES.
  2.1654  # The default value is: NO.
  2.1655 @@ -1889,7 +2284,7 @@
  2.1656  
  2.1657  EXPAND_ONLY_PREDEF     = YES
  2.1658  
  2.1659 -# If the SEARCH_INCLUDES tag is set to YES the includes files in the
  2.1660 +# If the SEARCH_INCLUDES tag is set to YES, the include files in the
  2.1661  # INCLUDE_PATH will be searched if a #include is found.
  2.1662  # The default value is: YES.
  2.1663  # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  2.1664 @@ -1898,7 +2293,8 @@
  2.1665  
  2.1666  # The INCLUDE_PATH tag can be used to specify one or more directories that
  2.1667  # contain include files that are not input files but should be processed by the
  2.1668 -# preprocessor.
  2.1669 +# preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of
  2.1670 +# RECURSIVE has no effect here.
  2.1671  # This tag requires that the tag SEARCH_INCLUDES is set to YES.
  2.1672  
  2.1673  INCLUDE_PATH           =
  2.1674 @@ -1965,20 +2361,21 @@
  2.1675  
  2.1676  GENERATE_TAGFILE       =
  2.1677  
  2.1678 -# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
  2.1679 -# class index. If set to NO only the inherited external classes will be listed.
  2.1680 +# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
  2.1681 +# the class index. If set to NO, only the inherited external classes will be
  2.1682 +# listed.
  2.1683  # The default value is: NO.
  2.1684  
  2.1685  ALLEXTERNALS           = NO
  2.1686  
  2.1687 -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
  2.1688 -# the modules index. If set to NO, only the current project's groups will be
  2.1689 +# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
  2.1690 +# in the modules index. If set to NO, only the current project's groups will be
  2.1691  # listed.
  2.1692  # The default value is: YES.
  2.1693  
  2.1694  EXTERNAL_GROUPS        = YES
  2.1695  
  2.1696 -# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
  2.1697 +# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
  2.1698  # the related pages index. If set to NO, only the current project's pages will
  2.1699  # be listed.
  2.1700  # The default value is: YES.
  2.1701 @@ -1996,7 +2393,7 @@
  2.1702  
  2.1703  DIA_PATH               =
  2.1704  
  2.1705 -# If set to YES, the inheritance and collaboration graphs will hide inheritance
  2.1706 +# If set to YES the inheritance and collaboration graphs will hide inheritance
  2.1707  # and usage relations if the target is undocumented or is not a class.
  2.1708  # The default value is: YES.
  2.1709  
  2.1710 @@ -2007,7 +2404,7 @@
  2.1711  # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
  2.1712  # Bell Labs. The other options in this section have no effect if this option is
  2.1713  # set to NO
  2.1714 -# The default value is: YES.
  2.1715 +# The default value is: NO.
  2.1716  
  2.1717  HAVE_DOT               = NO
  2.1718  
  2.1719 @@ -2021,35 +2418,50 @@
  2.1720  
  2.1721  DOT_NUM_THREADS        = 0
  2.1722  
  2.1723 -# When you want a differently looking font n the dot files that doxygen
  2.1724 -# generates you can specify the font name using DOT_FONTNAME. You need to make
  2.1725 -# sure dot is able to find the font, which can be done by putting it in a
  2.1726 -# standard location or by setting the DOTFONTPATH environment variable or by
  2.1727 -# setting DOT_FONTPATH to the directory containing the font.
  2.1728 -# The default value is: Helvetica.
  2.1729 +# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of
  2.1730 +# subgraphs. When you want a differently looking font in the dot files that
  2.1731 +# doxygen generates you can specify fontname, fontcolor and fontsize attributes.
  2.1732 +# For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node,
  2.1733 +# Edge and Graph Attributes specification</a> You need to make sure dot is able
  2.1734 +# to find the font, which can be done by putting it in a standard location or by
  2.1735 +# setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
  2.1736 +# directory containing the font. Default graphviz fontsize is 14.
  2.1737 +# The default value is: fontname=Helvetica,fontsize=10.
  2.1738  # This tag requires that the tag HAVE_DOT is set to YES.
  2.1739  
  2.1740 -DOT_FONTNAME           = Helvetica
  2.1741 -
  2.1742 -# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
  2.1743 -# dot graphs.
  2.1744 -# Minimum value: 4, maximum value: 24, default value: 10.
  2.1745 +DOT_COMMON_ATTR        = "fontname=Helvetica,fontsize=10"
  2.1746 +
  2.1747 +# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can
  2.1748 +# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a
  2.1749 +# href=https://graphviz.org/doc/info/arrows.html>Complete documentation about
  2.1750 +# arrows shapes.</a>
  2.1751 +# The default value is: labelfontname=Helvetica,labelfontsize=10.
  2.1752  # This tag requires that the tag HAVE_DOT is set to YES.
  2.1753  
  2.1754 -DOT_FONTSIZE           = 10
  2.1755 -
  2.1756 -# By default doxygen will tell dot to use the default font as specified with
  2.1757 -# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
  2.1758 -# the path where dot can find it using this tag.
  2.1759 +DOT_EDGE_ATTR          = "labelfontname=Helvetica,labelfontsize=10"
  2.1760 +
  2.1761 +# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes
  2.1762 +# around nodes set 'shape=plain' or 'shape=plaintext' <a
  2.1763 +# href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a>
  2.1764 +# The default value is: shape=box,height=0.2,width=0.4.
  2.1765  # This tag requires that the tag HAVE_DOT is set to YES.
  2.1766  
  2.1767 +DOT_NODE_ATTR          = "shape=box,height=0.2,width=0.4"
  2.1768 +
  2.1769 +# You can set the path where dot can find font specified with fontname in
  2.1770 +# DOT_COMMON_ATTR and others dot attributes.
  2.1771 +# This tag requires that the tag HAVE_DOT is set to YES.
  2.1772 +
  2.1773  DOT_FONTPATH           =
  2.1774  
  2.1775 -# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
  2.1776 -# each documented class showing the direct and indirect inheritance relations.
  2.1777 -# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
  2.1778 +# If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a
  2.1779 +# graph for each documented class showing the direct and indirect inheritance
  2.1780 +# relations. In case HAVE_DOT is set as well dot will be used to draw the graph,
  2.1781 +# otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set
  2.1782 +# to TEXT the direct and indirect inheritance relations will be shown as texts /
  2.1783 +# links.
  2.1784 +# Possible values are: NO, YES, TEXT and GRAPH.
  2.1785  # The default value is: YES.
  2.1786 -# This tag requires that the tag HAVE_DOT is set to YES.
  2.1787  
  2.1788  CLASS_GRAPH            = YES
  2.1789  
  2.1790 @@ -2063,13 +2475,14 @@
  2.1791  COLLABORATION_GRAPH    = YES
  2.1792  
  2.1793  # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
  2.1794 -# groups, showing the direct groups dependencies.
  2.1795 +# groups, showing the direct groups dependencies. See also the chapter Grouping
  2.1796 +# in the manual.
  2.1797  # The default value is: YES.
  2.1798  # This tag requires that the tag HAVE_DOT is set to YES.
  2.1799  
  2.1800  GROUP_GRAPHS           = YES
  2.1801  
  2.1802 -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
  2.1803 +# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
  2.1804  # collaboration diagrams in a style similar to the OMG's Unified Modeling
  2.1805  # Language.
  2.1806  # The default value is: NO.
  2.1807 @@ -2086,9 +2499,31 @@
  2.1808  # but if the number exceeds 15, the total amount of fields shown is limited to
  2.1809  # 10.
  2.1810  # Minimum value: 0, maximum value: 100, default value: 10.
  2.1811 +# This tag requires that the tag UML_LOOK is set to YES.
  2.1812 +
  2.1813 +UML_LIMIT_NUM_FIELDS   = 10
  2.1814 +
  2.1815 +# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
  2.1816 +# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
  2.1817 +# tag is set to YES, doxygen will add type and arguments for attributes and
  2.1818 +# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
  2.1819 +# will not generate fields with class member information in the UML graphs. The
  2.1820 +# class diagrams will look similar to the default class diagrams but using UML
  2.1821 +# notation for the relationships.
  2.1822 +# Possible values are: NO, YES and NONE.
  2.1823 +# The default value is: NO.
  2.1824 +# This tag requires that the tag UML_LOOK is set to YES.
  2.1825 +
  2.1826 +DOT_UML_DETAILS        = NO
  2.1827 +
  2.1828 +# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
  2.1829 +# to display on a single line. If the actual line length exceeds this threshold
  2.1830 +# significantly it will wrapped across multiple lines. Some heuristics are apply
  2.1831 +# to avoid ugly line breaks.
  2.1832 +# Minimum value: 0, maximum value: 1000, default value: 17.
  2.1833  # This tag requires that the tag HAVE_DOT is set to YES.
  2.1834  
  2.1835 -UML_LIMIT_NUM_FIELDS   = 10
  2.1836 +DOT_WRAP_THRESHOLD     = 17
  2.1837  
  2.1838  # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
  2.1839  # collaboration graphs will show the relations between templates and their
  2.1840 @@ -2121,7 +2556,8 @@
  2.1841  #
  2.1842  # Note that enabling this option will significantly increase the time of a run.
  2.1843  # So in most cases it will be better to enable call graphs for selected
  2.1844 -# functions only using the \callgraph command.
  2.1845 +# functions only using the \callgraph command. Disabling a call graph can be
  2.1846 +# accomplished by means of the command \hidecallgraph.
  2.1847  # The default value is: NO.
  2.1848  # This tag requires that the tag HAVE_DOT is set to YES.
  2.1849  
  2.1850 @@ -2132,7 +2568,8 @@
  2.1851  #
  2.1852  # Note that enabling this option will significantly increase the time of a run.
  2.1853  # So in most cases it will be better to enable caller graphs for selected
  2.1854 -# functions only using the \callergraph command.
  2.1855 +# functions only using the \callergraph command. Disabling a caller graph can be
  2.1856 +# accomplished by means of the command \hidecallergraph.
  2.1857  # The default value is: NO.
  2.1858  # This tag requires that the tag HAVE_DOT is set to YES.
  2.1859  
  2.1860 @@ -2154,14 +2591,23 @@
  2.1861  
  2.1862  DIRECTORY_GRAPH        = YES
  2.1863  
  2.1864 +# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels
  2.1865 +# of child directories generated in directory dependency graphs by dot.
  2.1866 +# Minimum value: 1, maximum value: 25, default value: 1.
  2.1867 +# This tag requires that the tag DIRECTORY_GRAPH is set to YES.
  2.1868 +
  2.1869 +DIR_GRAPH_MAX_DEPTH    = 1
  2.1870 +
  2.1871  # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
  2.1872 -# generated by dot.
  2.1873 +# generated by dot. For an explanation of the image formats see the section
  2.1874 +# output formats in the documentation of the dot tool (Graphviz (see:
  2.1875 +# http://www.graphviz.org/)).
  2.1876  # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
  2.1877  # to make the SVG files visible in IE 9+ (other browsers do not have this
  2.1878  # requirement).
  2.1879 -# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
  2.1880 -# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
  2.1881 -# gif:cairo:gd, gif:gd, gif:gd:gd and svg.
  2.1882 +# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
  2.1883 +# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
  2.1884 +# png:gdiplus:gdiplus.
  2.1885  # The default value is: png.
  2.1886  # This tag requires that the tag HAVE_DOT is set to YES.
  2.1887  
  2.1888 @@ -2204,6 +2650,24 @@
  2.1889  
  2.1890  DIAFILE_DIRS           =
  2.1891  
  2.1892 +# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
  2.1893 +# path where java can find the plantuml.jar file or to the filename of jar file
  2.1894 +# to be used. If left blank, it is assumed PlantUML is not used or called during
  2.1895 +# a preprocessing step. Doxygen will generate a warning when it encounters a
  2.1896 +# \startuml command in this case and will not generate output for the diagram.
  2.1897 +
  2.1898 +PLANTUML_JAR_PATH      =
  2.1899 +
  2.1900 +# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
  2.1901 +# configuration file for plantuml.
  2.1902 +
  2.1903 +PLANTUML_CFG_FILE      =
  2.1904 +
  2.1905 +# When using plantuml, the specified paths are searched for files specified by
  2.1906 +# the !include statement in a plantuml block.
  2.1907 +
  2.1908 +PLANTUML_INCLUDE_PATH  =
  2.1909 +
  2.1910  # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
  2.1911  # that will be shown in the graph. If the number of nodes in a graph becomes
  2.1912  # larger than this value, doxygen will truncate the graph, which is visualized
  2.1913 @@ -2228,19 +2692,7 @@
  2.1914  
  2.1915  MAX_DOT_GRAPH_DEPTH    = 0
  2.1916  
  2.1917 -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
  2.1918 -# background. This is disabled by default, because dot on Windows does not seem
  2.1919 -# to support this out of the box.
  2.1920 -#
  2.1921 -# Warning: Depending on the platform used, enabling this option may lead to
  2.1922 -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
  2.1923 -# read).
  2.1924 -# The default value is: NO.
  2.1925 -# This tag requires that the tag HAVE_DOT is set to YES.
  2.1926 -
  2.1927 -DOT_TRANSPARENT        = NO
  2.1928 -
  2.1929 -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
  2.1930 +# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
  2.1931  # files in one run (i.e. multiple -o and -T options on the command line). This
  2.1932  # makes dot run faster, but since only newer versions of dot (>1.8.10) support
  2.1933  # this, this feature is disabled by default.
  2.1934 @@ -2252,14 +2704,18 @@
  2.1935  # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
  2.1936  # explaining the meaning of the various boxes and arrows in the dot generated
  2.1937  # graphs.
  2.1938 +# Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal
  2.1939 +# graphical representation for inheritance and collaboration diagrams is used.
  2.1940  # The default value is: YES.
  2.1941  # This tag requires that the tag HAVE_DOT is set to YES.
  2.1942  
  2.1943  GENERATE_LEGEND        = YES
  2.1944  
  2.1945 -# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
  2.1946 +# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
  2.1947  # files that are used to generate the various graphs.
  2.1948 +#
  2.1949 +# Note: This setting is not only used for dot files but also for msc temporary
  2.1950 +# files.
  2.1951  # The default value is: YES.
  2.1952 -# This tag requires that the tag HAVE_DOT is set to YES.
  2.1953  
  2.1954  DOT_CLEANUP            = YES