acid-drop

- Hacking the planet from a LilyGo T-Deck using custom firmware
git clone git://git.acid.vegas/acid-drop.git
Log | Files | Refs | Archive | README | LICENSE

Doxyfile (112064B)

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