Warning, /graphics/glaxnimate/Doxyfile.in is written in an unsupported language. File is not indexed.

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