Warning, /graphics/glaxnimate/data/lib/python-lottie/docs/Doxyfile.in is written in an unsupported language. File is not indexed.

0001 # Doxyfile 1.8.17
0002 
0003 # This file describes the settings to be used by the documentation system
0004 # doxygen (www.doxygen.org) for a project.
0005 #
0006 # All text after a double hash (##) is considered a comment and is placed in
0007 # front of the TAG it is preceding.
0008 #
0009 # All text after a single hash (#) is considered a comment and will be ignored.
0010 # The format is:
0011 # TAG = value [value, ...]
0012 # For lists, items can also be appended using:
0013 # TAG += value [value, ...]
0014 # Values that contain spaces should be placed between quotes (\" \").
0015 
0016 #---------------------------------------------------------------------------
0017 # Project related configuration options
0018 #---------------------------------------------------------------------------
0019 
0020 # This tag specifies the encoding used for all characters in the configuration
0021 # file that follow. The default is UTF-8 which is also the encoding used for all
0022 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
0023 # iconv built into libc) for the transcoding. See
0024 # https://www.gnu.org/software/libiconv/ for the list of possible encodings.
0025 # The default value is: UTF-8.
0026 
0027 DOXYFILE_ENCODING      = UTF-8
0028 
0029 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
0030 # double-quotes, unless you are using Doxywizard) that should identify the
0031 # project for which the documentation is generated. This name is used in the
0032 # title of most generated pages and in a few other places.
0033 # The default value is: My Project.
0034 
0035 PROJECT_NAME           = "M4_NAME"
0036 
0037 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
0038 # could be handy for archiving the generated documentation or if some version
0039 # control system is used.
0040 
0041 PROJECT_NUMBER         = "M4_VERSION"
0042 
0043 # Using the PROJECT_BRIEF tag one can provide an optional one line description
0044 # for a project that appears at the top of each page and should give viewer a
0045 # quick idea about the purpose of the project. Keep the description short.
0046 
0047 PROJECT_BRIEF          = "M4_DESCRIPTION"
0048 
0049 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
0050 # in the documentation. The maximum height of the logo should not exceed 55
0051 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
0052 # the logo to the output directory.
0053 
0054 PROJECT_LOGO           =
0055 
0056 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
0057 # into which the generated documentation will be written. If a relative path is
0058 # entered, it will be relative to the location where doxygen was started. If
0059 # left blank the current directory will be used.
0060 
0061 OUTPUT_DIRECTORY       =
0062 
0063 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
0064 # directories (in 2 levels) under the output directory of each output format and
0065 # will distribute the generated files over these directories. Enabling this
0066 # option can be useful when feeding doxygen a huge amount of source files, where
0067 # putting all generated files in the same directory would otherwise causes
0068 # performance problems for the file system.
0069 # The default value is: NO.
0070 
0071 CREATE_SUBDIRS         = NO
0072 
0073 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
0074 # characters to appear in the names of generated files. If set to NO, non-ASCII
0075 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
0076 # U+3044.
0077 # The default value is: NO.
0078 
0079 ALLOW_UNICODE_NAMES    = NO
0080 
0081 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
0082 # documentation generated by doxygen is written. Doxygen will use this
0083 # information to generate all constant output in the proper language.
0084 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
0085 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
0086 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
0087 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
0088 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
0089 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
0090 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
0091 # Ukrainian and Vietnamese.
0092 # The default value is: English.
0093 
0094 OUTPUT_LANGUAGE        = English
0095 
0096 # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
0097 # documentation generated by doxygen is written. Doxygen will use this
0098 # information to generate all generated output in the proper direction.
0099 # Possible values are: None, LTR, RTL and Context.
0100 # The default value is: None.
0101 
0102 OUTPUT_TEXT_DIRECTION  = None
0103 
0104 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
0105 # descriptions after the members that are listed in the file and class
0106 # documentation (similar to Javadoc). Set to NO to disable this.
0107 # The default value is: YES.
0108 
0109 BRIEF_MEMBER_DESC      = YES
0110 
0111 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
0112 # description of a member or function before the detailed description
0113 #
0114 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
0115 # brief descriptions will be completely suppressed.
0116 # The default value is: YES.
0117 
0118 REPEAT_BRIEF           = YES
0119 
0120 # This tag implements a quasi-intelligent brief description abbreviator that is
0121 # used to form the text in various listings. Each string in this list, if found
0122 # as the leading text of the brief description, will be stripped from the text
0123 # and the result, after processing the whole list, is used as the annotated
0124 # text. Otherwise, the brief description is used as-is. If left blank, the
0125 # following values are used ($name is automatically replaced with the name of
0126 # the entity):The $name class, The $name widget, The $name file, is, provides,
0127 # specifies, contains, represents, a, an and the.
0128 
0129 ABBREVIATE_BRIEF       = "The $name class" \
0130                          "The $name widget" \
0131                          "The $name file" \
0132                          is \
0133                          provides \
0134                          specifies \
0135                          contains \
0136                          represents \
0137                          a \
0138                          an \
0139                          the
0140 
0141 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
0142 # doxygen will generate a detailed section even if there is only a brief
0143 # description.
0144 # The default value is: NO.
0145 
0146 ALWAYS_DETAILED_SEC    = NO
0147 
0148 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
0149 # inherited members of a class in the documentation of that class as if those
0150 # members were ordinary class members. Constructors, destructors and assignment
0151 # operators of the base classes will not be shown.
0152 # The default value is: NO.
0153 
0154 INLINE_INHERITED_MEMB  = NO
0155 
0156 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
0157 # before files name in the file list and in the header files. If set to NO the
0158 # shortest path that makes the file name unique will be used
0159 # The default value is: YES.
0160 
0161 FULL_PATH_NAMES        = YES
0162 
0163 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
0164 # Stripping is only done if one of the specified strings matches the left-hand
0165 # part of the path. The tag can be used to show relative paths in the file list.
0166 # If left blank the directory from which doxygen is run is used as the path to
0167 # strip.
0168 #
0169 # Note that you can specify absolute paths here, but also relative paths, which
0170 # will be relative from the directory where doxygen is started.
0171 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
0172 
0173 STRIP_FROM_PATH        = ./lib/
0174 
0175 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
0176 # path mentioned in the documentation of a class, which tells the reader which
0177 # header file to include in order to use a class. If left blank only the name of
0178 # the header file containing the class definition is used. Otherwise one should
0179 # specify the list of include paths that are normally passed to the compiler
0180 # using the -I flag.
0181 
0182 STRIP_FROM_INC_PATH    =
0183 
0184 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
0185 # less readable) file names. This can be useful is your file systems doesn't
0186 # support long names like on DOS, Mac, or CD-ROM.
0187 # The default value is: NO.
0188 
0189 SHORT_NAMES            = NO
0190 
0191 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
0192 # first line (until the first dot) of a Javadoc-style comment as the brief
0193 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
0194 # style comments (thus requiring an explicit @brief command for a brief
0195 # description.)
0196 # The default value is: NO.
0197 
0198 JAVADOC_AUTOBRIEF      = NO
0199 
0200 # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
0201 # such as
0202 # /***************
0203 # as being the beginning of a Javadoc-style comment "banner". If set to NO, the
0204 # Javadoc-style will behave just like regular comments and it will not be
0205 # interpreted by doxygen.
0206 # The default value is: NO.
0207 
0208 JAVADOC_BANNER         = NO
0209 
0210 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
0211 # line (until the first dot) of a Qt-style comment as the brief description. If
0212 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
0213 # requiring an explicit \brief command for a brief description.)
0214 # The default value is: NO.
0215 
0216 QT_AUTOBRIEF           = NO
0217 
0218 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
0219 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
0220 # a brief description. This used to be the default behavior. The new default is
0221 # to treat a multi-line C++ comment block as a detailed description. Set this
0222 # tag to YES if you prefer the old behavior instead.
0223 #
0224 # Note that setting this tag to YES also means that rational rose comments are
0225 # not recognized any more.
0226 # The default value is: NO.
0227 
0228 MULTILINE_CPP_IS_BRIEF = NO
0229 
0230 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
0231 # documentation from any documented member that it re-implements.
0232 # The default value is: YES.
0233 
0234 INHERIT_DOCS           = YES
0235 
0236 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
0237 # page for each member. If set to NO, the documentation of a member will be part
0238 # of the file/class/namespace that contains it.
0239 # The default value is: NO.
0240 
0241 SEPARATE_MEMBER_PAGES  = NO
0242 
0243 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
0244 # uses this value to replace tabs by spaces in code fragments.
0245 # Minimum value: 1, maximum value: 16, default value: 4.
0246 
0247 TAB_SIZE               = 4
0248 
0249 # This tag can be used to specify a number of aliases that act as commands in
0250 # the documentation. An alias has the form:
0251 # name=value
0252 # For example adding
0253 # "sideeffect=@par Side Effects:\n"
0254 # will allow you to put the command \sideeffect (or @sideeffect) in the
0255 # documentation, which will result in a user-defined paragraph with heading
0256 # "Side Effects:". You can put \n's in the value part of an alias to insert
0257 # newlines (in the resulting output). You can put ^^ in the value part of an
0258 # alias to insert a newline as if a physical newline was in the original file.
0259 # When you need a literal { or } or , in the value part of an alias you have to
0260 # escape them by means of a backslash (\), this can lead to conflicts with the
0261 # commands \{ and \} for these it is advised to use the version @{ and @} or use
0262 # a double escape (\\{ and \\})
0263 
0264 ALIASES                = "lottie=\par Lottie Name:\n"
0265 
0266 # This tag can be used to specify a number of word-keyword mappings (TCL only).
0267 # A mapping has the form "name=value". For example adding "class=itcl::class"
0268 # will allow you to use the command class in the itcl::class meaning.
0269 
0270 TCL_SUBST              =
0271 
0272 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
0273 # only. Doxygen will then generate output that is more tailored for C. For
0274 # instance, some of the names that are used will be different. The list of all
0275 # members will be omitted, etc.
0276 # The default value is: NO.
0277 
0278 OPTIMIZE_OUTPUT_FOR_C  = NO
0279 
0280 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
0281 # Python sources only. Doxygen will then generate output that is more tailored
0282 # for that language. For instance, namespaces will be presented as packages,
0283 # qualified scopes will look different, etc.
0284 # The default value is: NO.
0285 
0286 OPTIMIZE_OUTPUT_JAVA   = YES
0287 
0288 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
0289 # sources. Doxygen will then generate output that is tailored for Fortran.
0290 # The default value is: NO.
0291 
0292 OPTIMIZE_FOR_FORTRAN   = NO
0293 
0294 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
0295 # sources. Doxygen will then generate output that is tailored for VHDL.
0296 # The default value is: NO.
0297 
0298 OPTIMIZE_OUTPUT_VHDL   = NO
0299 
0300 # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
0301 # sources only. Doxygen will then generate output that is more tailored for that
0302 # language. For instance, namespaces will be presented as modules, types will be
0303 # separated into more groups, etc.
0304 # The default value is: NO.
0305 
0306 OPTIMIZE_OUTPUT_SLICE  = NO
0307 
0308 # Doxygen selects the parser to use depending on the extension of the files it
0309 # parses. With this tag you can assign which parser to use for a given
0310 # extension. Doxygen has a built-in mapping, but you can override or extend it
0311 # using this tag. The format is ext=language, where ext is a file extension, and
0312 # language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
0313 # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice,
0314 # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
0315 # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
0316 # tries to guess whether the code is fixed or free formatted code, this is the
0317 # default for Fortran type files), VHDL, tcl. For instance to make doxygen treat
0318 # .inc files as Fortran files (default is PHP), and .f files as C (default is
0319 # Fortran), use: inc=Fortran f=C.
0320 #
0321 # Note: For files without extension you can use no_extension as a placeholder.
0322 #
0323 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
0324 # the files are not read by doxygen.
0325 
0326 EXTENSION_MAPPING      =
0327 
0328 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
0329 # according to the Markdown format, which allows for more readable
0330 # documentation. See https://daringfireball.net/projects/markdown/ for details.
0331 # The output of markdown processing is further processed by doxygen, so you can
0332 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
0333 # case of backward compatibilities issues.
0334 # The default value is: YES.
0335 
0336 MARKDOWN_SUPPORT       = YES
0337 
0338 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
0339 # to that level are automatically included in the table of contents, even if
0340 # they do not have an id attribute.
0341 # Note: This feature currently applies only to Markdown headings.
0342 # Minimum value: 0, maximum value: 99, default value: 5.
0343 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
0344 
0345 TOC_INCLUDE_HEADINGS   = 0
0346 
0347 # When enabled doxygen tries to link words that correspond to documented
0348 # classes, or namespaces to their corresponding documentation. Such a link can
0349 # be prevented in individual cases by putting a % sign in front of the word or
0350 # globally by setting AUTOLINK_SUPPORT to NO.
0351 # The default value is: YES.
0352 
0353 AUTOLINK_SUPPORT       = YES
0354 
0355 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
0356 # to include (a tag file for) the STL sources as input, then you should set this
0357 # tag to YES in order to let doxygen match functions declarations and
0358 # definitions whose arguments contain STL classes (e.g. func(std::string);
0359 # versus func(std::string) {}). This also make the inheritance and collaboration
0360 # diagrams that involve STL classes more complete and accurate.
0361 # The default value is: NO.
0362 
0363 BUILTIN_STL_SUPPORT    = NO
0364 
0365 # If you use Microsoft's C++/CLI language, you should set this option to YES to
0366 # enable parsing support.
0367 # The default value is: NO.
0368 
0369 CPP_CLI_SUPPORT        = NO
0370 
0371 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
0372 # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
0373 # will parse them like normal C++ but will assume all classes use public instead
0374 # of private inheritance when no explicit protection keyword is present.
0375 # The default value is: NO.
0376 
0377 SIP_SUPPORT            = NO
0378 
0379 # For Microsoft's IDL there are propget and propput attributes to indicate
0380 # getter and setter methods for a property. Setting this option to YES will make
0381 # doxygen to replace the get and set methods by a property in the documentation.
0382 # This will only work if the methods are indeed getting or setting a simple
0383 # type. If this is not the case, or you want to show the methods anyway, you
0384 # should set this option to NO.
0385 # The default value is: YES.
0386 
0387 IDL_PROPERTY_SUPPORT   = YES
0388 
0389 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
0390 # tag is set to YES then doxygen will reuse the documentation of the first
0391 # member in the group (if any) for the other members of the group. By default
0392 # all members of a group must be documented explicitly.
0393 # The default value is: NO.
0394 
0395 DISTRIBUTE_GROUP_DOC   = NO
0396 
0397 # If one adds a struct or class to a group and this option is enabled, then also
0398 # any nested class or struct is added to the same group. By default this option
0399 # is disabled and one has to add nested compounds explicitly via \ingroup.
0400 # The default value is: NO.
0401 
0402 GROUP_NESTED_COMPOUNDS = NO
0403 
0404 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
0405 # (for instance a group of public functions) to be put as a subgroup of that
0406 # type (e.g. under the Public Functions section). Set it to NO to prevent
0407 # subgrouping. Alternatively, this can be done per class using the
0408 # \nosubgrouping command.
0409 # The default value is: YES.
0410 
0411 SUBGROUPING            = YES
0412 
0413 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
0414 # are shown inside the group in which they are included (e.g. using \ingroup)
0415 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
0416 # and RTF).
0417 #
0418 # Note that this feature does not work in combination with
0419 # SEPARATE_MEMBER_PAGES.
0420 # The default value is: NO.
0421 
0422 INLINE_GROUPED_CLASSES = NO
0423 
0424 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
0425 # with only public data fields or simple typedef fields will be shown inline in
0426 # the documentation of the scope in which they are defined (i.e. file,
0427 # namespace, or group documentation), provided this scope is documented. If set
0428 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
0429 # Man pages) or section (for LaTeX and RTF).
0430 # The default value is: NO.
0431 
0432 INLINE_SIMPLE_STRUCTS  = NO
0433 
0434 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
0435 # enum is documented as struct, union, or enum with the name of the typedef. So
0436 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
0437 # with name TypeT. When disabled the typedef will appear as a member of a file,
0438 # namespace, or class. And the struct will be named TypeS. This can typically be
0439 # useful for C code in case the coding convention dictates that all compound
0440 # types are typedef'ed and only the typedef is referenced, never the tag name.
0441 # The default value is: NO.
0442 
0443 TYPEDEF_HIDES_STRUCT   = NO
0444 
0445 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
0446 # cache is used to resolve symbols given their name and scope. Since this can be
0447 # an expensive process and often the same symbol appears multiple times in the
0448 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
0449 # doxygen will become slower. If the cache is too large, memory is wasted. The
0450 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
0451 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
0452 # symbols. At the end of a run doxygen will report the cache usage and suggest
0453 # the optimal cache size from a speed point of view.
0454 # Minimum value: 0, maximum value: 9, default value: 0.
0455 
0456 LOOKUP_CACHE_SIZE      = 0
0457 
0458 #---------------------------------------------------------------------------
0459 # Build related configuration options
0460 #---------------------------------------------------------------------------
0461 
0462 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
0463 # documentation are documented, even if no documentation was available. Private
0464 # class members and static file members will be hidden unless the
0465 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
0466 # Note: This will also disable the warnings about undocumented members that are
0467 # normally produced when WARNINGS is set to YES.
0468 # The default value is: NO.
0469 
0470 EXTRACT_ALL            = YES
0471 
0472 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
0473 # be included in the documentation.
0474 # The default value is: NO.
0475 
0476 EXTRACT_PRIVATE        = NO
0477 
0478 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
0479 # methods of a class will be included in the documentation.
0480 # The default value is: NO.
0481 
0482 EXTRACT_PRIV_VIRTUAL   = NO
0483 
0484 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
0485 # scope will be included in the documentation.
0486 # The default value is: NO.
0487 
0488 EXTRACT_PACKAGE        = NO
0489 
0490 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
0491 # included in the documentation.
0492 # The default value is: NO.
0493 
0494 EXTRACT_STATIC         = NO
0495 
0496 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
0497 # locally in source files will be included in the documentation. If set to NO,
0498 # only classes defined in header files are included. Does not have any effect
0499 # for Java sources.
0500 # The default value is: YES.
0501 
0502 EXTRACT_LOCAL_CLASSES  = YES
0503 
0504 # This flag is only useful for Objective-C code. If set to YES, local methods,
0505 # which are defined in the implementation section but not in the interface are
0506 # included in the documentation. If set to NO, only methods in the interface are
0507 # included.
0508 # The default value is: NO.
0509 
0510 EXTRACT_LOCAL_METHODS  = NO
0511 
0512 # If this flag is set to YES, the members of anonymous namespaces will be
0513 # extracted and appear in the documentation as a namespace called
0514 # 'anonymous_namespace{file}', where file will be replaced with the base name of
0515 # the file that contains the anonymous namespace. By default anonymous namespace
0516 # are hidden.
0517 # The default value is: NO.
0518 
0519 EXTRACT_ANON_NSPACES   = NO
0520 
0521 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
0522 # undocumented members inside documented classes or files. If set to NO these
0523 # members will be included in the various overviews, but no documentation
0524 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
0525 # The default value is: NO.
0526 
0527 HIDE_UNDOC_MEMBERS     = NO
0528 
0529 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
0530 # undocumented classes that are normally visible in the class hierarchy. If set
0531 # to NO, these classes will be included in the various overviews. This option
0532 # has no effect if EXTRACT_ALL is enabled.
0533 # The default value is: NO.
0534 
0535 HIDE_UNDOC_CLASSES     = NO
0536 
0537 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
0538 # declarations. If set to NO, these declarations will be included in the
0539 # documentation.
0540 # The default value is: NO.
0541 
0542 HIDE_FRIEND_COMPOUNDS  = NO
0543 
0544 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
0545 # documentation blocks found inside the body of a function. If set to NO, these
0546 # blocks will be appended to the function's detailed documentation block.
0547 # The default value is: NO.
0548 
0549 HIDE_IN_BODY_DOCS      = NO
0550 
0551 # The INTERNAL_DOCS tag determines if documentation that is typed after a
0552 # \internal command is included. If the tag is set to NO then the documentation
0553 # will be excluded. Set it to YES to include the internal documentation.
0554 # The default value is: NO.
0555 
0556 INTERNAL_DOCS          = NO
0557 
0558 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
0559 # names in lower-case letters. If set to YES, upper-case letters are also
0560 # allowed. This is useful if you have classes or files whose names only differ
0561 # in case and if your file system supports case sensitive file names. Windows
0562 # (including Cygwin) ands Mac users are advised to set this option to NO.
0563 # The default value is: system dependent.
0564 
0565 CASE_SENSE_NAMES       = YES
0566 
0567 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
0568 # their full class and namespace scopes in the documentation. If set to YES, the
0569 # scope will be hidden.
0570 # The default value is: NO.
0571 
0572 HIDE_SCOPE_NAMES       = NO
0573 
0574 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
0575 # append additional text to a page's title, such as Class Reference. If set to
0576 # YES the compound reference will be hidden.
0577 # The default value is: NO.
0578 
0579 HIDE_COMPOUND_REFERENCE= NO
0580 
0581 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
0582 # the files that are included by a file in the documentation of that file.
0583 # The default value is: YES.
0584 
0585 SHOW_INCLUDE_FILES     = YES
0586 
0587 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
0588 # grouped member an include statement to the documentation, telling the reader
0589 # which file to include in order to use the member.
0590 # The default value is: NO.
0591 
0592 SHOW_GROUPED_MEMB_INC  = NO
0593 
0594 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
0595 # files with double quotes in the documentation rather than with sharp brackets.
0596 # The default value is: NO.
0597 
0598 FORCE_LOCAL_INCLUDES   = NO
0599 
0600 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
0601 # documentation for inline members.
0602 # The default value is: YES.
0603 
0604 INLINE_INFO            = YES
0605 
0606 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
0607 # (detailed) documentation of file and class members alphabetically by member
0608 # name. If set to NO, the members will appear in declaration order.
0609 # The default value is: YES.
0610 
0611 SORT_MEMBER_DOCS       = YES
0612 
0613 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
0614 # descriptions of file, namespace and class members alphabetically by member
0615 # name. If set to NO, the members will appear in declaration order. Note that
0616 # this will also influence the order of the classes in the class list.
0617 # The default value is: NO.
0618 
0619 SORT_BRIEF_DOCS        = NO
0620 
0621 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
0622 # (brief and detailed) documentation of class members so that constructors and
0623 # destructors are listed first. If set to NO the constructors will appear in the
0624 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
0625 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
0626 # member documentation.
0627 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
0628 # detailed member documentation.
0629 # The default value is: NO.
0630 
0631 SORT_MEMBERS_CTORS_1ST = NO
0632 
0633 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
0634 # of group names into alphabetical order. If set to NO the group names will
0635 # appear in their defined order.
0636 # The default value is: NO.
0637 
0638 SORT_GROUP_NAMES       = NO
0639 
0640 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
0641 # fully-qualified names, including namespaces. If set to NO, the class list will
0642 # be sorted only by class name, not including the namespace part.
0643 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
0644 # Note: This option applies only to the class list, not to the alphabetical
0645 # list.
0646 # The default value is: NO.
0647 
0648 SORT_BY_SCOPE_NAME     = NO
0649 
0650 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
0651 # type resolution of all parameters of a function it will reject a match between
0652 # the prototype and the implementation of a member function even if there is
0653 # only one candidate or it is obvious which candidate to choose by doing a
0654 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
0655 # accept a match between prototype and implementation in such cases.
0656 # The default value is: NO.
0657 
0658 STRICT_PROTO_MATCHING  = NO
0659 
0660 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
0661 # list. This list is created by putting \todo commands in the documentation.
0662 # The default value is: YES.
0663 
0664 GENERATE_TODOLIST      = YES
0665 
0666 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
0667 # list. This list is created by putting \test commands in the documentation.
0668 # The default value is: YES.
0669 
0670 GENERATE_TESTLIST      = YES
0671 
0672 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
0673 # list. This list is created by putting \bug commands in the documentation.
0674 # The default value is: YES.
0675 
0676 GENERATE_BUGLIST       = YES
0677 
0678 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
0679 # the deprecated list. This list is created by putting \deprecated commands in
0680 # the documentation.
0681 # The default value is: YES.
0682 
0683 GENERATE_DEPRECATEDLIST= YES
0684 
0685 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
0686 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
0687 # ... \endcond blocks.
0688 
0689 ENABLED_SECTIONS       =
0690 
0691 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
0692 # initial value of a variable or macro / define can have for it to appear in the
0693 # documentation. If the initializer consists of more lines than specified here
0694 # it will be hidden. Use a value of 0 to hide initializers completely. The
0695 # appearance of the value of individual variables and macros / defines can be
0696 # controlled using \showinitializer or \hideinitializer command in the
0697 # documentation regardless of this setting.
0698 # Minimum value: 0, maximum value: 10000, default value: 30.
0699 
0700 MAX_INITIALIZER_LINES  = 30
0701 
0702 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
0703 # the bottom of the documentation of classes and structs. If set to YES, the
0704 # list will mention the files that were used to generate the documentation.
0705 # The default value is: YES.
0706 
0707 SHOW_USED_FILES        = YES
0708 
0709 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
0710 # will remove the Files entry from the Quick Index and from the Folder Tree View
0711 # (if specified).
0712 # The default value is: YES.
0713 
0714 SHOW_FILES             = YES
0715 
0716 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
0717 # page. This will remove the Namespaces entry from the Quick Index and from the
0718 # Folder Tree View (if specified).
0719 # The default value is: YES.
0720 
0721 SHOW_NAMESPACES        = YES
0722 
0723 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
0724 # doxygen should invoke to get the current version for each file (typically from
0725 # the version control system). Doxygen will invoke the program by executing (via
0726 # popen()) the command command input-file, where command is the value of the
0727 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
0728 # by doxygen. Whatever the program writes to standard output is used as the file
0729 # version. For an example see the documentation.
0730 
0731 FILE_VERSION_FILTER    =
0732 
0733 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
0734 # by doxygen. The layout file controls the global structure of the generated
0735 # output files in an output format independent way. To create the layout file
0736 # that represents doxygen's defaults, run doxygen with the -l option. You can
0737 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
0738 # will be used as the name of the layout file.
0739 #
0740 # Note that if you run doxygen from a directory containing a file called
0741 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
0742 # tag is left empty.
0743 
0744 LAYOUT_FILE            =
0745 
0746 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
0747 # the reference definitions. This must be a list of .bib files. The .bib
0748 # extension is automatically appended if omitted. This requires the bibtex tool
0749 # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
0750 # For LaTeX the style of the bibliography can be controlled using
0751 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
0752 # search path. See also \cite for info how to create references.
0753 
0754 CITE_BIB_FILES         =
0755 
0756 #---------------------------------------------------------------------------
0757 # Configuration options related to warning and progress messages
0758 #---------------------------------------------------------------------------
0759 
0760 # The QUIET tag can be used to turn on/off the messages that are generated to
0761 # standard output by doxygen. If QUIET is set to YES this implies that the
0762 # messages are off.
0763 # The default value is: NO.
0764 
0765 QUIET                  = YES
0766 
0767 # The WARNINGS tag can be used to turn on/off the warning messages that are
0768 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
0769 # this implies that the warnings are on.
0770 #
0771 # Tip: Turn warnings on while writing the documentation.
0772 # The default value is: YES.
0773 
0774 WARNINGS               = YES
0775 
0776 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
0777 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
0778 # will automatically be disabled.
0779 # The default value is: YES.
0780 
0781 WARN_IF_UNDOCUMENTED   = YES
0782 
0783 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
0784 # potential errors in the documentation, such as not documenting some parameters
0785 # in a documented function, or documenting parameters that don't exist or using
0786 # markup commands wrongly.
0787 # The default value is: YES.
0788 
0789 WARN_IF_DOC_ERROR      = YES
0790 
0791 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
0792 # are documented, but have no documentation for their parameters or return
0793 # value. If set to NO, doxygen will only warn about wrong or incomplete
0794 # parameter documentation, but not about the absence of documentation. If
0795 # EXTRACT_ALL is set to YES then this flag will automatically be disabled.
0796 # The default value is: NO.
0797 
0798 WARN_NO_PARAMDOC       = NO
0799 
0800 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
0801 # a warning is encountered.
0802 # The default value is: NO.
0803 
0804 WARN_AS_ERROR          = NO
0805 
0806 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
0807 # can produce. The string should contain the $file, $line, and $text tags, which
0808 # will be replaced by the file and line number from which the warning originated
0809 # and the warning text. Optionally the format may contain $version, which will
0810 # be replaced by the version of the file (if it could be obtained via
0811 # FILE_VERSION_FILTER)
0812 # The default value is: $file:$line: $text.
0813 
0814 WARN_FORMAT            = "$file:$line: $text"
0815 
0816 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
0817 # messages should be written. If left blank the output is written to standard
0818 # error (stderr).
0819 
0820 WARN_LOGFILE           =
0821 
0822 #---------------------------------------------------------------------------
0823 # Configuration options related to the input files
0824 #---------------------------------------------------------------------------
0825 
0826 # The INPUT tag is used to specify the files and/or directories that contain
0827 # documented source files. You may enter file names like myfile.cpp or
0828 # directories like /usr/src/myproject. Separate the files or directories with
0829 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
0830 # Note: If this tag is empty the current directory is searched.
0831 
0832 INPUT                  = ./lib/lottie/ ./docs/dox README.md
0833 
0834 # This tag can be used to specify the character encoding of the source files
0835 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
0836 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
0837 # documentation (see: https://www.gnu.org/software/libiconv/) for the list of
0838 # possible encodings.
0839 # The default value is: UTF-8.
0840 
0841 INPUT_ENCODING         = UTF-8
0842 
0843 # If the value of the INPUT tag contains directories, you can use the
0844 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
0845 # *.h) to filter out the source-files in the directories.
0846 #
0847 # Note that for custom extensions or not directly supported extensions you also
0848 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
0849 # read by doxygen.
0850 #
0851 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
0852 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
0853 # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
0854 # *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),
0855 # *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen
0856 # C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f, *.for, *.tcl, *.vhd,
0857 # *.vhdl, *.ucf, *.qsf and *.ice.
0858 
0859 FILE_PATTERNS          = *.c \
0860                          *.cc \
0861                          *.cxx \
0862                          *.cpp \
0863                          *.c++ \
0864                          *.java \
0865                          *.ii \
0866                          *.ixx \
0867                          *.ipp \
0868                          *.i++ \
0869                          *.inl \
0870                          *.idl \
0871                          *.ddl \
0872                          *.odl \
0873                          *.h \
0874                          *.hh \
0875                          *.hxx \
0876                          *.hpp \
0877                          *.h++ \
0878                          *.cs \
0879                          *.d \
0880                          *.php \
0881                          *.php4 \
0882                          *.php5 \
0883                          *.phtml \
0884                          *.inc \
0885                          *.m \
0886                          *.markdown \
0887                          *.md \
0888                          *.mm \
0889                          *.dox \
0890                          *.py \
0891                          *.pyw \
0892                          *.f90 \
0893                          *.f95 \
0894                          *.f03 \
0895                          *.f08 \
0896                          *.f \
0897                          *.for \
0898                          *.tcl \
0899                          *.vhd \
0900                          *.vhdl \
0901                          *.ucf \
0902                          *.qsf
0903 
0904 # The RECURSIVE tag can be used to specify whether or not subdirectories should
0905 # be searched for input files as well.
0906 # The default value is: NO.
0907 
0908 RECURSIVE              = YES
0909 
0910 # The EXCLUDE tag can be used to specify files and/or directories that should be
0911 # excluded from the INPUT source files. This way you can easily exclude a
0912 # subdirectory from a directory tree whose root is specified with the INPUT tag.
0913 #
0914 # Note that relative paths are relative to the directory from which doxygen is
0915 # run.
0916 
0917 EXCLUDE                =
0918 
0919 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
0920 # directories that are symbolic links (a Unix file system feature) are excluded
0921 # from the input.
0922 # The default value is: NO.
0923 
0924 EXCLUDE_SYMLINKS       = NO
0925 
0926 # If the value of the INPUT tag contains directories, you can use the
0927 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
0928 # certain files from those directories.
0929 #
0930 # Note that the wildcards are matched against the file with absolute path, so to
0931 # exclude all test directories for example use the pattern */test/*
0932 
0933 EXCLUDE_PATTERNS       =
0934 
0935 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
0936 # (namespaces, classes, functions, etc.) that should be excluded from the
0937 # output. The symbol name can be a fully qualified name, a word, or if the
0938 # wildcard * is used, a substring. Examples: ANamespace, AClass,
0939 # AClass::ANamespace, ANamespace::*Test
0940 #
0941 # Note that the wildcards are matched against the file with absolute path, so to
0942 # exclude all test directories use the pattern */test/*
0943 
0944 EXCLUDE_SYMBOLS        =
0945 
0946 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
0947 # that contain example code fragments that are included (see the \include
0948 # command).
0949 
0950 EXAMPLE_PATH           = examples
0951 
0952 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
0953 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
0954 # *.h) to filter out the source-files in the directories. If left blank all
0955 # files are included.
0956 
0957 EXAMPLE_PATTERNS       = *
0958 
0959 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
0960 # searched for input files to be used with the \include or \dontinclude commands
0961 # irrespective of the value of the RECURSIVE tag.
0962 # The default value is: NO.
0963 
0964 EXAMPLE_RECURSIVE      = NO
0965 
0966 # The IMAGE_PATH tag can be used to specify one or more files or directories
0967 # that contain images that are to be included in the documentation (see the
0968 # \image command).
0969 
0970 IMAGE_PATH             =
0971 
0972 # The INPUT_FILTER tag can be used to specify a program that doxygen should
0973 # invoke to filter for each input file. Doxygen will invoke the filter program
0974 # by executing (via popen()) the command:
0975 #
0976 # <filter> <input-file>
0977 #
0978 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
0979 # name of an input file. Doxygen will then use the output that the filter
0980 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
0981 # will be ignored.
0982 #
0983 # Note that the filter must not add or remove lines; it is applied before the
0984 # code is scanned, but not when the output code is generated. If lines are added
0985 # or removed, the anchors will not be placed correctly.
0986 #
0987 # Note that for custom extensions or not directly supported extensions you also
0988 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
0989 # properly processed by doxygen.
0990 
0991 INPUT_FILTER           =
0992 
0993 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
0994 # basis. Doxygen will compare the file name with each pattern and apply the
0995 # filter if there is a match. The filters are a list of the form: pattern=filter
0996 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
0997 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
0998 # patterns match the file name, INPUT_FILTER is applied.
0999 #
1000 # Note that for custom extensions or not directly supported extensions you also
1001 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
1002 # properly processed by doxygen.
1003 
1004 FILTER_PATTERNS        =
1005 
1006 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1007 # INPUT_FILTER) will also be used to filter the input files that are used for
1008 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1009 # The default value is: NO.
1010 
1011 FILTER_SOURCE_FILES    = NO
1012 
1013 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1014 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1015 # it is also possible to disable source filtering for a specific pattern using
1016 # *.ext= (so without naming a filter).
1017 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1018 
1019 FILTER_SOURCE_PATTERNS =
1020 
1021 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1022 # is part of the input, its contents will be placed on the main page
1023 # (index.html). This can be useful if you have a project on for instance GitHub
1024 # and want to reuse the introduction page also for the doxygen output.
1025 
1026 USE_MDFILE_AS_MAINPAGE = README.md
1027 
1028 #---------------------------------------------------------------------------
1029 # Configuration options related to source browsing
1030 #---------------------------------------------------------------------------
1031 
1032 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1033 # generated. Documented entities will be cross-referenced with these sources.
1034 #
1035 # Note: To get rid of all source code in the generated output, make sure that
1036 # also VERBATIM_HEADERS is set to NO.
1037 # The default value is: NO.
1038 
1039 SOURCE_BROWSER         = YES
1040 
1041 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
1042 # classes and enums directly into the documentation.
1043 # The default value is: NO.
1044 
1045 INLINE_SOURCES         = NO
1046 
1047 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1048 # special comment blocks from generated source code fragments. Normal C, C++ and
1049 # Fortran comments will always remain visible.
1050 # The default value is: YES.
1051 
1052 STRIP_CODE_COMMENTS    = NO
1053 
1054 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1055 # entity all documented functions referencing it will be listed.
1056 # The default value is: NO.
1057 
1058 REFERENCED_BY_RELATION = NO
1059 
1060 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1061 # all documented entities called/used by that function will be listed.
1062 # The default value is: NO.
1063 
1064 REFERENCES_RELATION    = NO
1065 
1066 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1067 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
1068 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1069 # link to the documentation.
1070 # The default value is: YES.
1071 
1072 REFERENCES_LINK_SOURCE = YES
1073 
1074 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1075 # source code will show a tooltip with additional information such as prototype,
1076 # brief description and links to the definition and documentation. Since this
1077 # will make the HTML file larger and loading of large files a bit slower, you
1078 # can opt to disable this feature.
1079 # The default value is: YES.
1080 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1081 
1082 SOURCE_TOOLTIPS        = YES
1083 
1084 # If the USE_HTAGS tag is set to YES then the references to source code will
1085 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1086 # source browser. The htags tool is part of GNU's global source tagging system
1087 # (see https://www.gnu.org/software/global/global.html). You will need version
1088 # 4.8.6 or higher.
1089 #
1090 # To use it do the following:
1091 # - Install the latest version of global
1092 # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1093 # - Make sure the INPUT points to the root of the source tree
1094 # - Run doxygen as normal
1095 #
1096 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1097 # tools must be available from the command line (i.e. in the search path).
1098 #
1099 # The result: instead of the source browser generated by doxygen, the links to
1100 # source code will now point to the output of htags.
1101 # The default value is: NO.
1102 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1103 
1104 USE_HTAGS              = NO
1105 
1106 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1107 # verbatim copy of the header file for each class for which an include is
1108 # specified. Set to NO to disable this.
1109 # See also: Section \class.
1110 # The default value is: YES.
1111 
1112 VERBATIM_HEADERS       = YES
1113 
1114 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1115 # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
1116 # cost of reduced performance. This can be particularly helpful with template
1117 # rich C++ code for which doxygen's built-in parser lacks the necessary type
1118 # information.
1119 # Note: The availability of this option depends on whether or not doxygen was
1120 # generated with the -Duse_libclang=ON option for CMake.
1121 # The default value is: NO.
1122 
1123 CLANG_ASSISTED_PARSING = NO
1124 
1125 # If clang assisted parsing is enabled you can provide the compiler with command
1126 # line options that you would normally use when invoking the compiler. Note that
1127 # the include paths will already be set by doxygen for the files and directories
1128 # specified with INPUT and INCLUDE_PATH.
1129 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1130 
1131 CLANG_OPTIONS          =
1132 
1133 # If clang assisted parsing is enabled you can provide the clang parser with the
1134 # path to the compilation database (see:
1135 # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files
1136 # were built. This is equivalent to specifying the "-p" option to a clang tool,
1137 # such as clang-check. These options will then be passed to the parser.
1138 # Note: The availability of this option depends on whether or not doxygen was
1139 # generated with the -Duse_libclang=ON option for CMake.
1140 
1141 CLANG_DATABASE_PATH    =
1142 
1143 #---------------------------------------------------------------------------
1144 # Configuration options related to the alphabetical class index
1145 #---------------------------------------------------------------------------
1146 
1147 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1148 # compounds will be generated. Enable this if the project contains a lot of
1149 # classes, structs, unions or interfaces.
1150 # The default value is: YES.
1151 
1152 ALPHABETICAL_INDEX     = YES
1153 
1154 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1155 # which the alphabetical index list will be split.
1156 # Minimum value: 1, maximum value: 20, default value: 5.
1157 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1158 
1159 COLS_IN_ALPHA_INDEX    = 5
1160 
1161 # In case all classes in a project start with a common prefix, all classes will
1162 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1163 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1164 # while generating the index headers.
1165 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1166 
1167 IGNORE_PREFIX          =
1168 
1169 #---------------------------------------------------------------------------
1170 # Configuration options related to the HTML output
1171 #---------------------------------------------------------------------------
1172 
1173 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1174 # The default value is: YES.
1175 
1176 GENERATE_HTML          = YES
1177 
1178 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1179 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1180 # it.
1181 # The default directory is: html.
1182 # This tag requires that the tag GENERATE_HTML is set to YES.
1183 
1184 HTML_OUTPUT            = docs/html
1185 
1186 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1187 # generated HTML page (for example: .htm, .php, .asp).
1188 # The default value is: .html.
1189 # This tag requires that the tag GENERATE_HTML is set to YES.
1190 
1191 HTML_FILE_EXTENSION    = .html
1192 
1193 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1194 # each generated HTML page. If the tag is left blank doxygen will generate a
1195 # standard header.
1196 #
1197 # To get valid HTML the header file that includes any scripts and style sheets
1198 # that doxygen needs, which is dependent on the configuration options used (e.g.
1199 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1200 # default header using
1201 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1202 # YourConfigFile
1203 # and then modify the file new_header.html. See also section "Doxygen usage"
1204 # for information on how to generate the default header that doxygen normally
1205 # uses.
1206 # Note: The header is subject to change so you typically have to regenerate the
1207 # default header when upgrading to a newer version of doxygen. For a description
1208 # of the possible markers and block names see the documentation.
1209 # This tag requires that the tag GENERATE_HTML is set to YES.
1210 
1211 HTML_HEADER            =
1212 
1213 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1214 # generated HTML page. If the tag is left blank doxygen will generate a standard
1215 # footer. See HTML_HEADER for more information on how to generate a default
1216 # footer and what special commands can be used inside the footer. See also
1217 # section "Doxygen usage" for information on how to generate the default footer
1218 # that doxygen normally uses.
1219 # This tag requires that the tag GENERATE_HTML is set to YES.
1220 
1221 HTML_FOOTER            =
1222 
1223 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1224 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1225 # the HTML output. If left blank doxygen will generate a default style sheet.
1226 # See also section "Doxygen usage" for information on how to generate the style
1227 # sheet that doxygen normally uses.
1228 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1229 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1230 # obsolete.
1231 # This tag requires that the tag GENERATE_HTML is set to YES.
1232 
1233 HTML_STYLESHEET        =
1234 
1235 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1236 # cascading style sheets that are included after the standard style sheets
1237 # created by doxygen. Using this option one can overrule certain style aspects.
1238 # This is preferred over using HTML_STYLESHEET since it does not replace the
1239 # standard style sheet and is therefore more robust against future updates.
1240 # Doxygen will copy the style sheet files to the output directory.
1241 # Note: The order of the extra style sheet files is of importance (e.g. the last
1242 # style sheet in the list overrules the setting of the previous ones in the
1243 # list). For an example see the documentation.
1244 # This tag requires that the tag GENERATE_HTML is set to YES.
1245 
1246 HTML_EXTRA_STYLESHEET  = docs/style/customize.css
1247 
1248 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1249 # other source files which should be copied to the HTML output directory. Note
1250 # that these files will be copied to the base HTML output directory. Use the
1251 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1252 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1253 # files will be copied as-is; there are no commands or markers available.
1254 # This tag requires that the tag GENERATE_HTML is set to YES.
1255 
1256 HTML_EXTRA_FILES       =
1257 
1258 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1259 # will adjust the colors in the style sheet and background images according to
1260 # this color. Hue is specified as an angle on a colorwheel, see
1261 # https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1262 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1263 # purple, and 360 is red again.
1264 # Minimum value: 0, maximum value: 359, default value: 220.
1265 # This tag requires that the tag GENERATE_HTML is set to YES.
1266 
1267 HTML_COLORSTYLE_HUE    = 220
1268 
1269 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1270 # in the HTML output. For a value of 0 the output will use grayscales only. A
1271 # value of 255 will produce the most vivid colors.
1272 # Minimum value: 0, maximum value: 255, default value: 100.
1273 # This tag requires that the tag GENERATE_HTML is set to YES.
1274 
1275 HTML_COLORSTYLE_SAT    = 100
1276 
1277 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1278 # luminance component of the colors in the HTML output. Values below 100
1279 # gradually make the output lighter, whereas values above 100 make the output
1280 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1281 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1282 # change the gamma.
1283 # Minimum value: 40, maximum value: 240, default value: 80.
1284 # This tag requires that the tag GENERATE_HTML is set to YES.
1285 
1286 HTML_COLORSTYLE_GAMMA  = 80
1287 
1288 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1289 # page will contain the date and time when the page was generated. Setting this
1290 # to YES can help to show when doxygen was last run and thus if the
1291 # documentation is up to date.
1292 # The default value is: NO.
1293 # This tag requires that the tag GENERATE_HTML is set to YES.
1294 
1295 HTML_TIMESTAMP         = NO
1296 
1297 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1298 # documentation will contain a main index with vertical navigation menus that
1299 # are dynamically created via JavaScript. If disabled, the navigation index will
1300 # consists of multiple levels of tabs that are statically embedded in every HTML
1301 # page. Disable this option to support browsers that do not have JavaScript,
1302 # like the Qt help browser.
1303 # The default value is: YES.
1304 # This tag requires that the tag GENERATE_HTML is set to YES.
1305 
1306 HTML_DYNAMIC_MENUS     = YES
1307 
1308 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1309 # documentation will contain sections that can be hidden and shown after the
1310 # page has loaded.
1311 # The default value is: NO.
1312 # This tag requires that the tag GENERATE_HTML is set to YES.
1313 
1314 HTML_DYNAMIC_SECTIONS  = NO
1315 
1316 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1317 # shown in the various tree structured indices initially; the user can expand
1318 # and collapse entries dynamically later on. Doxygen will expand the tree to
1319 # such a level that at most the specified number of entries are visible (unless
1320 # a fully collapsed tree already exceeds this amount). So setting the number of
1321 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1322 # representing an infinite number of entries and will result in a full expanded
1323 # tree by default.
1324 # Minimum value: 0, maximum value: 9999, default value: 100.
1325 # This tag requires that the tag GENERATE_HTML is set to YES.
1326 
1327 HTML_INDEX_NUM_ENTRIES = 100
1328 
1329 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1330 # generated that can be used as input for Apple's Xcode 3 integrated development
1331 # environment (see: https://developer.apple.com/xcode/), introduced with OSX
1332 # 10.5 (Leopard). To create a documentation set, doxygen will generate a
1333 # Makefile in the HTML output directory. Running make will produce the docset in
1334 # that directory and running make install will install the docset in
1335 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1336 # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1337 # genXcode/_index.html for more information.
1338 # The default value is: NO.
1339 # This tag requires that the tag GENERATE_HTML is set to YES.
1340 
1341 GENERATE_DOCSET        = NO
1342 
1343 # This tag determines the name of the docset feed. A documentation feed provides
1344 # an umbrella under which multiple documentation sets from a single provider
1345 # (such as a company or product suite) can be grouped.
1346 # The default value is: Doxygen generated docs.
1347 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1348 
1349 DOCSET_FEEDNAME        = "Doxygen generated docs"
1350 
1351 # This tag specifies a string that should uniquely identify the documentation
1352 # set bundle. This should be a reverse domain-name style string, e.g.
1353 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1354 # The default value is: org.doxygen.Project.
1355 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1356 
1357 DOCSET_BUNDLE_ID       = org.doxygen.Project
1358 
1359 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1360 # the documentation publisher. This should be a reverse domain-name style
1361 # string, e.g. com.mycompany.MyDocSet.documentation.
1362 # The default value is: org.doxygen.Publisher.
1363 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1364 
1365 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1366 
1367 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1368 # The default value is: Publisher.
1369 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1370 
1371 DOCSET_PUBLISHER_NAME  = Publisher
1372 
1373 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1374 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1375 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1376 # (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1377 # Windows.
1378 #
1379 # The HTML Help Workshop contains a compiler that can convert all HTML output
1380 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1381 # files are now used as the Windows 98 help format, and will replace the old
1382 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1383 # HTML files also contain an index, a table of contents, and you can search for
1384 # words in the documentation. The HTML workshop also contains a viewer for
1385 # compressed HTML files.
1386 # The default value is: NO.
1387 # This tag requires that the tag GENERATE_HTML is set to YES.
1388 
1389 GENERATE_HTMLHELP      = NO
1390 
1391 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1392 # file. You can add a path in front of the file if the result should not be
1393 # written to the html output directory.
1394 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1395 
1396 CHM_FILE               =
1397 
1398 # The HHC_LOCATION tag can be used to specify the location (absolute path
1399 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1400 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1401 # The file has to be specified with full path.
1402 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1403 
1404 HHC_LOCATION           =
1405 
1406 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1407 # (YES) or that it should be included in the master .chm file (NO).
1408 # The default value is: NO.
1409 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1410 
1411 GENERATE_CHI           = NO
1412 
1413 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1414 # and project file content.
1415 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1416 
1417 CHM_INDEX_ENCODING     =
1418 
1419 # The BINARY_TOC flag controls whether a binary table of contents is generated
1420 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1421 # enables the Previous and Next buttons.
1422 # The default value is: NO.
1423 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1424 
1425 BINARY_TOC             = NO
1426 
1427 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1428 # the table of contents of the HTML help documentation and to the tree view.
1429 # The default value is: NO.
1430 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1431 
1432 TOC_EXPAND             = NO
1433 
1434 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1435 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1436 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1437 # (.qch) of the generated HTML documentation.
1438 # The default value is: NO.
1439 # This tag requires that the tag GENERATE_HTML is set to YES.
1440 
1441 GENERATE_QHP           = NO
1442 
1443 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1444 # the file name of the resulting .qch file. The path specified is relative to
1445 # the HTML output folder.
1446 # This tag requires that the tag GENERATE_QHP is set to YES.
1447 
1448 QCH_FILE               =
1449 
1450 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1451 # Project output. For more information please see Qt Help Project / Namespace
1452 # (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1453 # The default value is: org.doxygen.Project.
1454 # This tag requires that the tag GENERATE_QHP is set to YES.
1455 
1456 QHP_NAMESPACE          = org.doxygen.Project
1457 
1458 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1459 # Help Project output. For more information please see Qt Help Project / Virtual
1460 # Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-
1461 # folders).
1462 # The default value is: doc.
1463 # This tag requires that the tag GENERATE_QHP is set to YES.
1464 
1465 QHP_VIRTUAL_FOLDER     = doc
1466 
1467 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1468 # filter to add. For more information please see Qt Help Project / Custom
1469 # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
1470 # filters).
1471 # This tag requires that the tag GENERATE_QHP is set to YES.
1472 
1473 QHP_CUST_FILTER_NAME   =
1474 
1475 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1476 # custom filter to add. For more information please see Qt Help Project / Custom
1477 # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
1478 # filters).
1479 # This tag requires that the tag GENERATE_QHP is set to YES.
1480 
1481 QHP_CUST_FILTER_ATTRS  =
1482 
1483 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1484 # project's filter section matches. Qt Help Project / Filter Attributes (see:
1485 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1486 # This tag requires that the tag GENERATE_QHP is set to YES.
1487 
1488 QHP_SECT_FILTER_ATTRS  =
1489 
1490 # The QHG_LOCATION tag can be used to specify the location of Qt's
1491 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1492 # generated .qhp file.
1493 # This tag requires that the tag GENERATE_QHP is set to YES.
1494 
1495 QHG_LOCATION           =
1496 
1497 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1498 # generated, together with the HTML files, they form an Eclipse help plugin. To
1499 # install this plugin and make it available under the help contents menu in
1500 # Eclipse, the contents of the directory containing the HTML and XML files needs
1501 # to be copied into the plugins directory of eclipse. The name of the directory
1502 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1503 # After copying Eclipse needs to be restarted before the help appears.
1504 # The default value is: NO.
1505 # This tag requires that the tag GENERATE_HTML is set to YES.
1506 
1507 GENERATE_ECLIPSEHELP   = NO
1508 
1509 # A unique identifier for the Eclipse help plugin. When installing the plugin
1510 # the directory name containing the HTML and XML files should also have this
1511 # name. Each documentation set should have its own identifier.
1512 # The default value is: org.doxygen.Project.
1513 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1514 
1515 ECLIPSE_DOC_ID         = org.doxygen.Project
1516 
1517 # If you want full control over the layout of the generated HTML pages it might
1518 # be necessary to disable the index and replace it with your own. The
1519 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1520 # of each HTML page. A value of NO enables the index and the value YES disables
1521 # it. Since the tabs in the index contain the same information as the navigation
1522 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1523 # The default value is: NO.
1524 # This tag requires that the tag GENERATE_HTML is set to YES.
1525 
1526 DISABLE_INDEX          = NO
1527 
1528 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1529 # structure should be generated to display hierarchical information. If the tag
1530 # value is set to YES, a side panel will be generated containing a tree-like
1531 # index structure (just like the one that is generated for HTML Help). For this
1532 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1533 # (i.e. any modern browser). Windows users are probably better off using the
1534 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1535 # further fine-tune the look of the index. As an example, the default style
1536 # sheet generated by doxygen has an example that shows how to put an image at
1537 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1538 # the same information as the tab index, you could consider setting
1539 # DISABLE_INDEX to YES when enabling this option.
1540 # The default value is: NO.
1541 # This tag requires that the tag GENERATE_HTML is set to YES.
1542 
1543 GENERATE_TREEVIEW      = YES
1544 
1545 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1546 # doxygen will group on one line in the generated HTML documentation.
1547 #
1548 # Note that a value of 0 will completely suppress the enum values from appearing
1549 # in the overview section.
1550 # Minimum value: 0, maximum value: 20, default value: 4.
1551 # This tag requires that the tag GENERATE_HTML is set to YES.
1552 
1553 ENUM_VALUES_PER_LINE   = 4
1554 
1555 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1556 # to set the initial width (in pixels) of the frame in which the tree is shown.
1557 # Minimum value: 0, maximum value: 1500, default value: 250.
1558 # This tag requires that the tag GENERATE_HTML is set to YES.
1559 
1560 TREEVIEW_WIDTH         = 250
1561 
1562 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1563 # external symbols imported via tag files in a separate window.
1564 # The default value is: NO.
1565 # This tag requires that the tag GENERATE_HTML is set to YES.
1566 
1567 EXT_LINKS_IN_WINDOW    = NO
1568 
1569 # Use this tag to change the font size of LaTeX formulas included as images in
1570 # the HTML documentation. When you change the font size after a successful
1571 # doxygen run you need to manually remove any form_*.png images from the HTML
1572 # output directory to force them to be regenerated.
1573 # Minimum value: 8, maximum value: 50, default value: 10.
1574 # This tag requires that the tag GENERATE_HTML is set to YES.
1575 
1576 FORMULA_FONTSIZE       = 10
1577 
1578 # Use the FORMULA_TRANSPARENT tag to determine whether or not the images
1579 # generated for formulas are transparent PNGs. Transparent PNGs are not
1580 # supported properly for IE 6.0, but are supported on all modern browsers.
1581 #
1582 # Note that when changing this option you need to delete any form_*.png files in
1583 # the HTML output directory before the changes have effect.
1584 # The default value is: YES.
1585 # This tag requires that the tag GENERATE_HTML is set to YES.
1586 
1587 FORMULA_TRANSPARENT    = YES
1588 
1589 # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
1590 # to create new LaTeX commands to be used in formulas as building blocks. See
1591 # the section "Including formulas" for details.
1592 
1593 FORMULA_MACROFILE      =
1594 
1595 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1596 # https://www.mathjax.org) which uses client side JavaScript for the rendering
1597 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1598 # installed or if you want to formulas look prettier in the HTML output. When
1599 # enabled you may also need to install MathJax separately and configure the path
1600 # to it using the MATHJAX_RELPATH option.
1601 # The default value is: NO.
1602 # This tag requires that the tag GENERATE_HTML is set to YES.
1603 
1604 USE_MATHJAX            = NO
1605 
1606 # When MathJax is enabled you can set the default output format to be used for
1607 # the MathJax output. See the MathJax site (see:
1608 # http://docs.mathjax.org/en/latest/output.html) for more details.
1609 # Possible values are: HTML-CSS (which is slower, but has the best
1610 # compatibility), NativeMML (i.e. MathML) and SVG.
1611 # The default value is: HTML-CSS.
1612 # This tag requires that the tag USE_MATHJAX is set to YES.
1613 
1614 MATHJAX_FORMAT         = HTML-CSS
1615 
1616 # When MathJax is enabled you need to specify the location relative to the HTML
1617 # output directory using the MATHJAX_RELPATH option. The destination directory
1618 # should contain the MathJax.js script. For instance, if the mathjax directory
1619 # is located at the same level as the HTML output directory, then
1620 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1621 # Content Delivery Network so you can quickly see the result without installing
1622 # MathJax. However, it is strongly recommended to install a local copy of
1623 # MathJax from https://www.mathjax.org before deployment.
1624 # The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/.
1625 # This tag requires that the tag USE_MATHJAX is set to YES.
1626 
1627 MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
1628 
1629 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1630 # extension names that should be enabled during MathJax rendering. For example
1631 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1632 # This tag requires that the tag USE_MATHJAX is set to YES.
1633 
1634 MATHJAX_EXTENSIONS     =
1635 
1636 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1637 # of code that will be used on startup of the MathJax code. See the MathJax site
1638 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1639 # example see the documentation.
1640 # This tag requires that the tag USE_MATHJAX is set to YES.
1641 
1642 MATHJAX_CODEFILE       =
1643 
1644 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1645 # the HTML output. The underlying search engine uses javascript and DHTML and
1646 # should work on any modern browser. Note that when using HTML help
1647 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1648 # there is already a search function so this one should typically be disabled.
1649 # For large projects the javascript based search engine can be slow, then
1650 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1651 # search using the keyboard; to jump to the search box use <access key> + S
1652 # (what the <access key> is depends on the OS and browser, but it is typically
1653 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1654 # key> to jump into the search results window, the results can be navigated
1655 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1656 # the search. The filter options can be selected when the cursor is inside the
1657 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1658 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1659 # option.
1660 # The default value is: YES.
1661 # This tag requires that the tag GENERATE_HTML is set to YES.
1662 
1663 SEARCHENGINE           = YES
1664 
1665 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1666 # implemented using a web server instead of a web client using JavaScript. There
1667 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1668 # setting. When disabled, doxygen will generate a PHP script for searching and
1669 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1670 # and searching needs to be provided by external tools. See the section
1671 # "External Indexing and Searching" for details.
1672 # The default value is: NO.
1673 # This tag requires that the tag SEARCHENGINE is set to YES.
1674 
1675 SERVER_BASED_SEARCH    = NO
1676 
1677 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1678 # script for searching. Instead the search results are written to an XML file
1679 # which needs to be processed by an external indexer. Doxygen will invoke an
1680 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1681 # search results.
1682 #
1683 # Doxygen ships with an example indexer (doxyindexer) and search engine
1684 # (doxysearch.cgi) which are based on the open source search engine library
1685 # Xapian (see: https://xapian.org/).
1686 #
1687 # See the section "External Indexing and Searching" for details.
1688 # The default value is: NO.
1689 # This tag requires that the tag SEARCHENGINE is set to YES.
1690 
1691 EXTERNAL_SEARCH        = NO
1692 
1693 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1694 # which will return the search results when EXTERNAL_SEARCH is enabled.
1695 #
1696 # Doxygen ships with an example indexer (doxyindexer) and search engine
1697 # (doxysearch.cgi) which are based on the open source search engine library
1698 # Xapian (see: https://xapian.org/). See the section "External Indexing and
1699 # Searching" for details.
1700 # This tag requires that the tag SEARCHENGINE is set to YES.
1701 
1702 SEARCHENGINE_URL       =
1703 
1704 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1705 # search data is written to a file for indexing by an external tool. With the
1706 # SEARCHDATA_FILE tag the name of this file can be specified.
1707 # The default file is: searchdata.xml.
1708 # This tag requires that the tag SEARCHENGINE is set to YES.
1709 
1710 SEARCHDATA_FILE        = searchdata.xml
1711 
1712 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1713 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1714 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1715 # projects and redirect the results back to the right project.
1716 # This tag requires that the tag SEARCHENGINE is set to YES.
1717 
1718 EXTERNAL_SEARCH_ID     =
1719 
1720 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1721 # projects other than the one defined by this configuration file, but that are
1722 # all added to the same external search index. Each project needs to have a
1723 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1724 # to a relative location where the documentation can be found. The format is:
1725 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1726 # This tag requires that the tag SEARCHENGINE is set to YES.
1727 
1728 EXTRA_SEARCH_MAPPINGS  =
1729 
1730 #---------------------------------------------------------------------------
1731 # Configuration options related to the LaTeX output
1732 #---------------------------------------------------------------------------
1733 
1734 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1735 # The default value is: YES.
1736 
1737 GENERATE_LATEX         = NO
1738 
1739 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1740 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1741 # it.
1742 # The default directory is: latex.
1743 # This tag requires that the tag GENERATE_LATEX is set to YES.
1744 
1745 LATEX_OUTPUT           = latex
1746 
1747 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1748 # invoked.
1749 #
1750 # Note that when not enabling USE_PDFLATEX the default is latex when enabling
1751 # USE_PDFLATEX the default is pdflatex and when in the later case latex is
1752 # chosen this is overwritten by pdflatex. For specific output languages the
1753 # default can have been set differently, this depends on the implementation of
1754 # the output language.
1755 # This tag requires that the tag GENERATE_LATEX is set to YES.
1756 
1757 LATEX_CMD_NAME         = latex
1758 
1759 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1760 # index for LaTeX.
1761 # Note: This tag is used in the Makefile / make.bat.
1762 # See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
1763 # (.tex).
1764 # The default file is: makeindex.
1765 # This tag requires that the tag GENERATE_LATEX is set to YES.
1766 
1767 MAKEINDEX_CMD_NAME     = makeindex
1768 
1769 # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
1770 # generate index for LaTeX. In case there is no backslash (\) as first character
1771 # it will be automatically added in the LaTeX code.
1772 # Note: This tag is used in the generated output file (.tex).
1773 # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
1774 # The default value is: makeindex.
1775 # This tag requires that the tag GENERATE_LATEX is set to YES.
1776 
1777 LATEX_MAKEINDEX_CMD    = makeindex
1778 
1779 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1780 # documents. This may be useful for small projects and may help to save some
1781 # trees in general.
1782 # The default value is: NO.
1783 # This tag requires that the tag GENERATE_LATEX is set to YES.
1784 
1785 COMPACT_LATEX          = NO
1786 
1787 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1788 # printer.
1789 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1790 # 14 inches) and executive (7.25 x 10.5 inches).
1791 # The default value is: a4.
1792 # This tag requires that the tag GENERATE_LATEX is set to YES.
1793 
1794 PAPER_TYPE             = a4
1795 
1796 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1797 # that should be included in the LaTeX output. The package can be specified just
1798 # by its name or with the correct syntax as to be used with the LaTeX
1799 # \usepackage command. To get the times font for instance you can specify :
1800 # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1801 # To use the option intlimits with the amsmath package you can specify:
1802 # EXTRA_PACKAGES=[intlimits]{amsmath}
1803 # If left blank no extra packages will be included.
1804 # This tag requires that the tag GENERATE_LATEX is set to YES.
1805 
1806 EXTRA_PACKAGES         =
1807 
1808 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1809 # generated LaTeX document. The header should contain everything until the first
1810 # chapter. If it is left blank doxygen will generate a standard header. See
1811 # section "Doxygen usage" for information on how to let doxygen write the
1812 # default header to a separate file.
1813 #
1814 # Note: Only use a user-defined header if you know what you are doing! The
1815 # following commands have a special meaning inside the header: $title,
1816 # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1817 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1818 # string, for the replacement values of the other commands the user is referred
1819 # to HTML_HEADER.
1820 # This tag requires that the tag GENERATE_LATEX is set to YES.
1821 
1822 LATEX_HEADER           =
1823 
1824 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1825 # generated LaTeX document. The footer should contain everything after the last
1826 # chapter. If it is left blank doxygen will generate a standard footer. See
1827 # LATEX_HEADER for more information on how to generate a default footer and what
1828 # special commands can be used inside the footer.
1829 #
1830 # Note: Only use a user-defined footer if you know what you are doing!
1831 # This tag requires that the tag GENERATE_LATEX is set to YES.
1832 
1833 LATEX_FOOTER           =
1834 
1835 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1836 # LaTeX style sheets that are included after the standard style sheets created
1837 # by doxygen. Using this option one can overrule certain style aspects. Doxygen
1838 # will copy the style sheet files to the output directory.
1839 # Note: The order of the extra style sheet files is of importance (e.g. the last
1840 # style sheet in the list overrules the setting of the previous ones in the
1841 # list).
1842 # This tag requires that the tag GENERATE_LATEX is set to YES.
1843 
1844 LATEX_EXTRA_STYLESHEET =
1845 
1846 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1847 # other source files which should be copied to the LATEX_OUTPUT output
1848 # directory. Note that the files will be copied as-is; there are no commands or
1849 # markers available.
1850 # This tag requires that the tag GENERATE_LATEX is set to YES.
1851 
1852 LATEX_EXTRA_FILES      =
1853 
1854 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1855 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1856 # contain links (just like the HTML output) instead of page references. This
1857 # makes the output suitable for online browsing using a PDF viewer.
1858 # The default value is: YES.
1859 # This tag requires that the tag GENERATE_LATEX is set to YES.
1860 
1861 PDF_HYPERLINKS         = YES
1862 
1863 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1864 # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1865 # higher quality PDF documentation.
1866 # The default value is: YES.
1867 # This tag requires that the tag GENERATE_LATEX is set to YES.
1868 
1869 USE_PDFLATEX           = YES
1870 
1871 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1872 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1873 # if errors occur, instead of asking the user for help. This option is also used
1874 # when generating formulas in HTML.
1875 # The default value is: NO.
1876 # This tag requires that the tag GENERATE_LATEX is set to YES.
1877 
1878 LATEX_BATCHMODE        = NO
1879 
1880 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1881 # index chapters (such as File Index, Compound Index, etc.) in the output.
1882 # The default value is: NO.
1883 # This tag requires that the tag GENERATE_LATEX is set to YES.
1884 
1885 LATEX_HIDE_INDICES     = NO
1886 
1887 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1888 # code with syntax highlighting in the LaTeX output.
1889 #
1890 # Note that which sources are shown also depends on other settings such as
1891 # SOURCE_BROWSER.
1892 # The default value is: NO.
1893 # This tag requires that the tag GENERATE_LATEX is set to YES.
1894 
1895 LATEX_SOURCE_CODE      = NO
1896 
1897 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1898 # bibliography, e.g. plainnat, or ieeetr. See
1899 # https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1900 # The default value is: plain.
1901 # This tag requires that the tag GENERATE_LATEX is set to YES.
1902 
1903 LATEX_BIB_STYLE        = plain
1904 
1905 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1906 # page will contain the date and time when the page was generated. Setting this
1907 # to NO can help when comparing the output of multiple runs.
1908 # The default value is: NO.
1909 # This tag requires that the tag GENERATE_LATEX is set to YES.
1910 
1911 LATEX_TIMESTAMP        = NO
1912 
1913 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
1914 # path from which the emoji images will be read. If a relative path is entered,
1915 # it will be relative to the LATEX_OUTPUT directory. If left blank the
1916 # LATEX_OUTPUT directory will be used.
1917 # This tag requires that the tag GENERATE_LATEX is set to YES.
1918 
1919 LATEX_EMOJI_DIRECTORY  =
1920 
1921 #---------------------------------------------------------------------------
1922 # Configuration options related to the RTF output
1923 #---------------------------------------------------------------------------
1924 
1925 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1926 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1927 # readers/editors.
1928 # The default value is: NO.
1929 
1930 GENERATE_RTF           = NO
1931 
1932 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1933 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1934 # it.
1935 # The default directory is: rtf.
1936 # This tag requires that the tag GENERATE_RTF is set to YES.
1937 
1938 RTF_OUTPUT             = rtf
1939 
1940 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1941 # documents. This may be useful for small projects and may help to save some
1942 # trees in general.
1943 # The default value is: NO.
1944 # This tag requires that the tag GENERATE_RTF is set to YES.
1945 
1946 COMPACT_RTF            = NO
1947 
1948 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1949 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1950 # output) instead of page references. This makes the output suitable for online
1951 # browsing using Word or some other Word compatible readers that support those
1952 # fields.
1953 #
1954 # Note: WordPad (write) and others do not support links.
1955 # The default value is: NO.
1956 # This tag requires that the tag GENERATE_RTF is set to YES.
1957 
1958 RTF_HYPERLINKS         = NO
1959 
1960 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1961 # configuration file, i.e. a series of assignments. You only have to provide
1962 # replacements, missing definitions are set to their default value.
1963 #
1964 # See also section "Doxygen usage" for information on how to generate the
1965 # default style sheet that doxygen normally uses.
1966 # This tag requires that the tag GENERATE_RTF is set to YES.
1967 
1968 RTF_STYLESHEET_FILE    =
1969 
1970 # Set optional variables used in the generation of an RTF document. Syntax is
1971 # similar to doxygen's configuration file. A template extensions file can be
1972 # generated using doxygen -e rtf extensionFile.
1973 # This tag requires that the tag GENERATE_RTF is set to YES.
1974 
1975 RTF_EXTENSIONS_FILE    =
1976 
1977 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1978 # with syntax highlighting in the RTF output.
1979 #
1980 # Note that which sources are shown also depends on other settings such as
1981 # SOURCE_BROWSER.
1982 # The default value is: NO.
1983 # This tag requires that the tag GENERATE_RTF is set to YES.
1984 
1985 RTF_SOURCE_CODE        = NO
1986 
1987 #---------------------------------------------------------------------------
1988 # Configuration options related to the man page output
1989 #---------------------------------------------------------------------------
1990 
1991 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1992 # classes and files.
1993 # The default value is: NO.
1994 
1995 GENERATE_MAN           = NO
1996 
1997 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1998 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1999 # it. A directory man3 will be created inside the directory specified by
2000 # MAN_OUTPUT.
2001 # The default directory is: man.
2002 # This tag requires that the tag GENERATE_MAN is set to YES.
2003 
2004 MAN_OUTPUT             = man
2005 
2006 # The MAN_EXTENSION tag determines the extension that is added to the generated
2007 # man pages. In case the manual section does not start with a number, the number
2008 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2009 # optional.
2010 # The default value is: .3.
2011 # This tag requires that the tag GENERATE_MAN is set to YES.
2012 
2013 MAN_EXTENSION          = .3
2014 
2015 # The MAN_SUBDIR tag determines the name of the directory created within
2016 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2017 # MAN_EXTENSION with the initial . removed.
2018 # This tag requires that the tag GENERATE_MAN is set to YES.
2019 
2020 MAN_SUBDIR             =
2021 
2022 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2023 # will generate one additional man file for each entity documented in the real
2024 # man page(s). These additional files only source the real man page, but without
2025 # them the man command would be unable to find the correct page.
2026 # The default value is: NO.
2027 # This tag requires that the tag GENERATE_MAN is set to YES.
2028 
2029 MAN_LINKS              = NO
2030 
2031 #---------------------------------------------------------------------------
2032 # Configuration options related to the XML output
2033 #---------------------------------------------------------------------------
2034 
2035 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2036 # captures the structure of the code including all documentation.
2037 # The default value is: NO.
2038 
2039 GENERATE_XML           = NO
2040 
2041 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2042 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2043 # it.
2044 # The default directory is: xml.
2045 # This tag requires that the tag GENERATE_XML is set to YES.
2046 
2047 XML_OUTPUT             = xml
2048 
2049 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2050 # listings (including syntax highlighting and cross-referencing information) to
2051 # the XML output. Note that enabling this will significantly increase the size
2052 # of the XML output.
2053 # The default value is: YES.
2054 # This tag requires that the tag GENERATE_XML is set to YES.
2055 
2056 XML_PROGRAMLISTING     = YES
2057 
2058 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2059 # namespace members in file scope as well, matching the HTML output.
2060 # The default value is: NO.
2061 # This tag requires that the tag GENERATE_XML is set to YES.
2062 
2063 XML_NS_MEMB_FILE_SCOPE = NO
2064 
2065 #---------------------------------------------------------------------------
2066 # Configuration options related to the DOCBOOK output
2067 #---------------------------------------------------------------------------
2068 
2069 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2070 # that can be used to generate PDF.
2071 # The default value is: NO.
2072 
2073 GENERATE_DOCBOOK       = NO
2074 
2075 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2076 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2077 # front of it.
2078 # The default directory is: docbook.
2079 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2080 
2081 DOCBOOK_OUTPUT         = docbook
2082 
2083 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
2084 # program listings (including syntax highlighting and cross-referencing
2085 # information) to the DOCBOOK output. Note that enabling this will significantly
2086 # increase the size of the DOCBOOK output.
2087 # The default value is: NO.
2088 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2089 
2090 DOCBOOK_PROGRAMLISTING = NO
2091 
2092 #---------------------------------------------------------------------------
2093 # Configuration options for the AutoGen Definitions output
2094 #---------------------------------------------------------------------------
2095 
2096 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2097 # AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
2098 # the structure of the code including all documentation. Note that this feature
2099 # is still experimental and incomplete at the moment.
2100 # The default value is: NO.
2101 
2102 GENERATE_AUTOGEN_DEF   = NO
2103 
2104 #---------------------------------------------------------------------------
2105 # Configuration options related to the Perl module output
2106 #---------------------------------------------------------------------------
2107 
2108 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2109 # file that captures the structure of the code including all documentation.
2110 #
2111 # Note that this feature is still experimental and incomplete at the moment.
2112 # The default value is: NO.
2113 
2114 GENERATE_PERLMOD       = NO
2115 
2116 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2117 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2118 # output from the Perl module output.
2119 # The default value is: NO.
2120 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2121 
2122 PERLMOD_LATEX          = NO
2123 
2124 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2125 # formatted so it can be parsed by a human reader. This is useful if you want to
2126 # understand what is going on. On the other hand, if this tag is set to NO, the
2127 # size of the Perl module output will be much smaller and Perl will parse it
2128 # just the same.
2129 # The default value is: YES.
2130 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2131 
2132 PERLMOD_PRETTY         = YES
2133 
2134 # The names of the make variables in the generated doxyrules.make file are
2135 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2136 # so different doxyrules.make files included by the same Makefile don't
2137 # overwrite each other's variables.
2138 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2139 
2140 PERLMOD_MAKEVAR_PREFIX =
2141 
2142 #---------------------------------------------------------------------------
2143 # Configuration options related to the preprocessor
2144 #---------------------------------------------------------------------------
2145 
2146 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2147 # C-preprocessor directives found in the sources and include files.
2148 # The default value is: YES.
2149 
2150 ENABLE_PREPROCESSING   = YES
2151 
2152 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2153 # in the source code. If set to NO, only conditional compilation will be
2154 # performed. Macro expansion can be done in a controlled way by setting
2155 # EXPAND_ONLY_PREDEF to YES.
2156 # The default value is: NO.
2157 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2158 
2159 MACRO_EXPANSION        = NO
2160 
2161 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2162 # the macro expansion is limited to the macros specified with the PREDEFINED and
2163 # EXPAND_AS_DEFINED tags.
2164 # The default value is: NO.
2165 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2166 
2167 EXPAND_ONLY_PREDEF     = NO
2168 
2169 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2170 # INCLUDE_PATH will be searched if a #include is found.
2171 # The default value is: YES.
2172 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2173 
2174 SEARCH_INCLUDES        = YES
2175 
2176 # The INCLUDE_PATH tag can be used to specify one or more directories that
2177 # contain include files that are not input files but should be processed by the
2178 # preprocessor.
2179 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2180 
2181 INCLUDE_PATH           =
2182 
2183 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2184 # patterns (like *.h and *.hpp) to filter out the header-files in the
2185 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2186 # used.
2187 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2188 
2189 INCLUDE_FILE_PATTERNS  =
2190 
2191 # The PREDEFINED tag can be used to specify one or more macro names that are
2192 # defined before the preprocessor is started (similar to the -D option of e.g.
2193 # gcc). The argument of the tag is a list of macros of the form: name or
2194 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2195 # is assumed. To prevent a macro definition from being undefined via #undef or
2196 # recursively expanded use the := operator instead of the = operator.
2197 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2198 
2199 PREDEFINED             =
2200 
2201 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2202 # tag can be used to specify a list of macro names that should be expanded. The
2203 # macro definition that is found in the sources will be used. Use the PREDEFINED
2204 # tag if you want to use a different macro definition that overrules the
2205 # definition found in the source code.
2206 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2207 
2208 EXPAND_AS_DEFINED      =
2209 
2210 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2211 # remove all references to function-like macros that are alone on a line, have
2212 # an all uppercase name, and do not end with a semicolon. Such function macros
2213 # are typically used for boiler-plate code, and will confuse the parser if not
2214 # removed.
2215 # The default value is: YES.
2216 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2217 
2218 SKIP_FUNCTION_MACROS   = YES
2219 
2220 #---------------------------------------------------------------------------
2221 # Configuration options related to external references
2222 #---------------------------------------------------------------------------
2223 
2224 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2225 # file the location of the external documentation should be added. The format of
2226 # a tag file without this location is as follows:
2227 # TAGFILES = file1 file2 ...
2228 # Adding location for the tag files is done as follows:
2229 # TAGFILES = file1=loc1 "file2 = loc2" ...
2230 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2231 # section "Linking to external documentation" for more information about the use
2232 # of tag files.
2233 # Note: Each tag file must have a unique name (where the name does NOT include
2234 # the path). If a tag file is not located in the directory in which doxygen is
2235 # run, you must also specify the path to the tagfile here.
2236 
2237 TAGFILES               =
2238 
2239 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2240 # tag file that is based on the input files it reads. See section "Linking to
2241 # external documentation" for more information about the usage of tag files.
2242 
2243 GENERATE_TAGFILE       =
2244 
2245 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2246 # the class index. If set to NO, only the inherited external classes will be
2247 # listed.
2248 # The default value is: NO.
2249 
2250 ALLEXTERNALS           = NO
2251 
2252 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2253 # in the modules index. If set to NO, only the current project's groups will be
2254 # listed.
2255 # The default value is: YES.
2256 
2257 EXTERNAL_GROUPS        = YES
2258 
2259 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2260 # the related pages index. If set to NO, only the current project's pages will
2261 # be listed.
2262 # The default value is: YES.
2263 
2264 EXTERNAL_PAGES         = YES
2265 
2266 #---------------------------------------------------------------------------
2267 # Configuration options related to the dot tool
2268 #---------------------------------------------------------------------------
2269 
2270 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2271 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2272 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2273 # disabled, but it is recommended to install and use dot, since it yields more
2274 # powerful graphs.
2275 # The default value is: YES.
2276 
2277 CLASS_DIAGRAMS         = YES
2278 
2279 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2280 # then run dia to produce the diagram and insert it in the documentation. The
2281 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2282 # If left empty dia is assumed to be found in the default search path.
2283 
2284 DIA_PATH               =
2285 
2286 # If set to YES the inheritance and collaboration graphs will hide inheritance
2287 # and usage relations if the target is undocumented or is not a class.
2288 # The default value is: YES.
2289 
2290 HIDE_UNDOC_RELATIONS   = YES
2291 
2292 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2293 # available from the path. This tool is part of Graphviz (see:
2294 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2295 # Bell Labs. The other options in this section have no effect if this option is
2296 # set to NO
2297 # The default value is: YES.
2298 
2299 HAVE_DOT               = YES
2300 
2301 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2302 # to run in parallel. When set to 0 doxygen will base this on the number of
2303 # processors available in the system. You can set it explicitly to a value
2304 # larger than 0 to get control over the balance between CPU load and processing
2305 # speed.
2306 # Minimum value: 0, maximum value: 32, default value: 0.
2307 # This tag requires that the tag HAVE_DOT is set to YES.
2308 
2309 DOT_NUM_THREADS        = 0
2310 
2311 # When you want a differently looking font in the dot files that doxygen
2312 # generates you can specify the font name using DOT_FONTNAME. You need to make
2313 # sure dot is able to find the font, which can be done by putting it in a
2314 # standard location or by setting the DOTFONTPATH environment variable or by
2315 # setting DOT_FONTPATH to the directory containing the font.
2316 # The default value is: Helvetica.
2317 # This tag requires that the tag HAVE_DOT is set to YES.
2318 
2319 DOT_FONTNAME           = Helvetica
2320 
2321 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2322 # dot graphs.
2323 # Minimum value: 4, maximum value: 24, default value: 10.
2324 # This tag requires that the tag HAVE_DOT is set to YES.
2325 
2326 DOT_FONTSIZE           = 10
2327 
2328 # By default doxygen will tell dot to use the default font as specified with
2329 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2330 # the path where dot can find it using this tag.
2331 # This tag requires that the tag HAVE_DOT is set to YES.
2332 
2333 DOT_FONTPATH           =
2334 
2335 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2336 # each documented class showing the direct and indirect inheritance relations.
2337 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2338 # The default value is: YES.
2339 # This tag requires that the tag HAVE_DOT is set to YES.
2340 
2341 CLASS_GRAPH            = YES
2342 
2343 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2344 # graph for each documented class showing the direct and indirect implementation
2345 # dependencies (inheritance, containment, and class references variables) of the
2346 # class with other documented classes.
2347 # The default value is: YES.
2348 # This tag requires that the tag HAVE_DOT is set to YES.
2349 
2350 COLLABORATION_GRAPH    = YES
2351 
2352 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2353 # groups, showing the direct groups dependencies.
2354 # The default value is: YES.
2355 # This tag requires that the tag HAVE_DOT is set to YES.
2356 
2357 GROUP_GRAPHS           = YES
2358 
2359 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2360 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2361 # Language.
2362 # The default value is: NO.
2363 # This tag requires that the tag HAVE_DOT is set to YES.
2364 
2365 UML_LOOK               = NO
2366 
2367 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2368 # class node. If there are many fields or methods and many nodes the graph may
2369 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2370 # number of items for each type to make the size more manageable. Set this to 0
2371 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2372 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2373 # but if the number exceeds 15, the total amount of fields shown is limited to
2374 # 10.
2375 # Minimum value: 0, maximum value: 100, default value: 10.
2376 # This tag requires that the tag HAVE_DOT is set to YES.
2377 
2378 UML_LIMIT_NUM_FIELDS   = 10
2379 
2380 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2381 # collaboration graphs will show the relations between templates and their
2382 # instances.
2383 # The default value is: NO.
2384 # This tag requires that the tag HAVE_DOT is set to YES.
2385 
2386 TEMPLATE_RELATIONS     = NO
2387 
2388 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2389 # YES then doxygen will generate a graph for each documented file showing the
2390 # 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 INCLUDE_GRAPH          = YES
2396 
2397 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2398 # set to YES then doxygen will generate a graph for each documented file showing
2399 # the direct and indirect include dependencies of the file with other documented
2400 # files.
2401 # The default value is: YES.
2402 # This tag requires that the tag HAVE_DOT is set to YES.
2403 
2404 INCLUDED_BY_GRAPH      = YES
2405 
2406 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2407 # dependency graph for every global function or class method.
2408 #
2409 # Note that enabling this option will significantly increase the time of a run.
2410 # So in most cases it will be better to enable call graphs for selected
2411 # functions only using the \callgraph command. Disabling a call graph can be
2412 # accomplished by means of the command \hidecallgraph.
2413 # The default value is: NO.
2414 # This tag requires that the tag HAVE_DOT is set to YES.
2415 
2416 CALL_GRAPH             = NO
2417 
2418 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2419 # dependency graph for every global function or class method.
2420 #
2421 # Note that enabling this option will significantly increase the time of a run.
2422 # So in most cases it will be better to enable caller graphs for selected
2423 # functions only using the \callergraph command. Disabling a caller graph can be
2424 # accomplished by means of the command \hidecallergraph.
2425 # The default value is: NO.
2426 # This tag requires that the tag HAVE_DOT is set to YES.
2427 
2428 CALLER_GRAPH           = NO
2429 
2430 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2431 # hierarchy of all classes instead of a textual one.
2432 # The default value is: YES.
2433 # This tag requires that the tag HAVE_DOT is set to YES.
2434 
2435 GRAPHICAL_HIERARCHY    = YES
2436 
2437 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2438 # dependencies a directory has on other directories in a graphical way. The
2439 # dependency relations are determined by the #include relations between the
2440 # files in the directories.
2441 # The default value is: YES.
2442 # This tag requires that the tag HAVE_DOT is set to YES.
2443 
2444 DIRECTORY_GRAPH        = YES
2445 
2446 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2447 # generated by dot. For an explanation of the image formats see the section
2448 # output formats in the documentation of the dot tool (Graphviz (see:
2449 # http://www.graphviz.org/)).
2450 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2451 # to make the SVG files visible in IE 9+ (other browsers do not have this
2452 # requirement).
2453 # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2454 # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2455 # gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
2456 # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2457 # png:gdiplus:gdiplus.
2458 # The default value is: png.
2459 # This tag requires that the tag HAVE_DOT is set to YES.
2460 
2461 DOT_IMAGE_FORMAT       = svg
2462 
2463 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2464 # enable generation of interactive SVG images that allow zooming and panning.
2465 #
2466 # Note that this requires a modern browser other than Internet Explorer. Tested
2467 # and working are Firefox, Chrome, Safari, and Opera.
2468 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2469 # the SVG files visible. Older versions of IE do not have SVG support.
2470 # The default value is: NO.
2471 # This tag requires that the tag HAVE_DOT is set to YES.
2472 
2473 INTERACTIVE_SVG        = NO
2474 
2475 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2476 # found. If left blank, it is assumed the dot tool can be found in the path.
2477 # This tag requires that the tag HAVE_DOT is set to YES.
2478 
2479 DOT_PATH               =
2480 
2481 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2482 # contain dot files that are included in the documentation (see the \dotfile
2483 # command).
2484 # This tag requires that the tag HAVE_DOT is set to YES.
2485 
2486 DOTFILE_DIRS           =
2487 
2488 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2489 # contain msc files that are included in the documentation (see the \mscfile
2490 # command).
2491 
2492 MSCFILE_DIRS           =
2493 
2494 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2495 # contain dia files that are included in the documentation (see the \diafile
2496 # command).
2497 
2498 DIAFILE_DIRS           =
2499 
2500 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2501 # path where java can find the plantuml.jar file. If left blank, it is assumed
2502 # PlantUML is not used or called during a preprocessing step. Doxygen will
2503 # generate a warning when it encounters a \startuml command in this case and
2504 # will not generate output for the diagram.
2505 
2506 PLANTUML_JAR_PATH      =
2507 
2508 # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2509 # configuration file for plantuml.
2510 
2511 PLANTUML_CFG_FILE      =
2512 
2513 # When using plantuml, the specified paths are searched for files specified by
2514 # the !include statement in a plantuml block.
2515 
2516 PLANTUML_INCLUDE_PATH  =
2517 
2518 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2519 # that will be shown in the graph. If the number of nodes in a graph becomes
2520 # larger than this value, doxygen will truncate the graph, which is visualized
2521 # by representing a node as a red box. Note that doxygen if the number of direct
2522 # children of the root node in a graph is already larger than
2523 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2524 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2525 # Minimum value: 0, maximum value: 10000, default value: 50.
2526 # This tag requires that the tag HAVE_DOT is set to YES.
2527 
2528 DOT_GRAPH_MAX_NODES    = 50
2529 
2530 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2531 # generated by dot. A depth value of 3 means that only nodes reachable from the
2532 # root by following a path via at most 3 edges will be shown. Nodes that lay
2533 # further from the root node will be omitted. Note that setting this option to 1
2534 # or 2 may greatly reduce the computation time needed for large code bases. Also
2535 # note that the size of a graph can be further restricted by
2536 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2537 # Minimum value: 0, maximum value: 1000, default value: 0.
2538 # This tag requires that the tag HAVE_DOT is set to YES.
2539 
2540 MAX_DOT_GRAPH_DEPTH    = 0
2541 
2542 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2543 # background. This is disabled by default, because dot on Windows does not seem
2544 # to support this out of the box.
2545 #
2546 # Warning: Depending on the platform used, enabling this option may lead to
2547 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2548 # read).
2549 # The default value is: NO.
2550 # This tag requires that the tag HAVE_DOT is set to YES.
2551 
2552 DOT_TRANSPARENT        = NO
2553 
2554 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2555 # files in one run (i.e. multiple -o and -T options on the command line). This
2556 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2557 # this, this feature is disabled by default.
2558 # The default value is: NO.
2559 # This tag requires that the tag HAVE_DOT is set to YES.
2560 
2561 DOT_MULTI_TARGETS      = NO
2562 
2563 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2564 # explaining the meaning of the various boxes and arrows in the dot generated
2565 # graphs.
2566 # The default value is: YES.
2567 # This tag requires that the tag HAVE_DOT is set to YES.
2568 
2569 GENERATE_LEGEND        = YES
2570 
2571 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2572 # files that are used to generate the various graphs.
2573 # The default value is: YES.
2574 # This tag requires that the tag HAVE_DOT is set to YES.
2575 
2576 DOT_CLEANUP            = YES
2577