libgnunetchat

library for GNUnet Messenger
Log | Files | Refs | README | LICENSE

Doxyfile (131024B)


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