Warning, /libraries/perceptualcolor/docs/Doxyfile.internal is written in an unsupported language. File is not indexed.

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