annotate Doxyfile @ 196:da283326bcd3 tip master

Update plugin versions in RDF
author Chris Cannam <cannam@all-day-breakfast.com>
date Fri, 28 Feb 2020 09:43:02 +0000
parents b1db858e0541
children
rev   line source
c@148 1 # Doxyfile 1.8.7
c@148 2
c@148 3 # This file describes the settings to be used by the documentation system
c@148 4 # doxygen (www.doxygen.org) for a project.
c@148 5 #
c@148 6 # All text after a double hash (##) is considered a comment and is placed in
c@148 7 # front of the TAG it is preceding.
c@148 8 #
c@148 9 # All text after a single hash (#) is considered a comment and will be ignored.
c@148 10 # The format is:
c@148 11 # TAG = value [value, ...]
c@148 12 # For lists, items can also be appended using:
c@148 13 # TAG += value [value, ...]
c@148 14 # Values that contain spaces should be placed between quotes (\" \").
c@148 15
c@148 16 #---------------------------------------------------------------------------
c@148 17 # Project related configuration options
c@148 18 #---------------------------------------------------------------------------
c@148 19
c@148 20 # This tag specifies the encoding used for all characters in the config file
c@148 21 # that follow. The default is UTF-8 which is also the encoding used for all text
c@148 22 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
c@148 23 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
c@148 24 # for the list of possible encodings.
c@148 25 # The default value is: UTF-8.
c@148 26
c@148 27 DOXYFILE_ENCODING = UTF-8
c@148 28
c@148 29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
c@148 30 # double-quotes, unless you are using Doxywizard) that should identify the
c@148 31 # project for which the documentation is generated. This name is used in the
c@148 32 # title of most generated pages and in a few other places.
c@148 33 # The default value is: My Project.
c@148 34
c@148 35 PROJECT_NAME = "Constant-Q Library"
c@148 36
c@148 37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
c@148 38 # could be handy for archiving the generated documentation or if some version
c@148 39 # control system is used.
c@148 40
c@148 41 PROJECT_NUMBER =
c@148 42
c@148 43 # Using the PROJECT_BRIEF tag one can provide an optional one line description
c@148 44 # for a project that appears at the top of each page and should give viewer a
c@148 45 # quick idea about the purpose of the project. Keep the description short.
c@148 46
c@148 47 PROJECT_BRIEF =
c@148 48
c@148 49 # With the PROJECT_LOGO tag one can specify an logo or icon that is included in
c@148 50 # the documentation. The maximum height of the logo should not exceed 55 pixels
c@148 51 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
c@148 52 # to the output directory.
c@148 53
c@148 54 PROJECT_LOGO =
c@148 55
c@148 56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
c@148 57 # into which the generated documentation will be written. If a relative path is
c@148 58 # entered, it will be relative to the location where doxygen was started. If
c@148 59 # left blank the current directory will be used.
c@148 60
c@148 61 OUTPUT_DIRECTORY = doc
c@148 62
c@148 63 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
c@148 64 # directories (in 2 levels) under the output directory of each output format and
c@148 65 # will distribute the generated files over these directories. Enabling this
c@148 66 # option can be useful when feeding doxygen a huge amount of source files, where
c@148 67 # putting all generated files in the same directory would otherwise causes
c@148 68 # performance problems for the file system.
c@148 69 # The default value is: NO.
c@148 70
c@148 71 CREATE_SUBDIRS = NO
c@148 72
c@148 73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
c@148 74 # characters to appear in the names of generated files. If set to NO, non-ASCII
c@148 75 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
c@148 76 # U+3044.
c@148 77 # The default value is: NO.
c@148 78
c@148 79 ALLOW_UNICODE_NAMES = NO
c@148 80
c@148 81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
c@148 82 # documentation generated by doxygen is written. Doxygen will use this
c@148 83 # information to generate all constant output in the proper language.
c@148 84 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
c@148 85 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
c@148 86 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
c@148 87 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
c@148 88 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
c@148 89 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
c@148 90 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
c@148 91 # Ukrainian and Vietnamese.
c@148 92 # The default value is: English.
c@148 93
c@148 94 OUTPUT_LANGUAGE = English
c@148 95
c@148 96 # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
c@148 97 # descriptions after the members that are listed in the file and class
c@148 98 # documentation (similar to Javadoc). Set to NO to disable this.
c@148 99 # The default value is: YES.
c@148 100
c@148 101 BRIEF_MEMBER_DESC = YES
c@148 102
c@148 103 # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
c@148 104 # description of a member or function before the detailed description
c@148 105 #
c@148 106 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
c@148 107 # brief descriptions will be completely suppressed.
c@148 108 # The default value is: YES.
c@148 109
c@148 110 REPEAT_BRIEF = YES
c@148 111
c@148 112 # This tag implements a quasi-intelligent brief description abbreviator that is
c@148 113 # used to form the text in various listings. Each string in this list, if found
c@148 114 # as the leading text of the brief description, will be stripped from the text
c@148 115 # and the result, after processing the whole list, is used as the annotated
c@148 116 # text. Otherwise, the brief description is used as-is. If left blank, the
c@148 117 # following values are used ($name is automatically replaced with the name of
c@148 118 # the entity):The $name class, The $name widget, The $name file, is, provides,
c@148 119 # specifies, contains, represents, a, an and the.
c@148 120
c@148 121 ABBREVIATE_BRIEF =
c@148 122
c@148 123 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
c@148 124 # doxygen will generate a detailed section even if there is only a brief
c@148 125 # description.
c@148 126 # The default value is: NO.
c@148 127
c@148 128 ALWAYS_DETAILED_SEC = NO
c@148 129
c@148 130 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
c@148 131 # inherited members of a class in the documentation of that class as if those
c@148 132 # members were ordinary class members. Constructors, destructors and assignment
c@148 133 # operators of the base classes will not be shown.
c@148 134 # The default value is: NO.
c@148 135
c@148 136 INLINE_INHERITED_MEMB = NO
c@148 137
c@148 138 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
c@148 139 # before files name in the file list and in the header files. If set to NO the
c@148 140 # shortest path that makes the file name unique will be used
c@148 141 # The default value is: YES.
c@148 142
c@148 143 FULL_PATH_NAMES = YES
c@148 144
c@148 145 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
c@148 146 # Stripping is only done if one of the specified strings matches the left-hand
c@148 147 # part of the path. The tag can be used to show relative paths in the file list.
c@148 148 # If left blank the directory from which doxygen is run is used as the path to
c@148 149 # strip.
c@148 150 #
c@148 151 # Note that you can specify absolute paths here, but also relative paths, which
c@148 152 # will be relative from the directory where doxygen is started.
c@148 153 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
c@148 154
c@148 155 STRIP_FROM_PATH =
c@148 156
c@148 157 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
c@148 158 # path mentioned in the documentation of a class, which tells the reader which
c@148 159 # header file to include in order to use a class. If left blank only the name of
c@148 160 # the header file containing the class definition is used. Otherwise one should
c@148 161 # specify the list of include paths that are normally passed to the compiler
c@148 162 # using the -I flag.
c@148 163
c@148 164 STRIP_FROM_INC_PATH =
c@148 165
c@148 166 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
c@148 167 # less readable) file names. This can be useful is your file systems doesn't
c@148 168 # support long names like on DOS, Mac, or CD-ROM.
c@148 169 # The default value is: NO.
c@148 170
c@148 171 SHORT_NAMES = NO
c@148 172
c@148 173 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
c@148 174 # first line (until the first dot) of a Javadoc-style comment as the brief
c@148 175 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
c@148 176 # style comments (thus requiring an explicit @brief command for a brief
c@148 177 # description.)
c@148 178 # The default value is: NO.
c@148 179
c@148 180 JAVADOC_AUTOBRIEF = NO
c@148 181
c@148 182 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
c@148 183 # line (until the first dot) of a Qt-style comment as the brief description. If
c@148 184 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
c@148 185 # requiring an explicit \brief command for a brief description.)
c@148 186 # The default value is: NO.
c@148 187
c@148 188 QT_AUTOBRIEF = NO
c@148 189
c@148 190 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
c@148 191 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
c@148 192 # a brief description. This used to be the default behavior. The new default is
c@148 193 # to treat a multi-line C++ comment block as a detailed description. Set this
c@148 194 # tag to YES if you prefer the old behavior instead.
c@148 195 #
c@148 196 # Note that setting this tag to YES also means that rational rose comments are
c@148 197 # not recognized any more.
c@148 198 # The default value is: NO.
c@148 199
c@148 200 MULTILINE_CPP_IS_BRIEF = NO
c@148 201
c@148 202 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
c@148 203 # documentation from any documented member that it re-implements.
c@148 204 # The default value is: YES.
c@148 205
c@148 206 INHERIT_DOCS = YES
c@148 207
c@148 208 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
c@148 209 # new page for each member. If set to NO, the documentation of a member will be
c@148 210 # part of the file/class/namespace that contains it.
c@148 211 # The default value is: NO.
c@148 212
c@148 213 SEPARATE_MEMBER_PAGES = NO
c@148 214
c@148 215 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
c@148 216 # uses this value to replace tabs by spaces in code fragments.
c@148 217 # Minimum value: 1, maximum value: 16, default value: 4.
c@148 218
c@148 219 TAB_SIZE = 4
c@148 220
c@148 221 # This tag can be used to specify a number of aliases that act as commands in
c@148 222 # the documentation. An alias has the form:
c@148 223 # name=value
c@148 224 # For example adding
c@148 225 # "sideeffect=@par Side Effects:\n"
c@148 226 # will allow you to put the command \sideeffect (or @sideeffect) in the
c@148 227 # documentation, which will result in a user-defined paragraph with heading
c@148 228 # "Side Effects:". You can put \n's in the value part of an alias to insert
c@148 229 # newlines.
c@148 230
c@148 231 ALIASES =
c@148 232
c@148 233 # This tag can be used to specify a number of word-keyword mappings (TCL only).
c@148 234 # A mapping has the form "name=value". For example adding "class=itcl::class"
c@148 235 # will allow you to use the command class in the itcl::class meaning.
c@148 236
c@148 237 TCL_SUBST =
c@148 238
c@148 239 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
c@148 240 # only. Doxygen will then generate output that is more tailored for C. For
c@148 241 # instance, some of the names that are used will be different. The list of all
c@148 242 # members will be omitted, etc.
c@148 243 # The default value is: NO.
c@148 244
c@148 245 OPTIMIZE_OUTPUT_FOR_C = NO
c@148 246
c@148 247 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
c@148 248 # Python sources only. Doxygen will then generate output that is more tailored
c@148 249 # for that language. For instance, namespaces will be presented as packages,
c@148 250 # qualified scopes will look different, etc.
c@148 251 # The default value is: NO.
c@148 252
c@148 253 OPTIMIZE_OUTPUT_JAVA = NO
c@148 254
c@148 255 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
c@148 256 # sources. Doxygen will then generate output that is tailored for Fortran.
c@148 257 # The default value is: NO.
c@148 258
c@148 259 OPTIMIZE_FOR_FORTRAN = NO
c@148 260
c@148 261 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
c@148 262 # sources. Doxygen will then generate output that is tailored for VHDL.
c@148 263 # The default value is: NO.
c@148 264
c@148 265 OPTIMIZE_OUTPUT_VHDL = NO
c@148 266
c@148 267 # Doxygen selects the parser to use depending on the extension of the files it
c@148 268 # parses. With this tag you can assign which parser to use for a given
c@148 269 # extension. Doxygen has a built-in mapping, but you can override or extend it
c@148 270 # using this tag. The format is ext=language, where ext is a file extension, and
c@148 271 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
c@148 272 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
c@148 273 # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
c@148 274 # Fortran. In the later case the parser tries to guess whether the code is fixed
c@148 275 # or free formatted code, this is the default for Fortran type files), VHDL. For
c@148 276 # instance to make doxygen treat .inc files as Fortran files (default is PHP),
c@148 277 # and .f files as C (default is Fortran), use: inc=Fortran f=C.
c@148 278 #
c@148 279 # Note For files without extension you can use no_extension as a placeholder.
c@148 280 #
c@148 281 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
c@148 282 # the files are not read by doxygen.
c@148 283
c@148 284 EXTENSION_MAPPING =
c@148 285
c@148 286 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
c@148 287 # according to the Markdown format, which allows for more readable
c@148 288 # documentation. See http://daringfireball.net/projects/markdown/ for details.
c@148 289 # The output of markdown processing is further processed by doxygen, so you can
c@148 290 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
c@148 291 # case of backward compatibilities issues.
c@148 292 # The default value is: YES.
c@148 293
c@148 294 MARKDOWN_SUPPORT = YES
c@148 295
c@148 296 # When enabled doxygen tries to link words that correspond to documented
c@148 297 # classes, or namespaces to their corresponding documentation. Such a link can
c@148 298 # be prevented in individual cases by by putting a % sign in front of the word
c@148 299 # or globally by setting AUTOLINK_SUPPORT to NO.
c@148 300 # The default value is: YES.
c@148 301
c@148 302 AUTOLINK_SUPPORT = YES
c@148 303
c@148 304 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
c@148 305 # to include (a tag file for) the STL sources as input, then you should set this
c@148 306 # tag to YES in order to let doxygen match functions declarations and
c@148 307 # definitions whose arguments contain STL classes (e.g. func(std::string);
c@148 308 # versus func(std::string) {}). This also make the inheritance and collaboration
c@148 309 # diagrams that involve STL classes more complete and accurate.
c@148 310 # The default value is: NO.
c@148 311
c@148 312 BUILTIN_STL_SUPPORT = NO
c@148 313
c@148 314 # If you use Microsoft's C++/CLI language, you should set this option to YES to
c@148 315 # enable parsing support.
c@148 316 # The default value is: NO.
c@148 317
c@148 318 CPP_CLI_SUPPORT = NO
c@148 319
c@148 320 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
c@148 321 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
c@148 322 # will parse them like normal C++ but will assume all classes use public instead
c@148 323 # of private inheritance when no explicit protection keyword is present.
c@148 324 # The default value is: NO.
c@148 325
c@148 326 SIP_SUPPORT = NO
c@148 327
c@148 328 # For Microsoft's IDL there are propget and propput attributes to indicate
c@148 329 # getter and setter methods for a property. Setting this option to YES will make
c@148 330 # doxygen to replace the get and set methods by a property in the documentation.
c@148 331 # This will only work if the methods are indeed getting or setting a simple
c@148 332 # type. If this is not the case, or you want to show the methods anyway, you
c@148 333 # should set this option to NO.
c@148 334 # The default value is: YES.
c@148 335
c@148 336 IDL_PROPERTY_SUPPORT = YES
c@148 337
c@148 338 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
c@148 339 # tag is set to YES, then doxygen will reuse the documentation of the first
c@148 340 # member in the group (if any) for the other members of the group. By default
c@148 341 # all members of a group must be documented explicitly.
c@148 342 # The default value is: NO.
c@148 343
c@148 344 DISTRIBUTE_GROUP_DOC = NO
c@148 345
c@148 346 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
c@148 347 # (for instance a group of public functions) to be put as a subgroup of that
c@148 348 # type (e.g. under the Public Functions section). Set it to NO to prevent
c@148 349 # subgrouping. Alternatively, this can be done per class using the
c@148 350 # \nosubgrouping command.
c@148 351 # The default value is: YES.
c@148 352
c@148 353 SUBGROUPING = YES
c@148 354
c@148 355 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
c@148 356 # are shown inside the group in which they are included (e.g. using \ingroup)
c@148 357 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
c@148 358 # and RTF).
c@148 359 #
c@148 360 # Note that this feature does not work in combination with
c@148 361 # SEPARATE_MEMBER_PAGES.
c@148 362 # The default value is: NO.
c@148 363
c@148 364 INLINE_GROUPED_CLASSES = NO
c@148 365
c@148 366 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
c@148 367 # with only public data fields or simple typedef fields will be shown inline in
c@148 368 # the documentation of the scope in which they are defined (i.e. file,
c@148 369 # namespace, or group documentation), provided this scope is documented. If set
c@148 370 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
c@148 371 # Man pages) or section (for LaTeX and RTF).
c@148 372 # The default value is: NO.
c@148 373
c@148 374 INLINE_SIMPLE_STRUCTS = NO
c@148 375
c@148 376 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
c@148 377 # enum is documented as struct, union, or enum with the name of the typedef. So
c@148 378 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
c@148 379 # with name TypeT. When disabled the typedef will appear as a member of a file,
c@148 380 # namespace, or class. And the struct will be named TypeS. This can typically be
c@148 381 # useful for C code in case the coding convention dictates that all compound
c@148 382 # types are typedef'ed and only the typedef is referenced, never the tag name.
c@148 383 # The default value is: NO.
c@148 384
c@148 385 TYPEDEF_HIDES_STRUCT = NO
c@148 386
c@148 387 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
c@148 388 # cache is used to resolve symbols given their name and scope. Since this can be
c@148 389 # an expensive process and often the same symbol appears multiple times in the
c@148 390 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
c@148 391 # doxygen will become slower. If the cache is too large, memory is wasted. The
c@148 392 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
c@148 393 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
c@148 394 # symbols. At the end of a run doxygen will report the cache usage and suggest
c@148 395 # the optimal cache size from a speed point of view.
c@148 396 # Minimum value: 0, maximum value: 9, default value: 0.
c@148 397
c@148 398 LOOKUP_CACHE_SIZE = 0
c@148 399
c@148 400 #---------------------------------------------------------------------------
c@148 401 # Build related configuration options
c@148 402 #---------------------------------------------------------------------------
c@148 403
c@148 404 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
c@148 405 # documentation are documented, even if no documentation was available. Private
c@148 406 # class members and static file members will be hidden unless the
c@148 407 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
c@148 408 # Note: This will also disable the warnings about undocumented members that are
c@148 409 # normally produced when WARNINGS is set to YES.
c@148 410 # The default value is: NO.
c@148 411
c@148 412 EXTRACT_ALL = YES
c@148 413
c@148 414 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
c@148 415 # be included in the documentation.
c@148 416 # The default value is: NO.
c@148 417
c@148 418 EXTRACT_PRIVATE = NO
c@148 419
c@148 420 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
c@148 421 # scope will be included in the documentation.
c@148 422 # The default value is: NO.
c@148 423
c@148 424 EXTRACT_PACKAGE = NO
c@148 425
c@148 426 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
c@148 427 # included in the documentation.
c@148 428 # The default value is: NO.
c@148 429
c@148 430 EXTRACT_STATIC = NO
c@148 431
c@148 432 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
c@148 433 # locally in source files will be included in the documentation. If set to NO
c@148 434 # only classes defined in header files are included. Does not have any effect
c@148 435 # for Java sources.
c@148 436 # The default value is: YES.
c@148 437
c@148 438 EXTRACT_LOCAL_CLASSES = YES
c@148 439
c@148 440 # This flag is only useful for Objective-C code. When set to YES local methods,
c@148 441 # which are defined in the implementation section but not in the interface are
c@148 442 # included in the documentation. If set to NO only methods in the interface are
c@148 443 # included.
c@148 444 # The default value is: NO.
c@148 445
c@148 446 EXTRACT_LOCAL_METHODS = NO
c@148 447
c@148 448 # If this flag is set to YES, the members of anonymous namespaces will be
c@148 449 # extracted and appear in the documentation as a namespace called
c@148 450 # 'anonymous_namespace{file}', where file will be replaced with the base name of
c@148 451 # the file that contains the anonymous namespace. By default anonymous namespace
c@148 452 # are hidden.
c@148 453 # The default value is: NO.
c@148 454
c@148 455 EXTRACT_ANON_NSPACES = NO
c@148 456
c@148 457 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
c@148 458 # undocumented members inside documented classes or files. If set to NO these
c@148 459 # members will be included in the various overviews, but no documentation
c@148 460 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
c@148 461 # The default value is: NO.
c@148 462
c@148 463 HIDE_UNDOC_MEMBERS = NO
c@148 464
c@148 465 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
c@148 466 # undocumented classes that are normally visible in the class hierarchy. If set
c@148 467 # to NO these classes will be included in the various overviews. This option has
c@148 468 # no effect if EXTRACT_ALL is enabled.
c@148 469 # The default value is: NO.
c@148 470
c@148 471 HIDE_UNDOC_CLASSES = NO
c@148 472
c@148 473 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
c@148 474 # (class|struct|union) declarations. If set to NO these declarations will be
c@148 475 # included in the documentation.
c@148 476 # The default value is: NO.
c@148 477
c@148 478 HIDE_FRIEND_COMPOUNDS = NO
c@148 479
c@148 480 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
c@148 481 # documentation blocks found inside the body of a function. If set to NO these
c@148 482 # blocks will be appended to the function's detailed documentation block.
c@148 483 # The default value is: NO.
c@148 484
c@148 485 HIDE_IN_BODY_DOCS = NO
c@148 486
c@148 487 # The INTERNAL_DOCS tag determines if documentation that is typed after a
c@148 488 # \internal command is included. If the tag is set to NO then the documentation
c@148 489 # will be excluded. Set it to YES to include the internal documentation.
c@148 490 # The default value is: NO.
c@148 491
c@148 492 INTERNAL_DOCS = NO
c@148 493
c@148 494 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
c@148 495 # names in lower-case letters. If set to YES upper-case letters are also
c@148 496 # allowed. This is useful if you have classes or files whose names only differ
c@148 497 # in case and if your file system supports case sensitive file names. Windows
c@148 498 # and Mac users are advised to set this option to NO.
c@148 499 # The default value is: system dependent.
c@148 500
c@148 501 CASE_SENSE_NAMES = YES
c@148 502
c@148 503 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
c@148 504 # their full class and namespace scopes in the documentation. If set to YES the
c@148 505 # scope will be hidden.
c@148 506 # The default value is: NO.
c@148 507
c@148 508 HIDE_SCOPE_NAMES = NO
c@148 509
c@148 510 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
c@148 511 # the files that are included by a file in the documentation of that file.
c@148 512 # The default value is: YES.
c@148 513
c@148 514 SHOW_INCLUDE_FILES = YES
c@148 515
c@148 516 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
c@148 517 # grouped member an include statement to the documentation, telling the reader
c@148 518 # which file to include in order to use the member.
c@148 519 # The default value is: NO.
c@148 520
c@148 521 SHOW_GROUPED_MEMB_INC = NO
c@148 522
c@148 523 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
c@148 524 # files with double quotes in the documentation rather than with sharp brackets.
c@148 525 # The default value is: NO.
c@148 526
c@148 527 FORCE_LOCAL_INCLUDES = NO
c@148 528
c@148 529 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
c@148 530 # documentation for inline members.
c@148 531 # The default value is: YES.
c@148 532
c@148 533 INLINE_INFO = YES
c@148 534
c@148 535 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
c@148 536 # (detailed) documentation of file and class members alphabetically by member
c@148 537 # name. If set to NO the members will appear in declaration order.
c@148 538 # The default value is: YES.
c@148 539
c@148 540 SORT_MEMBER_DOCS = YES
c@148 541
c@148 542 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
c@148 543 # descriptions of file, namespace and class members alphabetically by member
c@148 544 # name. If set to NO the members will appear in declaration order. Note that
c@148 545 # this will also influence the order of the classes in the class list.
c@148 546 # The default value is: NO.
c@148 547
c@148 548 SORT_BRIEF_DOCS = NO
c@148 549
c@148 550 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
c@148 551 # (brief and detailed) documentation of class members so that constructors and
c@148 552 # destructors are listed first. If set to NO the constructors will appear in the
c@148 553 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
c@148 554 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
c@148 555 # member documentation.
c@148 556 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
c@148 557 # detailed member documentation.
c@148 558 # The default value is: NO.
c@148 559
c@148 560 SORT_MEMBERS_CTORS_1ST = NO
c@148 561
c@148 562 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
c@148 563 # of group names into alphabetical order. If set to NO the group names will
c@148 564 # appear in their defined order.
c@148 565 # The default value is: NO.
c@148 566
c@148 567 SORT_GROUP_NAMES = NO
c@148 568
c@148 569 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
c@148 570 # fully-qualified names, including namespaces. If set to NO, the class list will
c@148 571 # be sorted only by class name, not including the namespace part.
c@148 572 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
c@148 573 # Note: This option applies only to the class list, not to the alphabetical
c@148 574 # list.
c@148 575 # The default value is: NO.
c@148 576
c@148 577 SORT_BY_SCOPE_NAME = NO
c@148 578
c@148 579 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
c@148 580 # type resolution of all parameters of a function it will reject a match between
c@148 581 # the prototype and the implementation of a member function even if there is
c@148 582 # only one candidate or it is obvious which candidate to choose by doing a
c@148 583 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
c@148 584 # accept a match between prototype and implementation in such cases.
c@148 585 # The default value is: NO.
c@148 586
c@148 587 STRICT_PROTO_MATCHING = NO
c@148 588
c@148 589 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
c@148 590 # todo list. This list is created by putting \todo commands in the
c@148 591 # documentation.
c@148 592 # The default value is: YES.
c@148 593
c@148 594 GENERATE_TODOLIST = YES
c@148 595
c@148 596 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
c@148 597 # test list. This list is created by putting \test commands in the
c@148 598 # documentation.
c@148 599 # The default value is: YES.
c@148 600
c@148 601 GENERATE_TESTLIST = YES
c@148 602
c@148 603 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
c@148 604 # list. This list is created by putting \bug commands in the documentation.
c@148 605 # The default value is: YES.
c@148 606
c@148 607 GENERATE_BUGLIST = YES
c@148 608
c@148 609 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
c@148 610 # the deprecated list. This list is created by putting \deprecated commands in
c@148 611 # the documentation.
c@148 612 # The default value is: YES.
c@148 613
c@148 614 GENERATE_DEPRECATEDLIST= YES
c@148 615
c@148 616 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
c@148 617 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
c@148 618 # ... \endcond blocks.
c@148 619
c@148 620 ENABLED_SECTIONS =
c@148 621
c@148 622 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
c@148 623 # initial value of a variable or macro / define can have for it to appear in the
c@148 624 # documentation. If the initializer consists of more lines than specified here
c@148 625 # it will be hidden. Use a value of 0 to hide initializers completely. The
c@148 626 # appearance of the value of individual variables and macros / defines can be
c@148 627 # controlled using \showinitializer or \hideinitializer command in the
c@148 628 # documentation regardless of this setting.
c@148 629 # Minimum value: 0, maximum value: 10000, default value: 30.
c@148 630
c@148 631 MAX_INITIALIZER_LINES = 30
c@148 632
c@148 633 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
c@148 634 # the bottom of the documentation of classes and structs. If set to YES the list
c@148 635 # will mention the files that were used to generate the documentation.
c@148 636 # The default value is: YES.
c@148 637
c@148 638 SHOW_USED_FILES = YES
c@148 639
c@148 640 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
c@148 641 # will remove the Files entry from the Quick Index and from the Folder Tree View
c@148 642 # (if specified).
c@148 643 # The default value is: YES.
c@148 644
c@148 645 SHOW_FILES = YES
c@148 646
c@148 647 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
c@148 648 # page. This will remove the Namespaces entry from the Quick Index and from the
c@148 649 # Folder Tree View (if specified).
c@148 650 # The default value is: YES.
c@148 651
c@148 652 SHOW_NAMESPACES = YES
c@148 653
c@148 654 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
c@148 655 # doxygen should invoke to get the current version for each file (typically from
c@148 656 # the version control system). Doxygen will invoke the program by executing (via
c@148 657 # popen()) the command command input-file, where command is the value of the
c@148 658 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
c@148 659 # by doxygen. Whatever the program writes to standard output is used as the file
c@148 660 # version. For an example see the documentation.
c@148 661
c@148 662 FILE_VERSION_FILTER =
c@148 663
c@148 664 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
c@148 665 # by doxygen. The layout file controls the global structure of the generated
c@148 666 # output files in an output format independent way. To create the layout file
c@148 667 # that represents doxygen's defaults, run doxygen with the -l option. You can
c@148 668 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
c@148 669 # will be used as the name of the layout file.
c@148 670 #
c@148 671 # Note that if you run doxygen from a directory containing a file called
c@148 672 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
c@148 673 # tag is left empty.
c@148 674
c@148 675 LAYOUT_FILE =
c@148 676
c@148 677 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
c@148 678 # the reference definitions. This must be a list of .bib files. The .bib
c@148 679 # extension is automatically appended if omitted. This requires the bibtex tool
c@148 680 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
c@148 681 # For LaTeX the style of the bibliography can be controlled using
c@148 682 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
c@148 683 # search path. Do not use file names with spaces, bibtex cannot handle them. See
c@148 684 # also \cite for info how to create references.
c@148 685
c@148 686 CITE_BIB_FILES =
c@148 687
c@148 688 #---------------------------------------------------------------------------
c@148 689 # Configuration options related to warning and progress messages
c@148 690 #---------------------------------------------------------------------------
c@148 691
c@148 692 # The QUIET tag can be used to turn on/off the messages that are generated to
c@148 693 # standard output by doxygen. If QUIET is set to YES this implies that the
c@148 694 # messages are off.
c@148 695 # The default value is: NO.
c@148 696
c@148 697 QUIET = NO
c@148 698
c@148 699 # The WARNINGS tag can be used to turn on/off the warning messages that are
c@148 700 # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
c@148 701 # this implies that the warnings are on.
c@148 702 #
c@148 703 # Tip: Turn warnings on while writing the documentation.
c@148 704 # The default value is: YES.
c@148 705
c@148 706 WARNINGS = YES
c@148 707
c@148 708 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
c@148 709 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
c@148 710 # will automatically be disabled.
c@148 711 # The default value is: YES.
c@148 712
c@148 713 WARN_IF_UNDOCUMENTED = YES
c@148 714
c@148 715 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
c@148 716 # potential errors in the documentation, such as not documenting some parameters
c@148 717 # in a documented function, or documenting parameters that don't exist or using
c@148 718 # markup commands wrongly.
c@148 719 # The default value is: YES.
c@148 720
c@148 721 WARN_IF_DOC_ERROR = YES
c@148 722
c@148 723 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
c@148 724 # are documented, but have no documentation for their parameters or return
c@148 725 # value. If set to NO doxygen will only warn about wrong or incomplete parameter
c@148 726 # documentation, but not about the absence of documentation.
c@148 727 # The default value is: NO.
c@148 728
c@148 729 WARN_NO_PARAMDOC = NO
c@148 730
c@148 731 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
c@148 732 # can produce. The string should contain the $file, $line, and $text tags, which
c@148 733 # will be replaced by the file and line number from which the warning originated
c@148 734 # and the warning text. Optionally the format may contain $version, which will
c@148 735 # be replaced by the version of the file (if it could be obtained via
c@148 736 # FILE_VERSION_FILTER)
c@148 737 # The default value is: $file:$line: $text.
c@148 738
c@148 739 WARN_FORMAT = "$file:$line: $text"
c@148 740
c@148 741 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
c@148 742 # messages should be written. If left blank the output is written to standard
c@148 743 # error (stderr).
c@148 744
c@148 745 WARN_LOGFILE =
c@148 746
c@148 747 #---------------------------------------------------------------------------
c@148 748 # Configuration options related to the input files
c@148 749 #---------------------------------------------------------------------------
c@148 750
c@148 751 # The INPUT tag is used to specify the files and/or directories that contain
c@148 752 # documented source files. You may enter file names like myfile.cpp or
c@148 753 # directories like /usr/src/myproject. Separate the files or directories with
c@148 754 # spaces.
c@148 755 # Note: If this tag is empty the current directory is searched.
c@148 756
c@148 757 INPUT = cq src vamp
c@148 758
c@148 759 # This tag can be used to specify the character encoding of the source files
c@148 760 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
c@148 761 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
c@148 762 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
c@148 763 # possible encodings.
c@148 764 # The default value is: UTF-8.
c@148 765
c@148 766 INPUT_ENCODING = UTF-8
c@148 767
c@148 768 # If the value of the INPUT tag contains directories, you can use the
c@148 769 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
c@148 770 # *.h) to filter out the source-files in the directories. If left blank the
c@148 771 # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
c@148 772 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
c@148 773 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
c@148 774 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
c@148 775 # *.qsf, *.as and *.js.
c@148 776
c@148 777 FILE_PATTERNS =
c@148 778
c@148 779 # The RECURSIVE tag can be used to specify whether or not subdirectories should
c@148 780 # be searched for input files as well.
c@148 781 # The default value is: NO.
c@148 782
c@148 783 RECURSIVE = NO
c@148 784
c@148 785 # The EXCLUDE tag can be used to specify files and/or directories that should be
c@148 786 # excluded from the INPUT source files. This way you can easily exclude a
c@148 787 # subdirectory from a directory tree whose root is specified with the INPUT tag.
c@148 788 #
c@148 789 # Note that relative paths are relative to the directory from which doxygen is
c@148 790 # run.
c@148 791
c@148 792 EXCLUDE =
c@148 793
c@148 794 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
c@148 795 # directories that are symbolic links (a Unix file system feature) are excluded
c@148 796 # from the input.
c@148 797 # The default value is: NO.
c@148 798
c@148 799 EXCLUDE_SYMLINKS = NO
c@148 800
c@148 801 # If the value of the INPUT tag contains directories, you can use the
c@148 802 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
c@148 803 # certain files from those directories.
c@148 804 #
c@148 805 # Note that the wildcards are matched against the file with absolute path, so to
c@148 806 # exclude all test directories for example use the pattern */test/*
c@148 807
c@148 808 EXCLUDE_PATTERNS =
c@148 809
c@148 810 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
c@148 811 # (namespaces, classes, functions, etc.) that should be excluded from the
c@148 812 # output. The symbol name can be a fully qualified name, a word, or if the
c@148 813 # wildcard * is used, a substring. Examples: ANamespace, AClass,
c@148 814 # AClass::ANamespace, ANamespace::*Test
c@148 815 #
c@148 816 # Note that the wildcards are matched against the file with absolute path, so to
c@148 817 # exclude all test directories use the pattern */test/*
c@148 818
c@148 819 EXCLUDE_SYMBOLS =
c@148 820
c@148 821 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
c@148 822 # that contain example code fragments that are included (see the \include
c@148 823 # command).
c@148 824
c@148 825 EXAMPLE_PATH =
c@148 826
c@148 827 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
c@148 828 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
c@148 829 # *.h) to filter out the source-files in the directories. If left blank all
c@148 830 # files are included.
c@148 831
c@148 832 EXAMPLE_PATTERNS =
c@148 833
c@148 834 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
c@148 835 # searched for input files to be used with the \include or \dontinclude commands
c@148 836 # irrespective of the value of the RECURSIVE tag.
c@148 837 # The default value is: NO.
c@148 838
c@148 839 EXAMPLE_RECURSIVE = NO
c@148 840
c@148 841 # The IMAGE_PATH tag can be used to specify one or more files or directories
c@148 842 # that contain images that are to be included in the documentation (see the
c@148 843 # \image command).
c@148 844
c@148 845 IMAGE_PATH =
c@148 846
c@148 847 # The INPUT_FILTER tag can be used to specify a program that doxygen should
c@148 848 # invoke to filter for each input file. Doxygen will invoke the filter program
c@148 849 # by executing (via popen()) the command:
c@148 850 #
c@148 851 # <filter> <input-file>
c@148 852 #
c@148 853 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
c@148 854 # name of an input file. Doxygen will then use the output that the filter
c@148 855 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
c@148 856 # will be ignored.
c@148 857 #
c@148 858 # Note that the filter must not add or remove lines; it is applied before the
c@148 859 # code is scanned, but not when the output code is generated. If lines are added
c@148 860 # or removed, the anchors will not be placed correctly.
c@148 861
c@148 862 INPUT_FILTER =
c@148 863
c@148 864 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
c@148 865 # basis. Doxygen will compare the file name with each pattern and apply the
c@148 866 # filter if there is a match. The filters are a list of the form: pattern=filter
c@148 867 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
c@148 868 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
c@148 869 # patterns match the file name, INPUT_FILTER is applied.
c@148 870
c@148 871 FILTER_PATTERNS =
c@148 872
c@148 873 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
c@148 874 # INPUT_FILTER ) will also be used to filter the input files that are used for
c@148 875 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
c@148 876 # The default value is: NO.
c@148 877
c@148 878 FILTER_SOURCE_FILES = NO
c@148 879
c@148 880 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
c@148 881 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
c@148 882 # it is also possible to disable source filtering for a specific pattern using
c@148 883 # *.ext= (so without naming a filter).
c@148 884 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
c@148 885
c@148 886 FILTER_SOURCE_PATTERNS =
c@148 887
c@148 888 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
c@148 889 # is part of the input, its contents will be placed on the main page
c@148 890 # (index.html). This can be useful if you have a project on for instance GitHub
c@148 891 # and want to reuse the introduction page also for the doxygen output.
c@148 892
c@148 893 USE_MDFILE_AS_MAINPAGE =
c@148 894
c@148 895 #---------------------------------------------------------------------------
c@148 896 # Configuration options related to source browsing
c@148 897 #---------------------------------------------------------------------------
c@148 898
c@148 899 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
c@148 900 # generated. Documented entities will be cross-referenced with these sources.
c@148 901 #
c@148 902 # Note: To get rid of all source code in the generated output, make sure that
c@148 903 # also VERBATIM_HEADERS is set to NO.
c@148 904 # The default value is: NO.
c@148 905
c@148 906 SOURCE_BROWSER = NO
c@148 907
c@148 908 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
c@148 909 # classes and enums directly into the documentation.
c@148 910 # The default value is: NO.
c@148 911
c@148 912 INLINE_SOURCES = NO
c@148 913
c@148 914 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
c@148 915 # special comment blocks from generated source code fragments. Normal C, C++ and
c@148 916 # Fortran comments will always remain visible.
c@148 917 # The default value is: YES.
c@148 918
c@148 919 STRIP_CODE_COMMENTS = YES
c@148 920
c@148 921 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
c@148 922 # function all documented functions referencing it will be listed.
c@148 923 # The default value is: NO.
c@148 924
c@148 925 REFERENCED_BY_RELATION = NO
c@148 926
c@148 927 # If the REFERENCES_RELATION tag is set to YES then for each documented function
c@148 928 # all documented entities called/used by that function will be listed.
c@148 929 # The default value is: NO.
c@148 930
c@148 931 REFERENCES_RELATION = NO
c@148 932
c@148 933 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
c@148 934 # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
c@148 935 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
c@148 936 # link to the documentation.
c@148 937 # The default value is: YES.
c@148 938
c@148 939 REFERENCES_LINK_SOURCE = YES
c@148 940
c@148 941 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
c@148 942 # source code will show a tooltip with additional information such as prototype,
c@148 943 # brief description and links to the definition and documentation. Since this
c@148 944 # will make the HTML file larger and loading of large files a bit slower, you
c@148 945 # can opt to disable this feature.
c@148 946 # The default value is: YES.
c@148 947 # This tag requires that the tag SOURCE_BROWSER is set to YES.
c@148 948
c@148 949 SOURCE_TOOLTIPS = YES
c@148 950
c@148 951 # If the USE_HTAGS tag is set to YES then the references to source code will
c@148 952 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
c@148 953 # source browser. The htags tool is part of GNU's global source tagging system
c@148 954 # (see http://www.gnu.org/software/global/global.html). You will need version
c@148 955 # 4.8.6 or higher.
c@148 956 #
c@148 957 # To use it do the following:
c@148 958 # - Install the latest version of global
c@148 959 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
c@148 960 # - Make sure the INPUT points to the root of the source tree
c@148 961 # - Run doxygen as normal
c@148 962 #
c@148 963 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
c@148 964 # tools must be available from the command line (i.e. in the search path).
c@148 965 #
c@148 966 # The result: instead of the source browser generated by doxygen, the links to
c@148 967 # source code will now point to the output of htags.
c@148 968 # The default value is: NO.
c@148 969 # This tag requires that the tag SOURCE_BROWSER is set to YES.
c@148 970
c@148 971 USE_HTAGS = NO
c@148 972
c@148 973 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
c@148 974 # verbatim copy of the header file for each class for which an include is
c@148 975 # specified. Set to NO to disable this.
c@148 976 # See also: Section \class.
c@148 977 # The default value is: YES.
c@148 978
c@148 979 VERBATIM_HEADERS = YES
c@148 980
c@148 981 #---------------------------------------------------------------------------
c@148 982 # Configuration options related to the alphabetical class index
c@148 983 #---------------------------------------------------------------------------
c@148 984
c@148 985 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
c@148 986 # compounds will be generated. Enable this if the project contains a lot of
c@148 987 # classes, structs, unions or interfaces.
c@148 988 # The default value is: YES.
c@148 989
c@148 990 ALPHABETICAL_INDEX = YES
c@148 991
c@148 992 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
c@148 993 # which the alphabetical index list will be split.
c@148 994 # Minimum value: 1, maximum value: 20, default value: 5.
c@148 995 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
c@148 996
c@148 997 COLS_IN_ALPHA_INDEX = 5
c@148 998
c@148 999 # In case all classes in a project start with a common prefix, all classes will
c@148 1000 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
c@148 1001 # can be used to specify a prefix (or a list of prefixes) that should be ignored
c@148 1002 # while generating the index headers.
c@148 1003 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
c@148 1004
c@148 1005 IGNORE_PREFIX =
c@148 1006
c@148 1007 #---------------------------------------------------------------------------
c@148 1008 # Configuration options related to the HTML output
c@148 1009 #---------------------------------------------------------------------------
c@148 1010
c@148 1011 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
c@148 1012 # The default value is: YES.
c@148 1013
c@148 1014 GENERATE_HTML = YES
c@148 1015
c@148 1016 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
c@148 1017 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
c@148 1018 # it.
c@148 1019 # The default directory is: html.
c@148 1020 # This tag requires that the tag GENERATE_HTML is set to YES.
c@148 1021
c@148 1022 HTML_OUTPUT = html
c@148 1023
c@148 1024 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
c@148 1025 # generated HTML page (for example: .htm, .php, .asp).
c@148 1026 # The default value is: .html.
c@148 1027 # This tag requires that the tag GENERATE_HTML is set to YES.
c@148 1028
c@148 1029 HTML_FILE_EXTENSION = .html
c@148 1030
c@148 1031 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
c@148 1032 # each generated HTML page. If the tag is left blank doxygen will generate a
c@148 1033 # standard header.
c@148 1034 #
c@148 1035 # To get valid HTML the header file that includes any scripts and style sheets
c@148 1036 # that doxygen needs, which is dependent on the configuration options used (e.g.
c@148 1037 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
c@148 1038 # default header using
c@148 1039 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
c@148 1040 # YourConfigFile
c@148 1041 # and then modify the file new_header.html. See also section "Doxygen usage"
c@148 1042 # for information on how to generate the default header that doxygen normally
c@148 1043 # uses.
c@148 1044 # Note: The header is subject to change so you typically have to regenerate the
c@148 1045 # default header when upgrading to a newer version of doxygen. For a description
c@148 1046 # of the possible markers and block names see the documentation.
c@148 1047 # This tag requires that the tag GENERATE_HTML is set to YES.
c@148 1048
c@148 1049 HTML_HEADER =
c@148 1050
c@148 1051 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
c@148 1052 # generated HTML page. If the tag is left blank doxygen will generate a standard
c@148 1053 # footer. See HTML_HEADER for more information on how to generate a default
c@148 1054 # footer and what special commands can be used inside the footer. See also
c@148 1055 # section "Doxygen usage" for information on how to generate the default footer
c@148 1056 # that doxygen normally uses.
c@148 1057 # This tag requires that the tag GENERATE_HTML is set to YES.
c@148 1058
c@148 1059 HTML_FOOTER =
c@148 1060
c@148 1061 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
c@148 1062 # sheet that is used by each HTML page. It can be used to fine-tune the look of
c@148 1063 # the HTML output. If left blank doxygen will generate a default style sheet.
c@148 1064 # See also section "Doxygen usage" for information on how to generate the style
c@148 1065 # sheet that doxygen normally uses.
c@148 1066 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
c@148 1067 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
c@148 1068 # obsolete.
c@148 1069 # This tag requires that the tag GENERATE_HTML is set to YES.
c@148 1070
c@148 1071 HTML_STYLESHEET =
c@148 1072
c@148 1073 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
c@148 1074 # defined cascading style sheet that is included after the standard style sheets
c@148 1075 # created by doxygen. Using this option one can overrule certain style aspects.
c@148 1076 # This is preferred over using HTML_STYLESHEET since it does not replace the
c@148 1077 # standard style sheet and is therefor more robust against future updates.
c@148 1078 # Doxygen will copy the style sheet file to the output directory. For an example
c@148 1079 # see the documentation.
c@148 1080 # This tag requires that the tag GENERATE_HTML is set to YES.
c@148 1081
c@148 1082 HTML_EXTRA_STYLESHEET =
c@148 1083
c@148 1084 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
c@148 1085 # other source files which should be copied to the HTML output directory. Note
c@148 1086 # that these files will be copied to the base HTML output directory. Use the
c@148 1087 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
c@148 1088 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
c@148 1089 # files will be copied as-is; there are no commands or markers available.
c@148 1090 # This tag requires that the tag GENERATE_HTML is set to YES.
c@148 1091
c@148 1092 HTML_EXTRA_FILES =
c@148 1093
c@148 1094 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
c@148 1095 # will adjust the colors in the stylesheet and background images according to
c@148 1096 # this color. Hue is specified as an angle on a colorwheel, see
c@148 1097 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
c@148 1098 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
c@148 1099 # purple, and 360 is red again.
c@148 1100 # Minimum value: 0, maximum value: 359, default value: 220.
c@148 1101 # This tag requires that the tag GENERATE_HTML is set to YES.
c@148 1102
c@148 1103 HTML_COLORSTYLE_HUE = 220
c@148 1104
c@148 1105 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
c@148 1106 # in the HTML output. For a value of 0 the output will use grayscales only. A
c@148 1107 # value of 255 will produce the most vivid colors.
c@148 1108 # Minimum value: 0, maximum value: 255, default value: 100.
c@148 1109 # This tag requires that the tag GENERATE_HTML is set to YES.
c@148 1110
c@148 1111 HTML_COLORSTYLE_SAT = 100
c@148 1112
c@148 1113 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
c@148 1114 # luminance component of the colors in the HTML output. Values below 100
c@148 1115 # gradually make the output lighter, whereas values above 100 make the output
c@148 1116 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
c@148 1117 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
c@148 1118 # change the gamma.
c@148 1119 # Minimum value: 40, maximum value: 240, default value: 80.
c@148 1120 # This tag requires that the tag GENERATE_HTML is set to YES.
c@148 1121
c@148 1122 HTML_COLORSTYLE_GAMMA = 80
c@148 1123
c@148 1124 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
c@148 1125 # page will contain the date and time when the page was generated. Setting this
c@148 1126 # to NO can help when comparing the output of multiple runs.
c@148 1127 # The default value is: YES.
c@148 1128 # This tag requires that the tag GENERATE_HTML is set to YES.
c@148 1129
c@148 1130 HTML_TIMESTAMP = YES
c@148 1131
c@148 1132 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
c@148 1133 # documentation will contain sections that can be hidden and shown after the
c@148 1134 # page has loaded.
c@148 1135 # The default value is: NO.
c@148 1136 # This tag requires that the tag GENERATE_HTML is set to YES.
c@148 1137
c@148 1138 HTML_DYNAMIC_SECTIONS = NO
c@148 1139
c@148 1140 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
c@148 1141 # shown in the various tree structured indices initially; the user can expand
c@148 1142 # and collapse entries dynamically later on. Doxygen will expand the tree to
c@148 1143 # such a level that at most the specified number of entries are visible (unless
c@148 1144 # a fully collapsed tree already exceeds this amount). So setting the number of
c@148 1145 # entries 1 will produce a full collapsed tree by default. 0 is a special value
c@148 1146 # representing an infinite number of entries and will result in a full expanded
c@148 1147 # tree by default.
c@148 1148 # Minimum value: 0, maximum value: 9999, default value: 100.
c@148 1149 # This tag requires that the tag GENERATE_HTML is set to YES.
c@148 1150
c@148 1151 HTML_INDEX_NUM_ENTRIES = 100
c@148 1152
c@148 1153 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
c@148 1154 # generated that can be used as input for Apple's Xcode 3 integrated development
c@148 1155 # environment (see: http://developer.apple.com/tools/xcode/), introduced with
c@148 1156 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
c@148 1157 # Makefile in the HTML output directory. Running make will produce the docset in
c@148 1158 # that directory and running make install will install the docset in
c@148 1159 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
c@148 1160 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
c@148 1161 # for more information.
c@148 1162 # The default value is: NO.
c@148 1163 # This tag requires that the tag GENERATE_HTML is set to YES.
c@148 1164
c@148 1165 GENERATE_DOCSET = NO
c@148 1166
c@148 1167 # This tag determines the name of the docset feed. A documentation feed provides
c@148 1168 # an umbrella under which multiple documentation sets from a single provider
c@148 1169 # (such as a company or product suite) can be grouped.
c@148 1170 # The default value is: Doxygen generated docs.
c@148 1171 # This tag requires that the tag GENERATE_DOCSET is set to YES.
c@148 1172
c@148 1173 DOCSET_FEEDNAME = "Doxygen generated docs"
c@148 1174
c@148 1175 # This tag specifies a string that should uniquely identify the documentation
c@148 1176 # set bundle. This should be a reverse domain-name style string, e.g.
c@148 1177 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
c@148 1178 # The default value is: org.doxygen.Project.
c@148 1179 # This tag requires that the tag GENERATE_DOCSET is set to YES.
c@148 1180
c@148 1181 DOCSET_BUNDLE_ID = org.doxygen.Project
c@148 1182
c@148 1183 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
c@148 1184 # the documentation publisher. This should be a reverse domain-name style
c@148 1185 # string, e.g. com.mycompany.MyDocSet.documentation.
c@148 1186 # The default value is: org.doxygen.Publisher.
c@148 1187 # This tag requires that the tag GENERATE_DOCSET is set to YES.
c@148 1188
c@148 1189 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
c@148 1190
c@148 1191 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
c@148 1192 # The default value is: Publisher.
c@148 1193 # This tag requires that the tag GENERATE_DOCSET is set to YES.
c@148 1194
c@148 1195 DOCSET_PUBLISHER_NAME = Publisher
c@148 1196
c@148 1197 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
c@148 1198 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
c@148 1199 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
c@148 1200 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
c@148 1201 # Windows.
c@148 1202 #
c@148 1203 # The HTML Help Workshop contains a compiler that can convert all HTML output
c@148 1204 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
c@148 1205 # files are now used as the Windows 98 help format, and will replace the old
c@148 1206 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
c@148 1207 # HTML files also contain an index, a table of contents, and you can search for
c@148 1208 # words in the documentation. The HTML workshop also contains a viewer for
c@148 1209 # compressed HTML files.
c@148 1210 # The default value is: NO.
c@148 1211 # This tag requires that the tag GENERATE_HTML is set to YES.
c@148 1212
c@148 1213 GENERATE_HTMLHELP = NO
c@148 1214
c@148 1215 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
c@148 1216 # file. You can add a path in front of the file if the result should not be
c@148 1217 # written to the html output directory.
c@148 1218 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
c@148 1219
c@148 1220 CHM_FILE =
c@148 1221
c@148 1222 # The HHC_LOCATION tag can be used to specify the location (absolute path
c@148 1223 # including file name) of the HTML help compiler ( hhc.exe). If non-empty
c@148 1224 # doxygen will try to run the HTML help compiler on the generated index.hhp.
c@148 1225 # The file has to be specified with full path.
c@148 1226 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
c@148 1227
c@148 1228 HHC_LOCATION =
c@148 1229
c@148 1230 # The GENERATE_CHI flag controls if a separate .chi index file is generated (
c@148 1231 # YES) or that it should be included in the master .chm file ( NO).
c@148 1232 # The default value is: NO.
c@148 1233 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
c@148 1234
c@148 1235 GENERATE_CHI = NO
c@148 1236
c@148 1237 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
c@148 1238 # and project file content.
c@148 1239 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
c@148 1240
c@148 1241 CHM_INDEX_ENCODING =
c@148 1242
c@148 1243 # The BINARY_TOC flag controls whether a binary table of contents is generated (
c@148 1244 # YES) or a normal table of contents ( NO) in the .chm file. Furthermore it
c@148 1245 # enables the Previous and Next buttons.
c@148 1246 # The default value is: NO.
c@148 1247 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
c@148 1248
c@148 1249 BINARY_TOC = NO
c@148 1250
c@148 1251 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
c@148 1252 # the table of contents of the HTML help documentation and to the tree view.
c@148 1253 # The default value is: NO.
c@148 1254 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
c@148 1255
c@148 1256 TOC_EXPAND = NO
c@148 1257
c@148 1258 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
c@148 1259 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
c@148 1260 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
c@148 1261 # (.qch) of the generated HTML documentation.
c@148 1262 # The default value is: NO.
c@148 1263 # This tag requires that the tag GENERATE_HTML is set to YES.
c@148 1264
c@148 1265 GENERATE_QHP = NO
c@148 1266
c@148 1267 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
c@148 1268 # the file name of the resulting .qch file. The path specified is relative to
c@148 1269 # the HTML output folder.
c@148 1270 # This tag requires that the tag GENERATE_QHP is set to YES.
c@148 1271
c@148 1272 QCH_FILE =
c@148 1273
c@148 1274 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
c@148 1275 # Project output. For more information please see Qt Help Project / Namespace
c@148 1276 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
c@148 1277 # The default value is: org.doxygen.Project.
c@148 1278 # This tag requires that the tag GENERATE_QHP is set to YES.
c@148 1279
c@148 1280 QHP_NAMESPACE = org.doxygen.Project
c@148 1281
c@148 1282 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
c@148 1283 # Help Project output. For more information please see Qt Help Project / Virtual
c@148 1284 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
c@148 1285 # folders).
c@148 1286 # The default value is: doc.
c@148 1287 # This tag requires that the tag GENERATE_QHP is set to YES.
c@148 1288
c@148 1289 QHP_VIRTUAL_FOLDER = doc
c@148 1290
c@148 1291 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
c@148 1292 # filter to add. For more information please see Qt Help Project / Custom
c@148 1293 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
c@148 1294 # filters).
c@148 1295 # This tag requires that the tag GENERATE_QHP is set to YES.
c@148 1296
c@148 1297 QHP_CUST_FILTER_NAME =
c@148 1298
c@148 1299 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
c@148 1300 # custom filter to add. For more information please see Qt Help Project / Custom
c@148 1301 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
c@148 1302 # filters).
c@148 1303 # This tag requires that the tag GENERATE_QHP is set to YES.
c@148 1304
c@148 1305 QHP_CUST_FILTER_ATTRS =
c@148 1306
c@148 1307 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
c@148 1308 # project's filter section matches. Qt Help Project / Filter Attributes (see:
c@148 1309 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
c@148 1310 # This tag requires that the tag GENERATE_QHP is set to YES.
c@148 1311
c@148 1312 QHP_SECT_FILTER_ATTRS =
c@148 1313
c@148 1314 # The QHG_LOCATION tag can be used to specify the location of Qt's
c@148 1315 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
c@148 1316 # generated .qhp file.
c@148 1317 # This tag requires that the tag GENERATE_QHP is set to YES.
c@148 1318
c@148 1319 QHG_LOCATION =
c@148 1320
c@148 1321 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
c@148 1322 # generated, together with the HTML files, they form an Eclipse help plugin. To
c@148 1323 # install this plugin and make it available under the help contents menu in
c@148 1324 # Eclipse, the contents of the directory containing the HTML and XML files needs
c@148 1325 # to be copied into the plugins directory of eclipse. The name of the directory
c@148 1326 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
c@148 1327 # After copying Eclipse needs to be restarted before the help appears.
c@148 1328 # The default value is: NO.
c@148 1329 # This tag requires that the tag GENERATE_HTML is set to YES.
c@148 1330
c@148 1331 GENERATE_ECLIPSEHELP = NO
c@148 1332
c@148 1333 # A unique identifier for the Eclipse help plugin. When installing the plugin
c@148 1334 # the directory name containing the HTML and XML files should also have this
c@148 1335 # name. Each documentation set should have its own identifier.
c@148 1336 # The default value is: org.doxygen.Project.
c@148 1337 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
c@148 1338
c@148 1339 ECLIPSE_DOC_ID = org.doxygen.Project
c@148 1340
c@148 1341 # If you want full control over the layout of the generated HTML pages it might
c@148 1342 # be necessary to disable the index and replace it with your own. The
c@148 1343 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
c@148 1344 # of each HTML page. A value of NO enables the index and the value YES disables
c@148 1345 # it. Since the tabs in the index contain the same information as the navigation
c@148 1346 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
c@148 1347 # The default value is: NO.
c@148 1348 # This tag requires that the tag GENERATE_HTML is set to YES.
c@148 1349
c@148 1350 DISABLE_INDEX = NO
c@148 1351
c@148 1352 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
c@148 1353 # structure should be generated to display hierarchical information. If the tag
c@148 1354 # value is set to YES, a side panel will be generated containing a tree-like
c@148 1355 # index structure (just like the one that is generated for HTML Help). For this
c@148 1356 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
c@148 1357 # (i.e. any modern browser). Windows users are probably better off using the
c@148 1358 # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
c@148 1359 # further fine-tune the look of the index. As an example, the default style
c@148 1360 # sheet generated by doxygen has an example that shows how to put an image at
c@148 1361 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
c@148 1362 # the same information as the tab index, you could consider setting
c@148 1363 # DISABLE_INDEX to YES when enabling this option.
c@148 1364 # The default value is: NO.
c@148 1365 # This tag requires that the tag GENERATE_HTML is set to YES.
c@148 1366
c@148 1367 GENERATE_TREEVIEW = NO
c@148 1368
c@148 1369 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
c@148 1370 # doxygen will group on one line in the generated HTML documentation.
c@148 1371 #
c@148 1372 # Note that a value of 0 will completely suppress the enum values from appearing
c@148 1373 # in the overview section.
c@148 1374 # Minimum value: 0, maximum value: 20, default value: 4.
c@148 1375 # This tag requires that the tag GENERATE_HTML is set to YES.
c@148 1376
c@148 1377 ENUM_VALUES_PER_LINE = 4
c@148 1378
c@148 1379 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
c@148 1380 # to set the initial width (in pixels) of the frame in which the tree is shown.
c@148 1381 # Minimum value: 0, maximum value: 1500, default value: 250.
c@148 1382 # This tag requires that the tag GENERATE_HTML is set to YES.
c@148 1383
c@148 1384 TREEVIEW_WIDTH = 250
c@148 1385
c@148 1386 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
c@148 1387 # external symbols imported via tag files in a separate window.
c@148 1388 # The default value is: NO.
c@148 1389 # This tag requires that the tag GENERATE_HTML is set to YES.
c@148 1390
c@148 1391 EXT_LINKS_IN_WINDOW = NO
c@148 1392
c@148 1393 # Use this tag to change the font size of LaTeX formulas included as images in
c@148 1394 # the HTML documentation. When you change the font size after a successful
c@148 1395 # doxygen run you need to manually remove any form_*.png images from the HTML
c@148 1396 # output directory to force them to be regenerated.
c@148 1397 # Minimum value: 8, maximum value: 50, default value: 10.
c@148 1398 # This tag requires that the tag GENERATE_HTML is set to YES.
c@148 1399
c@148 1400 FORMULA_FONTSIZE = 10
c@148 1401
c@148 1402 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
c@148 1403 # generated for formulas are transparent PNGs. Transparent PNGs are not
c@148 1404 # supported properly for IE 6.0, but are supported on all modern browsers.
c@148 1405 #
c@148 1406 # Note that when changing this option you need to delete any form_*.png files in
c@148 1407 # the HTML output directory before the changes have effect.
c@148 1408 # The default value is: YES.
c@148 1409 # This tag requires that the tag GENERATE_HTML is set to YES.
c@148 1410
c@148 1411 FORMULA_TRANSPARENT = YES
c@148 1412
c@148 1413 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
c@148 1414 # http://www.mathjax.org) which uses client side Javascript for the rendering
c@148 1415 # instead of using prerendered bitmaps. Use this if you do not have LaTeX
c@148 1416 # installed or if you want to formulas look prettier in the HTML output. When
c@148 1417 # enabled you may also need to install MathJax separately and configure the path
c@148 1418 # to it using the MATHJAX_RELPATH option.
c@148 1419 # The default value is: NO.
c@148 1420 # This tag requires that the tag GENERATE_HTML is set to YES.
c@148 1421
c@148 1422 USE_MATHJAX = NO
c@148 1423
c@148 1424 # When MathJax is enabled you can set the default output format to be used for
c@148 1425 # the MathJax output. See the MathJax site (see:
c@148 1426 # http://docs.mathjax.org/en/latest/output.html) for more details.
c@148 1427 # Possible values are: HTML-CSS (which is slower, but has the best
c@148 1428 # compatibility), NativeMML (i.e. MathML) and SVG.
c@148 1429 # The default value is: HTML-CSS.
c@148 1430 # This tag requires that the tag USE_MATHJAX is set to YES.
c@148 1431
c@148 1432 MATHJAX_FORMAT = HTML-CSS
c@148 1433
c@148 1434 # When MathJax is enabled you need to specify the location relative to the HTML
c@148 1435 # output directory using the MATHJAX_RELPATH option. The destination directory
c@148 1436 # should contain the MathJax.js script. For instance, if the mathjax directory
c@148 1437 # is located at the same level as the HTML output directory, then
c@148 1438 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
c@148 1439 # Content Delivery Network so you can quickly see the result without installing
c@148 1440 # MathJax. However, it is strongly recommended to install a local copy of
c@148 1441 # MathJax from http://www.mathjax.org before deployment.
c@148 1442 # The default value is: http://cdn.mathjax.org/mathjax/latest.
c@148 1443 # This tag requires that the tag USE_MATHJAX is set to YES.
c@148 1444
c@148 1445 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
c@148 1446
c@148 1447 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
c@148 1448 # extension names that should be enabled during MathJax rendering. For example
c@148 1449 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
c@148 1450 # This tag requires that the tag USE_MATHJAX is set to YES.
c@148 1451
c@148 1452 MATHJAX_EXTENSIONS =
c@148 1453
c@148 1454 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
c@148 1455 # of code that will be used on startup of the MathJax code. See the MathJax site
c@148 1456 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
c@148 1457 # example see the documentation.
c@148 1458 # This tag requires that the tag USE_MATHJAX is set to YES.
c@148 1459
c@148 1460 MATHJAX_CODEFILE =
c@148 1461
c@148 1462 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
c@148 1463 # the HTML output. The underlying search engine uses javascript and DHTML and
c@148 1464 # should work on any modern browser. Note that when using HTML help
c@148 1465 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
c@148 1466 # there is already a search function so this one should typically be disabled.
c@148 1467 # For large projects the javascript based search engine can be slow, then
c@148 1468 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
c@148 1469 # search using the keyboard; to jump to the search box use <access key> + S
c@148 1470 # (what the <access key> is depends on the OS and browser, but it is typically
c@148 1471 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
c@148 1472 # key> to jump into the search results window, the results can be navigated
c@148 1473 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
c@148 1474 # the search. The filter options can be selected when the cursor is inside the
c@148 1475 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
c@148 1476 # to select a filter and <Enter> or <escape> to activate or cancel the filter
c@148 1477 # option.
c@148 1478 # The default value is: YES.
c@148 1479 # This tag requires that the tag GENERATE_HTML is set to YES.
c@148 1480
c@148 1481 SEARCHENGINE = YES
c@148 1482
c@148 1483 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
c@148 1484 # implemented using a web server instead of a web client using Javascript. There
c@148 1485 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
c@148 1486 # setting. When disabled, doxygen will generate a PHP script for searching and
c@148 1487 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
c@148 1488 # and searching needs to be provided by external tools. See the section
c@148 1489 # "External Indexing and Searching" for details.
c@148 1490 # The default value is: NO.
c@148 1491 # This tag requires that the tag SEARCHENGINE is set to YES.
c@148 1492
c@148 1493 SERVER_BASED_SEARCH = NO
c@148 1494
c@148 1495 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
c@148 1496 # script for searching. Instead the search results are written to an XML file
c@148 1497 # which needs to be processed by an external indexer. Doxygen will invoke an
c@148 1498 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
c@148 1499 # search results.
c@148 1500 #
c@148 1501 # Doxygen ships with an example indexer ( doxyindexer) and search engine
c@148 1502 # (doxysearch.cgi) which are based on the open source search engine library
c@148 1503 # Xapian (see: http://xapian.org/).
c@148 1504 #
c@148 1505 # See the section "External Indexing and Searching" for details.
c@148 1506 # The default value is: NO.
c@148 1507 # This tag requires that the tag SEARCHENGINE is set to YES.
c@148 1508
c@148 1509 EXTERNAL_SEARCH = NO
c@148 1510
c@148 1511 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
c@148 1512 # which will return the search results when EXTERNAL_SEARCH is enabled.
c@148 1513 #
c@148 1514 # Doxygen ships with an example indexer ( doxyindexer) and search engine
c@148 1515 # (doxysearch.cgi) which are based on the open source search engine library
c@148 1516 # Xapian (see: http://xapian.org/). See the section "External Indexing and
c@148 1517 # Searching" for details.
c@148 1518 # This tag requires that the tag SEARCHENGINE is set to YES.
c@148 1519
c@148 1520 SEARCHENGINE_URL =
c@148 1521
c@148 1522 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
c@148 1523 # search data is written to a file for indexing by an external tool. With the
c@148 1524 # SEARCHDATA_FILE tag the name of this file can be specified.
c@148 1525 # The default file is: searchdata.xml.
c@148 1526 # This tag requires that the tag SEARCHENGINE is set to YES.
c@148 1527
c@148 1528 SEARCHDATA_FILE = searchdata.xml
c@148 1529
c@148 1530 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
c@148 1531 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
c@148 1532 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
c@148 1533 # projects and redirect the results back to the right project.
c@148 1534 # This tag requires that the tag SEARCHENGINE is set to YES.
c@148 1535
c@148 1536 EXTERNAL_SEARCH_ID =
c@148 1537
c@148 1538 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
c@148 1539 # projects other than the one defined by this configuration file, but that are
c@148 1540 # all added to the same external search index. Each project needs to have a
c@148 1541 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
c@148 1542 # to a relative location where the documentation can be found. The format is:
c@148 1543 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
c@148 1544 # This tag requires that the tag SEARCHENGINE is set to YES.
c@148 1545
c@148 1546 EXTRA_SEARCH_MAPPINGS =
c@148 1547
c@148 1548 #---------------------------------------------------------------------------
c@148 1549 # Configuration options related to the LaTeX output
c@148 1550 #---------------------------------------------------------------------------
c@148 1551
c@148 1552 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
c@148 1553 # The default value is: YES.
c@148 1554
c@148 1555 GENERATE_LATEX = YES
c@148 1556
c@148 1557 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
c@148 1558 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
c@148 1559 # it.
c@148 1560 # The default directory is: latex.
c@148 1561 # This tag requires that the tag GENERATE_LATEX is set to YES.
c@148 1562
c@148 1563 LATEX_OUTPUT = latex
c@148 1564
c@148 1565 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
c@148 1566 # invoked.
c@148 1567 #
c@148 1568 # Note that when enabling USE_PDFLATEX this option is only used for generating
c@148 1569 # bitmaps for formulas in the HTML output, but not in the Makefile that is
c@148 1570 # written to the output directory.
c@148 1571 # The default file is: latex.
c@148 1572 # This tag requires that the tag GENERATE_LATEX is set to YES.
c@148 1573
c@148 1574 LATEX_CMD_NAME = latex
c@148 1575
c@148 1576 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
c@148 1577 # index for LaTeX.
c@148 1578 # The default file is: makeindex.
c@148 1579 # This tag requires that the tag GENERATE_LATEX is set to YES.
c@148 1580
c@148 1581 MAKEINDEX_CMD_NAME = makeindex
c@148 1582
c@148 1583 # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
c@148 1584 # documents. This may be useful for small projects and may help to save some
c@148 1585 # trees in general.
c@148 1586 # The default value is: NO.
c@148 1587 # This tag requires that the tag GENERATE_LATEX is set to YES.
c@148 1588
c@148 1589 COMPACT_LATEX = NO
c@148 1590
c@148 1591 # The PAPER_TYPE tag can be used to set the paper type that is used by the
c@148 1592 # printer.
c@148 1593 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
c@148 1594 # 14 inches) and executive (7.25 x 10.5 inches).
c@148 1595 # The default value is: a4.
c@148 1596 # This tag requires that the tag GENERATE_LATEX is set to YES.
c@148 1597
c@148 1598 PAPER_TYPE = a4
c@148 1599
c@148 1600 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
c@148 1601 # that should be included in the LaTeX output. To get the times font for
c@148 1602 # instance you can specify
c@148 1603 # EXTRA_PACKAGES=times
c@148 1604 # If left blank no extra packages will be included.
c@148 1605 # This tag requires that the tag GENERATE_LATEX is set to YES.
c@148 1606
c@148 1607 EXTRA_PACKAGES =
c@148 1608
c@148 1609 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
c@148 1610 # generated LaTeX document. The header should contain everything until the first
c@148 1611 # chapter. If it is left blank doxygen will generate a standard header. See
c@148 1612 # section "Doxygen usage" for information on how to let doxygen write the
c@148 1613 # default header to a separate file.
c@148 1614 #
c@148 1615 # Note: Only use a user-defined header if you know what you are doing! The
c@148 1616 # following commands have a special meaning inside the header: $title,
c@148 1617 # $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
c@148 1618 # replace them by respectively the title of the page, the current date and time,
c@148 1619 # only the current date, the version number of doxygen, the project name (see
c@148 1620 # PROJECT_NAME), or the project number (see PROJECT_NUMBER).
c@148 1621 # This tag requires that the tag GENERATE_LATEX is set to YES.
c@148 1622
c@148 1623 LATEX_HEADER =
c@148 1624
c@148 1625 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
c@148 1626 # generated LaTeX document. The footer should contain everything after the last
c@148 1627 # chapter. If it is left blank doxygen will generate a standard footer.
c@148 1628 #
c@148 1629 # Note: Only use a user-defined footer if you know what you are doing!
c@148 1630 # This tag requires that the tag GENERATE_LATEX is set to YES.
c@148 1631
c@148 1632 LATEX_FOOTER =
c@148 1633
c@148 1634 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
c@148 1635 # other source files which should be copied to the LATEX_OUTPUT output
c@148 1636 # directory. Note that the files will be copied as-is; there are no commands or
c@148 1637 # markers available.
c@148 1638 # This tag requires that the tag GENERATE_LATEX is set to YES.
c@148 1639
c@148 1640 LATEX_EXTRA_FILES =
c@148 1641
c@148 1642 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
c@148 1643 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
c@148 1644 # contain links (just like the HTML output) instead of page references. This
c@148 1645 # makes the output suitable for online browsing using a PDF viewer.
c@148 1646 # The default value is: YES.
c@148 1647 # This tag requires that the tag GENERATE_LATEX is set to YES.
c@148 1648
c@148 1649 PDF_HYPERLINKS = YES
c@148 1650
c@148 1651 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
c@148 1652 # the PDF file directly from the LaTeX files. Set this option to YES to get a
c@148 1653 # higher quality PDF documentation.
c@148 1654 # The default value is: YES.
c@148 1655 # This tag requires that the tag GENERATE_LATEX is set to YES.
c@148 1656
c@148 1657 USE_PDFLATEX = YES
c@148 1658
c@148 1659 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
c@148 1660 # command to the generated LaTeX files. This will instruct LaTeX to keep running
c@148 1661 # if errors occur, instead of asking the user for help. This option is also used
c@148 1662 # when generating formulas in HTML.
c@148 1663 # The default value is: NO.
c@148 1664 # This tag requires that the tag GENERATE_LATEX is set to YES.
c@148 1665
c@148 1666 LATEX_BATCHMODE = NO
c@148 1667
c@148 1668 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
c@148 1669 # index chapters (such as File Index, Compound Index, etc.) in the output.
c@148 1670 # The default value is: NO.
c@148 1671 # This tag requires that the tag GENERATE_LATEX is set to YES.
c@148 1672
c@148 1673 LATEX_HIDE_INDICES = NO
c@148 1674
c@148 1675 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
c@148 1676 # code with syntax highlighting in the LaTeX output.
c@148 1677 #
c@148 1678 # Note that which sources are shown also depends on other settings such as
c@148 1679 # SOURCE_BROWSER.
c@148 1680 # The default value is: NO.
c@148 1681 # This tag requires that the tag GENERATE_LATEX is set to YES.
c@148 1682
c@148 1683 LATEX_SOURCE_CODE = NO
c@148 1684
c@148 1685 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
c@148 1686 # bibliography, e.g. plainnat, or ieeetr. See
c@148 1687 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
c@148 1688 # The default value is: plain.
c@148 1689 # This tag requires that the tag GENERATE_LATEX is set to YES.
c@148 1690
c@148 1691 LATEX_BIB_STYLE = plain
c@148 1692
c@148 1693 #---------------------------------------------------------------------------
c@148 1694 # Configuration options related to the RTF output
c@148 1695 #---------------------------------------------------------------------------
c@148 1696
c@148 1697 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
c@148 1698 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
c@148 1699 # readers/editors.
c@148 1700 # The default value is: NO.
c@148 1701
c@148 1702 GENERATE_RTF = NO
c@148 1703
c@148 1704 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
c@148 1705 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
c@148 1706 # it.
c@148 1707 # The default directory is: rtf.
c@148 1708 # This tag requires that the tag GENERATE_RTF is set to YES.
c@148 1709
c@148 1710 RTF_OUTPUT = rtf
c@148 1711
c@148 1712 # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
c@148 1713 # documents. This may be useful for small projects and may help to save some
c@148 1714 # trees in general.
c@148 1715 # The default value is: NO.
c@148 1716 # This tag requires that the tag GENERATE_RTF is set to YES.
c@148 1717
c@148 1718 COMPACT_RTF = NO
c@148 1719
c@148 1720 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
c@148 1721 # contain hyperlink fields. The RTF file will contain links (just like the HTML
c@148 1722 # output) instead of page references. This makes the output suitable for online
c@148 1723 # browsing using Word or some other Word compatible readers that support those
c@148 1724 # fields.
c@148 1725 #
c@148 1726 # Note: WordPad (write) and others do not support links.
c@148 1727 # The default value is: NO.
c@148 1728 # This tag requires that the tag GENERATE_RTF is set to YES.
c@148 1729
c@148 1730 RTF_HYPERLINKS = NO
c@148 1731
c@148 1732 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
c@148 1733 # file, i.e. a series of assignments. You only have to provide replacements,
c@148 1734 # missing definitions are set to their default value.
c@148 1735 #
c@148 1736 # See also section "Doxygen usage" for information on how to generate the
c@148 1737 # default style sheet that doxygen normally uses.
c@148 1738 # This tag requires that the tag GENERATE_RTF is set to YES.
c@148 1739
c@148 1740 RTF_STYLESHEET_FILE =
c@148 1741
c@148 1742 # Set optional variables used in the generation of an RTF document. Syntax is
c@148 1743 # similar to doxygen's config file. A template extensions file can be generated
c@148 1744 # using doxygen -e rtf extensionFile.
c@148 1745 # This tag requires that the tag GENERATE_RTF is set to YES.
c@148 1746
c@148 1747 RTF_EXTENSIONS_FILE =
c@148 1748
c@148 1749 #---------------------------------------------------------------------------
c@148 1750 # Configuration options related to the man page output
c@148 1751 #---------------------------------------------------------------------------
c@148 1752
c@148 1753 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
c@148 1754 # classes and files.
c@148 1755 # The default value is: NO.
c@148 1756
c@148 1757 GENERATE_MAN = NO
c@148 1758
c@148 1759 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
c@148 1760 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
c@148 1761 # it. A directory man3 will be created inside the directory specified by
c@148 1762 # MAN_OUTPUT.
c@148 1763 # The default directory is: man.
c@148 1764 # This tag requires that the tag GENERATE_MAN is set to YES.
c@148 1765
c@148 1766 MAN_OUTPUT = man
c@148 1767
c@148 1768 # The MAN_EXTENSION tag determines the extension that is added to the generated
c@148 1769 # man pages. In case the manual section does not start with a number, the number
c@148 1770 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
c@148 1771 # optional.
c@148 1772 # The default value is: .3.
c@148 1773 # This tag requires that the tag GENERATE_MAN is set to YES.
c@148 1774
c@148 1775 MAN_EXTENSION = .3
c@148 1776
c@148 1777 # The MAN_SUBDIR tag determines the name of the directory created within
c@148 1778 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
c@148 1779 # MAN_EXTENSION with the initial . removed.
c@148 1780 # This tag requires that the tag GENERATE_MAN is set to YES.
c@148 1781
c@148 1782 MAN_SUBDIR =
c@148 1783
c@148 1784 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
c@148 1785 # will generate one additional man file for each entity documented in the real
c@148 1786 # man page(s). These additional files only source the real man page, but without
c@148 1787 # them the man command would be unable to find the correct page.
c@148 1788 # The default value is: NO.
c@148 1789 # This tag requires that the tag GENERATE_MAN is set to YES.
c@148 1790
c@148 1791 MAN_LINKS = NO
c@148 1792
c@148 1793 #---------------------------------------------------------------------------
c@148 1794 # Configuration options related to the XML output
c@148 1795 #---------------------------------------------------------------------------
c@148 1796
c@148 1797 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
c@148 1798 # captures the structure of the code including all documentation.
c@148 1799 # The default value is: NO.
c@148 1800
c@148 1801 GENERATE_XML = NO
c@148 1802
c@148 1803 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
c@148 1804 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
c@148 1805 # it.
c@148 1806 # The default directory is: xml.
c@148 1807 # This tag requires that the tag GENERATE_XML is set to YES.
c@148 1808
c@148 1809 XML_OUTPUT = xml
c@148 1810
c@148 1811 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
c@148 1812 # listings (including syntax highlighting and cross-referencing information) to
c@148 1813 # the XML output. Note that enabling this will significantly increase the size
c@148 1814 # of the XML output.
c@148 1815 # The default value is: YES.
c@148 1816 # This tag requires that the tag GENERATE_XML is set to YES.
c@148 1817
c@148 1818 XML_PROGRAMLISTING = YES
c@148 1819
c@148 1820 #---------------------------------------------------------------------------
c@148 1821 # Configuration options related to the DOCBOOK output
c@148 1822 #---------------------------------------------------------------------------
c@148 1823
c@148 1824 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
c@148 1825 # that can be used to generate PDF.
c@148 1826 # The default value is: NO.
c@148 1827
c@148 1828 GENERATE_DOCBOOK = NO
c@148 1829
c@148 1830 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
c@148 1831 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
c@148 1832 # front of it.
c@148 1833 # The default directory is: docbook.
c@148 1834 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
c@148 1835
c@148 1836 DOCBOOK_OUTPUT = docbook
c@148 1837
c@148 1838 #---------------------------------------------------------------------------
c@148 1839 # Configuration options for the AutoGen Definitions output
c@148 1840 #---------------------------------------------------------------------------
c@148 1841
c@148 1842 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
c@148 1843 # Definitions (see http://autogen.sf.net) file that captures the structure of
c@148 1844 # the code including all documentation. Note that this feature is still
c@148 1845 # experimental and incomplete at the moment.
c@148 1846 # The default value is: NO.
c@148 1847
c@148 1848 GENERATE_AUTOGEN_DEF = NO
c@148 1849
c@148 1850 #---------------------------------------------------------------------------
c@148 1851 # Configuration options related to the Perl module output
c@148 1852 #---------------------------------------------------------------------------
c@148 1853
c@148 1854 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
c@148 1855 # file that captures the structure of the code including all documentation.
c@148 1856 #
c@148 1857 # Note that this feature is still experimental and incomplete at the moment.
c@148 1858 # The default value is: NO.
c@148 1859
c@148 1860 GENERATE_PERLMOD = NO
c@148 1861
c@148 1862 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
c@148 1863 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
c@148 1864 # output from the Perl module output.
c@148 1865 # The default value is: NO.
c@148 1866 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
c@148 1867
c@148 1868 PERLMOD_LATEX = NO
c@148 1869
c@148 1870 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
c@148 1871 # formatted so it can be parsed by a human reader. This is useful if you want to
c@148 1872 # understand what is going on. On the other hand, if this tag is set to NO the
c@148 1873 # size of the Perl module output will be much smaller and Perl will parse it
c@148 1874 # just the same.
c@148 1875 # The default value is: YES.
c@148 1876 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
c@148 1877
c@148 1878 PERLMOD_PRETTY = YES
c@148 1879
c@148 1880 # The names of the make variables in the generated doxyrules.make file are
c@148 1881 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
c@148 1882 # so different doxyrules.make files included by the same Makefile don't
c@148 1883 # overwrite each other's variables.
c@148 1884 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
c@148 1885
c@148 1886 PERLMOD_MAKEVAR_PREFIX =
c@148 1887
c@148 1888 #---------------------------------------------------------------------------
c@148 1889 # Configuration options related to the preprocessor
c@148 1890 #---------------------------------------------------------------------------
c@148 1891
c@148 1892 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
c@148 1893 # C-preprocessor directives found in the sources and include files.
c@148 1894 # The default value is: YES.
c@148 1895
c@148 1896 ENABLE_PREPROCESSING = YES
c@148 1897
c@148 1898 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
c@148 1899 # in the source code. If set to NO only conditional compilation will be
c@148 1900 # performed. Macro expansion can be done in a controlled way by setting
c@148 1901 # EXPAND_ONLY_PREDEF to YES.
c@148 1902 # The default value is: NO.
c@148 1903 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
c@148 1904
c@148 1905 MACRO_EXPANSION = NO
c@148 1906
c@148 1907 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
c@148 1908 # the macro expansion is limited to the macros specified with the PREDEFINED and
c@148 1909 # EXPAND_AS_DEFINED tags.
c@148 1910 # The default value is: NO.
c@148 1911 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
c@148 1912
c@148 1913 EXPAND_ONLY_PREDEF = NO
c@148 1914
c@148 1915 # If the SEARCH_INCLUDES tag is set to YES the includes files in the
c@148 1916 # INCLUDE_PATH will be searched if a #include is found.
c@148 1917 # The default value is: YES.
c@148 1918 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
c@148 1919
c@148 1920 SEARCH_INCLUDES = YES
c@148 1921
c@148 1922 # The INCLUDE_PATH tag can be used to specify one or more directories that
c@148 1923 # contain include files that are not input files but should be processed by the
c@148 1924 # preprocessor.
c@148 1925 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
c@148 1926
c@148 1927 INCLUDE_PATH =
c@148 1928
c@148 1929 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
c@148 1930 # patterns (like *.h and *.hpp) to filter out the header-files in the
c@148 1931 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
c@148 1932 # used.
c@148 1933 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
c@148 1934
c@148 1935 INCLUDE_FILE_PATTERNS =
c@148 1936
c@148 1937 # The PREDEFINED tag can be used to specify one or more macro names that are
c@148 1938 # defined before the preprocessor is started (similar to the -D option of e.g.
c@148 1939 # gcc). The argument of the tag is a list of macros of the form: name or
c@148 1940 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
c@148 1941 # is assumed. To prevent a macro definition from being undefined via #undef or
c@148 1942 # recursively expanded use the := operator instead of the = operator.
c@148 1943 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
c@148 1944
c@148 1945 PREDEFINED =
c@148 1946
c@148 1947 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
c@148 1948 # tag can be used to specify a list of macro names that should be expanded. The
c@148 1949 # macro definition that is found in the sources will be used. Use the PREDEFINED
c@148 1950 # tag if you want to use a different macro definition that overrules the
c@148 1951 # definition found in the source code.
c@148 1952 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
c@148 1953
c@148 1954 EXPAND_AS_DEFINED =
c@148 1955
c@148 1956 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
c@148 1957 # remove all references to function-like macros that are alone on a line, have
c@148 1958 # an all uppercase name, and do not end with a semicolon. Such function macros
c@148 1959 # are typically used for boiler-plate code, and will confuse the parser if not
c@148 1960 # removed.
c@148 1961 # The default value is: YES.
c@148 1962 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
c@148 1963
c@148 1964 SKIP_FUNCTION_MACROS = YES
c@148 1965
c@148 1966 #---------------------------------------------------------------------------
c@148 1967 # Configuration options related to external references
c@148 1968 #---------------------------------------------------------------------------
c@148 1969
c@148 1970 # The TAGFILES tag can be used to specify one or more tag files. For each tag
c@148 1971 # file the location of the external documentation should be added. The format of
c@148 1972 # a tag file without this location is as follows:
c@148 1973 # TAGFILES = file1 file2 ...
c@148 1974 # Adding location for the tag files is done as follows:
c@148 1975 # TAGFILES = file1=loc1 "file2 = loc2" ...
c@148 1976 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
c@148 1977 # section "Linking to external documentation" for more information about the use
c@148 1978 # of tag files.
c@148 1979 # Note: Each tag file must have a unique name (where the name does NOT include
c@148 1980 # the path). If a tag file is not located in the directory in which doxygen is
c@148 1981 # run, you must also specify the path to the tagfile here.
c@148 1982
c@148 1983 TAGFILES =
c@148 1984
c@148 1985 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
c@148 1986 # tag file that is based on the input files it reads. See section "Linking to
c@148 1987 # external documentation" for more information about the usage of tag files.
c@148 1988
c@148 1989 GENERATE_TAGFILE =
c@148 1990
c@148 1991 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
c@148 1992 # class index. If set to NO only the inherited external classes will be listed.
c@148 1993 # The default value is: NO.
c@148 1994
c@148 1995 ALLEXTERNALS = NO
c@148 1996
c@148 1997 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
c@148 1998 # the modules index. If set to NO, only the current project's groups will be
c@148 1999 # listed.
c@148 2000 # The default value is: YES.
c@148 2001
c@148 2002 EXTERNAL_GROUPS = YES
c@148 2003
c@148 2004 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
c@148 2005 # the related pages index. If set to NO, only the current project's pages will
c@148 2006 # be listed.
c@148 2007 # The default value is: YES.
c@148 2008
c@148 2009 EXTERNAL_PAGES = YES
c@148 2010
c@148 2011 # The PERL_PATH should be the absolute path and name of the perl script
c@148 2012 # interpreter (i.e. the result of 'which perl').
c@148 2013 # The default file (with absolute path) is: /usr/bin/perl.
c@148 2014
c@148 2015 PERL_PATH = /usr/bin/perl
c@148 2016
c@148 2017 #---------------------------------------------------------------------------
c@148 2018 # Configuration options related to the dot tool
c@148 2019 #---------------------------------------------------------------------------
c@148 2020
c@148 2021 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
c@148 2022 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
c@148 2023 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
c@148 2024 # disabled, but it is recommended to install and use dot, since it yields more
c@148 2025 # powerful graphs.
c@148 2026 # The default value is: YES.
c@148 2027
c@148 2028 CLASS_DIAGRAMS = YES
c@148 2029
c@148 2030 # You can define message sequence charts within doxygen comments using the \msc
c@148 2031 # command. Doxygen will then run the mscgen tool (see:
c@148 2032 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
c@148 2033 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
c@148 2034 # the mscgen tool resides. If left empty the tool is assumed to be found in the
c@148 2035 # default search path.
c@148 2036
c@148 2037 MSCGEN_PATH =
c@148 2038
c@148 2039 # You can include diagrams made with dia in doxygen documentation. Doxygen will
c@148 2040 # then run dia to produce the diagram and insert it in the documentation. The
c@148 2041 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
c@148 2042 # If left empty dia is assumed to be found in the default search path.
c@148 2043
c@148 2044 DIA_PATH =
c@148 2045
c@148 2046 # If set to YES, the inheritance and collaboration graphs will hide inheritance
c@148 2047 # and usage relations if the target is undocumented or is not a class.
c@148 2048 # The default value is: YES.
c@148 2049
c@148 2050 HIDE_UNDOC_RELATIONS = YES
c@148 2051
c@148 2052 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
c@148 2053 # available from the path. This tool is part of Graphviz (see:
c@148 2054 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
c@148 2055 # Bell Labs. The other options in this section have no effect if this option is
c@148 2056 # set to NO
c@148 2057 # The default value is: NO.
c@148 2058
c@148 2059 HAVE_DOT = NO
c@148 2060
c@148 2061 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
c@148 2062 # to run in parallel. When set to 0 doxygen will base this on the number of
c@148 2063 # processors available in the system. You can set it explicitly to a value
c@148 2064 # larger than 0 to get control over the balance between CPU load and processing
c@148 2065 # speed.
c@148 2066 # Minimum value: 0, maximum value: 32, default value: 0.
c@148 2067 # This tag requires that the tag HAVE_DOT is set to YES.
c@148 2068
c@148 2069 DOT_NUM_THREADS = 0
c@148 2070
c@148 2071 # When you want a differently looking font n the dot files that doxygen
c@148 2072 # generates you can specify the font name using DOT_FONTNAME. You need to make
c@148 2073 # sure dot is able to find the font, which can be done by putting it in a
c@148 2074 # standard location or by setting the DOTFONTPATH environment variable or by
c@148 2075 # setting DOT_FONTPATH to the directory containing the font.
c@148 2076 # The default value is: Helvetica.
c@148 2077 # This tag requires that the tag HAVE_DOT is set to YES.
c@148 2078
c@148 2079 DOT_FONTNAME = Helvetica
c@148 2080
c@148 2081 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
c@148 2082 # dot graphs.
c@148 2083 # Minimum value: 4, maximum value: 24, default value: 10.
c@148 2084 # This tag requires that the tag HAVE_DOT is set to YES.
c@148 2085
c@148 2086 DOT_FONTSIZE = 10
c@148 2087
c@148 2088 # By default doxygen will tell dot to use the default font as specified with
c@148 2089 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
c@148 2090 # the path where dot can find it using this tag.
c@148 2091 # This tag requires that the tag HAVE_DOT is set to YES.
c@148 2092
c@148 2093 DOT_FONTPATH =
c@148 2094
c@148 2095 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
c@148 2096 # each documented class showing the direct and indirect inheritance relations.
c@148 2097 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
c@148 2098 # The default value is: YES.
c@148 2099 # This tag requires that the tag HAVE_DOT is set to YES.
c@148 2100
c@148 2101 CLASS_GRAPH = YES
c@148 2102
c@148 2103 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
c@148 2104 # graph for each documented class showing the direct and indirect implementation
c@148 2105 # dependencies (inheritance, containment, and class references variables) of the
c@148 2106 # class with other documented classes.
c@148 2107 # The default value is: YES.
c@148 2108 # This tag requires that the tag HAVE_DOT is set to YES.
c@148 2109
c@148 2110 COLLABORATION_GRAPH = YES
c@148 2111
c@148 2112 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
c@148 2113 # groups, showing the direct groups dependencies.
c@148 2114 # The default value is: YES.
c@148 2115 # This tag requires that the tag HAVE_DOT is set to YES.
c@148 2116
c@148 2117 GROUP_GRAPHS = YES
c@148 2118
c@148 2119 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
c@148 2120 # collaboration diagrams in a style similar to the OMG's Unified Modeling
c@148 2121 # Language.
c@148 2122 # The default value is: NO.
c@148 2123 # This tag requires that the tag HAVE_DOT is set to YES.
c@148 2124
c@148 2125 UML_LOOK = NO
c@148 2126
c@148 2127 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
c@148 2128 # class node. If there are many fields or methods and many nodes the graph may
c@148 2129 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
c@148 2130 # number of items for each type to make the size more manageable. Set this to 0
c@148 2131 # for no limit. Note that the threshold may be exceeded by 50% before the limit
c@148 2132 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
c@148 2133 # but if the number exceeds 15, the total amount of fields shown is limited to
c@148 2134 # 10.
c@148 2135 # Minimum value: 0, maximum value: 100, default value: 10.
c@148 2136 # This tag requires that the tag HAVE_DOT is set to YES.
c@148 2137
c@148 2138 UML_LIMIT_NUM_FIELDS = 10
c@148 2139
c@148 2140 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
c@148 2141 # collaboration graphs will show the relations between templates and their
c@148 2142 # instances.
c@148 2143 # The default value is: NO.
c@148 2144 # This tag requires that the tag HAVE_DOT is set to YES.
c@148 2145
c@148 2146 TEMPLATE_RELATIONS = NO
c@148 2147
c@148 2148 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
c@148 2149 # YES then doxygen will generate a graph for each documented file showing the
c@148 2150 # direct and indirect include dependencies of the file with other documented
c@148 2151 # files.
c@148 2152 # The default value is: YES.
c@148 2153 # This tag requires that the tag HAVE_DOT is set to YES.
c@148 2154
c@148 2155 INCLUDE_GRAPH = YES
c@148 2156
c@148 2157 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
c@148 2158 # set to YES then doxygen will generate a graph for each documented file showing
c@148 2159 # the direct and indirect include dependencies of the file with other documented
c@148 2160 # files.
c@148 2161 # The default value is: YES.
c@148 2162 # This tag requires that the tag HAVE_DOT is set to YES.
c@148 2163
c@148 2164 INCLUDED_BY_GRAPH = YES
c@148 2165
c@148 2166 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
c@148 2167 # dependency graph for every global function or class method.
c@148 2168 #
c@148 2169 # Note that enabling this option will significantly increase the time of a run.
c@148 2170 # So in most cases it will be better to enable call graphs for selected
c@148 2171 # functions only using the \callgraph command.
c@148 2172 # The default value is: NO.
c@148 2173 # This tag requires that the tag HAVE_DOT is set to YES.
c@148 2174
c@148 2175 CALL_GRAPH = NO
c@148 2176
c@148 2177 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
c@148 2178 # dependency graph for every global function or class method.
c@148 2179 #
c@148 2180 # Note that enabling this option will significantly increase the time of a run.
c@148 2181 # So in most cases it will be better to enable caller graphs for selected
c@148 2182 # functions only using the \callergraph command.
c@148 2183 # The default value is: NO.
c@148 2184 # This tag requires that the tag HAVE_DOT is set to YES.
c@148 2185
c@148 2186 CALLER_GRAPH = NO
c@148 2187
c@148 2188 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
c@148 2189 # hierarchy of all classes instead of a textual one.
c@148 2190 # The default value is: YES.
c@148 2191 # This tag requires that the tag HAVE_DOT is set to YES.
c@148 2192
c@148 2193 GRAPHICAL_HIERARCHY = YES
c@148 2194
c@148 2195 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
c@148 2196 # dependencies a directory has on other directories in a graphical way. The
c@148 2197 # dependency relations are determined by the #include relations between the
c@148 2198 # files in the directories.
c@148 2199 # The default value is: YES.
c@148 2200 # This tag requires that the tag HAVE_DOT is set to YES.
c@148 2201
c@148 2202 DIRECTORY_GRAPH = YES
c@148 2203
c@148 2204 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
c@148 2205 # generated by dot.
c@148 2206 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
c@148 2207 # to make the SVG files visible in IE 9+ (other browsers do not have this
c@148 2208 # requirement).
c@148 2209 # Possible values are: png, jpg, gif and svg.
c@148 2210 # The default value is: png.
c@148 2211 # This tag requires that the tag HAVE_DOT is set to YES.
c@148 2212
c@148 2213 DOT_IMAGE_FORMAT = png
c@148 2214
c@148 2215 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
c@148 2216 # enable generation of interactive SVG images that allow zooming and panning.
c@148 2217 #
c@148 2218 # Note that this requires a modern browser other than Internet Explorer. Tested
c@148 2219 # and working are Firefox, Chrome, Safari, and Opera.
c@148 2220 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
c@148 2221 # the SVG files visible. Older versions of IE do not have SVG support.
c@148 2222 # The default value is: NO.
c@148 2223 # This tag requires that the tag HAVE_DOT is set to YES.
c@148 2224
c@148 2225 INTERACTIVE_SVG = NO
c@148 2226
c@148 2227 # The DOT_PATH tag can be used to specify the path where the dot tool can be
c@148 2228 # found. If left blank, it is assumed the dot tool can be found in the path.
c@148 2229 # This tag requires that the tag HAVE_DOT is set to YES.
c@148 2230
c@148 2231 DOT_PATH =
c@148 2232
c@148 2233 # The DOTFILE_DIRS tag can be used to specify one or more directories that
c@148 2234 # contain dot files that are included in the documentation (see the \dotfile
c@148 2235 # command).
c@148 2236 # This tag requires that the tag HAVE_DOT is set to YES.
c@148 2237
c@148 2238 DOTFILE_DIRS =
c@148 2239
c@148 2240 # The MSCFILE_DIRS tag can be used to specify one or more directories that
c@148 2241 # contain msc files that are included in the documentation (see the \mscfile
c@148 2242 # command).
c@148 2243
c@148 2244 MSCFILE_DIRS =
c@148 2245
c@148 2246 # The DIAFILE_DIRS tag can be used to specify one or more directories that
c@148 2247 # contain dia files that are included in the documentation (see the \diafile
c@148 2248 # command).
c@148 2249
c@148 2250 DIAFILE_DIRS =
c@148 2251
c@148 2252 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
c@148 2253 # that will be shown in the graph. If the number of nodes in a graph becomes
c@148 2254 # larger than this value, doxygen will truncate the graph, which is visualized
c@148 2255 # by representing a node as a red box. Note that doxygen if the number of direct
c@148 2256 # children of the root node in a graph is already larger than
c@148 2257 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
c@148 2258 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
c@148 2259 # Minimum value: 0, maximum value: 10000, default value: 50.
c@148 2260 # This tag requires that the tag HAVE_DOT is set to YES.
c@148 2261
c@148 2262 DOT_GRAPH_MAX_NODES = 50
c@148 2263
c@148 2264 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
c@148 2265 # generated by dot. A depth value of 3 means that only nodes reachable from the
c@148 2266 # root by following a path via at most 3 edges will be shown. Nodes that lay
c@148 2267 # further from the root node will be omitted. Note that setting this option to 1
c@148 2268 # or 2 may greatly reduce the computation time needed for large code bases. Also
c@148 2269 # note that the size of a graph can be further restricted by
c@148 2270 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
c@148 2271 # Minimum value: 0, maximum value: 1000, default value: 0.
c@148 2272 # This tag requires that the tag HAVE_DOT is set to YES.
c@148 2273
c@148 2274 MAX_DOT_GRAPH_DEPTH = 0
c@148 2275
c@148 2276 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
c@148 2277 # background. This is disabled by default, because dot on Windows does not seem
c@148 2278 # to support this out of the box.
c@148 2279 #
c@148 2280 # Warning: Depending on the platform used, enabling this option may lead to
c@148 2281 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
c@148 2282 # read).
c@148 2283 # The default value is: NO.
c@148 2284 # This tag requires that the tag HAVE_DOT is set to YES.
c@148 2285
c@148 2286 DOT_TRANSPARENT = NO
c@148 2287
c@148 2288 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
c@148 2289 # files in one run (i.e. multiple -o and -T options on the command line). This
c@148 2290 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
c@148 2291 # this, this feature is disabled by default.
c@148 2292 # The default value is: NO.
c@148 2293 # This tag requires that the tag HAVE_DOT is set to YES.
c@148 2294
c@148 2295 DOT_MULTI_TARGETS = NO
c@148 2296
c@148 2297 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
c@148 2298 # explaining the meaning of the various boxes and arrows in the dot generated
c@148 2299 # graphs.
c@148 2300 # The default value is: YES.
c@148 2301 # This tag requires that the tag HAVE_DOT is set to YES.
c@148 2302
c@148 2303 GENERATE_LEGEND = YES
c@148 2304
c@148 2305 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
c@148 2306 # files that are used to generate the various graphs.
c@148 2307 # The default value is: YES.
c@148 2308 # This tag requires that the tag HAVE_DOT is set to YES.
c@148 2309
c@148 2310 DOT_CLEANUP = YES