Warning, /multimedia/kid3/Doxyfile is written in an unsupported language. File is not indexed.

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