Warning, /multimedia/kwave/doxy.cfg.in is written in an unsupported language. File is not indexed.

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