annotate Doxyfile @ 2596:04d381f0d89a tip

Default branch is now named default on git as well as hg, in case we ever want to switch to mirroring in the other direction
author Chris Cannam
date Thu, 27 Aug 2020 15:58:56 +0100 (2020-08-27)
parents aad0c5aca114
children
rev   line source
Chris@486 1 # Doxyfile 1.4.4
Chris@486 2
Chris@486 3 # This file describes the settings to be used by the documentation system
Chris@486 4 # doxygen (www.doxygen.org) for a project
Chris@486 5 #
Chris@486 6 # All text after a hash (#) is considered a comment and will be ignored
Chris@486 7 # The format is:
Chris@486 8 # TAG = value [value, ...]
Chris@486 9 # For lists items can also be appended using:
Chris@486 10 # TAG += value [value, ...]
Chris@486 11 # Values that contain spaces should be placed between quotes (" ")
Chris@486 12
Chris@486 13 #---------------------------------------------------------------------------
Chris@486 14 # Project related configuration options
Chris@486 15 #---------------------------------------------------------------------------
Chris@486 16
Chris@486 17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
Chris@486 18 # by quotes) that should identify the project.
Chris@486 19
Chris@486 20 PROJECT_NAME = Sonic Visualiser
Chris@486 21
Chris@486 22 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
Chris@486 23 # This could be handy for archiving the generated documentation or
Chris@486 24 # if some version control system is used.
Chris@486 25
Chris@486 26 PROJECT_NUMBER = 1.9
Chris@486 27
Chris@486 28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
Chris@486 29 # base path where the generated documentation will be put.
Chris@486 30 # If a relative path is entered, it will be relative to the location
Chris@486 31 # where doxygen was started. If left blank the current directory will be used.
Chris@486 32
Chris@486 33 OUTPUT_DIRECTORY = doc
Chris@486 34
Chris@486 35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
Chris@486 36 # 4096 sub-directories (in 2 levels) under the output directory of each output
Chris@486 37 # format and will distribute the generated files over these directories.
Chris@486 38 # Enabling this option can be useful when feeding doxygen a huge amount of
Chris@486 39 # source files, where putting all generated files in the same directory would
Chris@486 40 # otherwise cause performance problems for the file system.
Chris@486 41
Chris@486 42 CREATE_SUBDIRS = NO
Chris@486 43
Chris@486 44 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
Chris@486 45 # documentation generated by doxygen is written. Doxygen will use this
Chris@486 46 # information to generate all constant output in the proper language.
Chris@486 47 # The default language is English, other supported languages are:
Chris@486 48 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
Chris@486 49 # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
Chris@486 50 # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
Chris@486 51 # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
Chris@486 52 # Swedish, and Ukrainian.
Chris@486 53
Chris@486 54 OUTPUT_LANGUAGE = English
Chris@486 55
Chris@486 56 # This tag can be used to specify the encoding used in the generated output.
Chris@486 57 # The encoding is not always determined by the language that is chosen,
Chris@486 58 # but also whether or not the output is meant for Windows or non-Windows users.
Chris@486 59 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
Chris@486 60 # forces the Windows encoding (this is the default for the Windows binary),
Chris@486 61 # whereas setting the tag to NO uses a Unix-style encoding (the default for
Chris@486 62 # all platforms other than Windows).
Chris@486 63
Chris@486 64 USE_WINDOWS_ENCODING = NO
Chris@486 65
Chris@486 66 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
Chris@486 67 # include brief member descriptions after the members that are listed in
Chris@486 68 # the file and class documentation (similar to JavaDoc).
Chris@486 69 # Set to NO to disable this.
Chris@486 70
Chris@486 71 BRIEF_MEMBER_DESC = YES
Chris@486 72
Chris@486 73 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
Chris@486 74 # the brief description of a member or function before the detailed description.
Chris@486 75 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
Chris@486 76 # brief descriptions will be completely suppressed.
Chris@486 77
Chris@486 78 REPEAT_BRIEF = YES
Chris@486 79
Chris@486 80 # This tag implements a quasi-intelligent brief description abbreviator
Chris@486 81 # that is used to form the text in various listings. Each string
Chris@486 82 # in this list, if found as the leading text of the brief description, will be
Chris@486 83 # stripped from the text and the result after processing the whole list, is
Chris@486 84 # used as the annotated text. Otherwise, the brief description is used as-is.
Chris@486 85 # If left blank, the following values are used ("$name" is automatically
Chris@486 86 # replaced with the name of the entity): "The $name class" "The $name widget"
Chris@486 87 # "The $name file" "is" "provides" "specifies" "contains"
Chris@486 88 # "represents" "a" "an" "the"
Chris@486 89
Chris@486 90 ABBREVIATE_BRIEF =
Chris@486 91
Chris@486 92 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
Chris@486 93 # Doxygen will generate a detailed section even if there is only a brief
Chris@486 94 # description.
Chris@486 95
Chris@486 96 ALWAYS_DETAILED_SEC = NO
Chris@486 97
Chris@486 98 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
Chris@486 99 # inherited members of a class in the documentation of that class as if those
Chris@486 100 # members were ordinary class members. Constructors, destructors and assignment
Chris@486 101 # operators of the base classes will not be shown.
Chris@486 102
Chris@486 103 INLINE_INHERITED_MEMB = YES
Chris@486 104
Chris@486 105 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
Chris@486 106 # path before files name in the file list and in the header files. If set
Chris@486 107 # to NO the shortest path that makes the file name unique will be used
Chris@486 108
Chris@486 109 FULL_PATH_NAMES = NO
Chris@486 110
Chris@486 111 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
Chris@486 112 # can be used to strip a user-defined part of the path. Stripping is
Chris@486 113 # only done if one of the specified strings matches the left-hand part of
Chris@486 114 # the path. The tag can be used to show relative paths in the file list.
Chris@486 115 # If left blank the directory from which doxygen is run is used as the
Chris@486 116 # path to strip.
Chris@486 117
Chris@486 118 STRIP_FROM_PATH =
Chris@486 119
Chris@486 120 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
Chris@486 121 # the path mentioned in the documentation of a class, which tells
Chris@486 122 # the reader which header file to include in order to use a class.
Chris@486 123 # If left blank only the name of the header file containing the class
Chris@486 124 # definition is used. Otherwise one should specify the include paths that
Chris@486 125 # are normally passed to the compiler using the -I flag.
Chris@486 126
Chris@486 127 STRIP_FROM_INC_PATH =
Chris@486 128
Chris@486 129 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
Chris@486 130 # (but less readable) file names. This can be useful is your file systems
Chris@486 131 # doesn't support long names like on DOS, Mac, or CD-ROM.
Chris@486 132
Chris@486 133 SHORT_NAMES = NO
Chris@486 134
Chris@486 135 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
Chris@486 136 # will interpret the first line (until the first dot) of a JavaDoc-style
Chris@486 137 # comment as the brief description. If set to NO, the JavaDoc
Chris@486 138 # comments will behave just like the Qt-style comments (thus requiring an
Chris@486 139 # explicit @brief command for a brief description.
Chris@486 140
Chris@486 141 JAVADOC_AUTOBRIEF = YES
Chris@486 142
Chris@486 143 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
Chris@486 144 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
Chris@486 145 # comments) as a brief description. This used to be the default behaviour.
Chris@486 146 # The new default is to treat a multi-line C++ comment block as a detailed
Chris@486 147 # description. Set this tag to YES if you prefer the old behaviour instead.
Chris@486 148
Chris@486 149 MULTILINE_CPP_IS_BRIEF = NO
Chris@486 150
Chris@486 151 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
Chris@486 152 # will output the detailed description near the top, like JavaDoc.
Chris@486 153 # If set to NO, the detailed description appears after the member
Chris@486 154 # documentation.
Chris@486 155
Chris@486 156 DETAILS_AT_TOP = YES
Chris@486 157
Chris@486 158 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
Chris@486 159 # member inherits the documentation from any documented member that it
Chris@486 160 # re-implements.
Chris@486 161
Chris@486 162 INHERIT_DOCS = YES
Chris@486 163
Chris@486 164 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
Chris@486 165 # tag is set to YES, then doxygen will reuse the documentation of the first
Chris@486 166 # member in the group (if any) for the other members of the group. By default
Chris@486 167 # all members of a group must be documented explicitly.
Chris@486 168
Chris@486 169 DISTRIBUTE_GROUP_DOC = NO
Chris@486 170
Chris@486 171 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
Chris@486 172 # a new page for each member. If set to NO, the documentation of a member will
Chris@486 173 # be part of the file/class/namespace that contains it.
Chris@486 174
Chris@486 175 SEPARATE_MEMBER_PAGES = NO
Chris@486 176
Chris@486 177 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
Chris@486 178 # Doxygen uses this value to replace tabs by spaces in code fragments.
Chris@486 179
Chris@486 180 TAB_SIZE = 8
Chris@486 181
Chris@486 182 # This tag can be used to specify a number of aliases that acts
Chris@486 183 # as commands in the documentation. An alias has the form "name=value".
Chris@486 184 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
Chris@486 185 # put the command \sideeffect (or @sideeffect) in the documentation, which
Chris@486 186 # will result in a user-defined paragraph with heading "Side Effects:".
Chris@486 187 # You can put \n's in the value part of an alias to insert newlines.
Chris@486 188
Chris@486 189 ALIASES =
Chris@486 190
Chris@486 191 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
Chris@486 192 # sources only. Doxygen will then generate output that is more tailored for C.
Chris@486 193 # For instance, some of the names that are used will be different. The list
Chris@486 194 # of all members will be omitted, etc.
Chris@486 195
Chris@486 196 OPTIMIZE_OUTPUT_FOR_C = NO
Chris@486 197
Chris@486 198 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
Chris@486 199 # only. Doxygen will then generate output that is more tailored for Java.
Chris@486 200 # For instance, namespaces will be presented as packages, qualified scopes
Chris@486 201 # will look different, etc.
Chris@486 202
Chris@486 203 OPTIMIZE_OUTPUT_JAVA = NO
Chris@486 204
Chris@486 205 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
Chris@486 206 # the same type (for instance a group of public functions) to be put as a
Chris@486 207 # subgroup of that type (e.g. under the Public Functions section). Set it to
Chris@486 208 # NO to prevent subgrouping. Alternatively, this can be done per class using
Chris@486 209 # the \nosubgrouping command.
Chris@486 210
Chris@486 211 SUBGROUPING = YES
Chris@486 212
Chris@486 213 #---------------------------------------------------------------------------
Chris@486 214 # Build related configuration options
Chris@486 215 #---------------------------------------------------------------------------
Chris@486 216
Chris@486 217 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
Chris@486 218 # documentation are documented, even if no documentation was available.
Chris@486 219 # Private class members and static file members will be hidden unless
Chris@486 220 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
Chris@486 221
Chris@486 222 EXTRACT_ALL = YES
Chris@486 223
Chris@486 224 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
Chris@486 225 # will be included in the documentation.
Chris@486 226
Chris@486 227 EXTRACT_PRIVATE = YES
Chris@486 228
Chris@486 229 # If the EXTRACT_STATIC tag is set to YES all static members of a file
Chris@486 230 # will be included in the documentation.
Chris@486 231
Chris@486 232 EXTRACT_STATIC = YES
Chris@486 233
Chris@486 234 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
Chris@486 235 # defined locally in source files will be included in the documentation.
Chris@486 236 # If set to NO only classes defined in header files are included.
Chris@486 237
Chris@486 238 EXTRACT_LOCAL_CLASSES = YES
Chris@486 239
Chris@486 240 # This flag is only useful for Objective-C code. When set to YES local
Chris@486 241 # methods, which are defined in the implementation section but not in
Chris@486 242 # the interface are included in the documentation.
Chris@486 243 # If set to NO (the default) only methods in the interface are included.
Chris@486 244
Chris@486 245 EXTRACT_LOCAL_METHODS = NO
Chris@486 246
Chris@486 247 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
Chris@486 248 # undocumented members of documented classes, files or namespaces.
Chris@486 249 # If set to NO (the default) these members will be included in the
Chris@486 250 # various overviews, but no documentation section is generated.
Chris@486 251 # This option has no effect if EXTRACT_ALL is enabled.
Chris@486 252
Chris@486 253 HIDE_UNDOC_MEMBERS = NO
Chris@486 254
Chris@486 255 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
Chris@486 256 # undocumented classes that are normally visible in the class hierarchy.
Chris@486 257 # If set to NO (the default) these classes will be included in the various
Chris@486 258 # overviews. This option has no effect if EXTRACT_ALL is enabled.
Chris@486 259
Chris@486 260 HIDE_UNDOC_CLASSES = NO
Chris@486 261
Chris@486 262 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
Chris@486 263 # friend (class|struct|union) declarations.
Chris@486 264 # If set to NO (the default) these declarations will be included in the
Chris@486 265 # documentation.
Chris@486 266
Chris@486 267 HIDE_FRIEND_COMPOUNDS = NO
Chris@486 268
Chris@486 269 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
Chris@486 270 # documentation blocks found inside the body of a function.
Chris@486 271 # If set to NO (the default) these blocks will be appended to the
Chris@486 272 # function's detailed documentation block.
Chris@486 273
Chris@486 274 HIDE_IN_BODY_DOCS = NO
Chris@486 275
Chris@486 276 # The INTERNAL_DOCS tag determines if documentation
Chris@486 277 # that is typed after a \internal command is included. If the tag is set
Chris@486 278 # to NO (the default) then the documentation will be excluded.
Chris@486 279 # Set it to YES to include the internal documentation.
Chris@486 280
Chris@486 281 INTERNAL_DOCS = NO
Chris@486 282
Chris@486 283 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
Chris@486 284 # file names in lower-case letters. If set to YES upper-case letters are also
Chris@486 285 # allowed. This is useful if you have classes or files whose names only differ
Chris@486 286 # in case and if your file system supports case sensitive file names. Windows
Chris@486 287 # and Mac users are advised to set this option to NO.
Chris@486 288
Chris@486 289 CASE_SENSE_NAMES = YES
Chris@486 290
Chris@486 291 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
Chris@486 292 # will show members with their full class and namespace scopes in the
Chris@486 293 # documentation. If set to YES the scope will be hidden.
Chris@486 294
Chris@486 295 HIDE_SCOPE_NAMES = NO
Chris@486 296
Chris@486 297 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
Chris@486 298 # will put a list of the files that are included by a file in the documentation
Chris@486 299 # of that file.
Chris@486 300
Chris@486 301 SHOW_INCLUDE_FILES = YES
Chris@486 302
Chris@486 303 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
Chris@486 304 # is inserted in the documentation for inline members.
Chris@486 305
Chris@486 306 INLINE_INFO = YES
Chris@486 307
Chris@486 308 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
Chris@486 309 # will sort the (detailed) documentation of file and class members
Chris@486 310 # alphabetically by member name. If set to NO the members will appear in
Chris@486 311 # declaration order.
Chris@486 312
Chris@486 313 SORT_MEMBER_DOCS = NO
Chris@486 314
Chris@486 315 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
Chris@486 316 # brief documentation of file, namespace and class members alphabetically
Chris@486 317 # by member name. If set to NO (the default) the members will appear in
Chris@486 318 # declaration order.
Chris@486 319
Chris@486 320 SORT_BRIEF_DOCS = NO
Chris@486 321
Chris@486 322 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
Chris@486 323 # sorted by fully-qualified names, including namespaces. If set to
Chris@486 324 # NO (the default), the class list will be sorted only by class name,
Chris@486 325 # not including the namespace part.
Chris@486 326 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
Chris@486 327 # Note: This option applies only to the class list, not to the
Chris@486 328 # alphabetical list.
Chris@486 329
Chris@486 330 SORT_BY_SCOPE_NAME = NO
Chris@486 331
Chris@486 332 # The GENERATE_TODOLIST tag can be used to enable (YES) or
Chris@486 333 # disable (NO) the todo list. This list is created by putting \todo
Chris@486 334 # commands in the documentation.
Chris@486 335
Chris@486 336 GENERATE_TODOLIST = YES
Chris@486 337
Chris@486 338 # The GENERATE_TESTLIST tag can be used to enable (YES) or
Chris@486 339 # disable (NO) the test list. This list is created by putting \test
Chris@486 340 # commands in the documentation.
Chris@486 341
Chris@486 342 GENERATE_TESTLIST = YES
Chris@486 343
Chris@486 344 # The GENERATE_BUGLIST tag can be used to enable (YES) or
Chris@486 345 # disable (NO) the bug list. This list is created by putting \bug
Chris@486 346 # commands in the documentation.
Chris@486 347
Chris@486 348 GENERATE_BUGLIST = YES
Chris@486 349
Chris@486 350 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
Chris@486 351 # disable (NO) the deprecated list. This list is created by putting
Chris@486 352 # \deprecated commands in the documentation.
Chris@486 353
Chris@486 354 GENERATE_DEPRECATEDLIST= YES
Chris@486 355
Chris@486 356 # The ENABLED_SECTIONS tag can be used to enable conditional
Chris@486 357 # documentation sections, marked by \if sectionname ... \endif.
Chris@486 358
Chris@486 359 ENABLED_SECTIONS =
Chris@486 360
Chris@486 361 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
Chris@486 362 # the initial value of a variable or define consists of for it to appear in
Chris@486 363 # the documentation. If the initializer consists of more lines than specified
Chris@486 364 # here it will be hidden. Use a value of 0 to hide initializers completely.
Chris@486 365 # The appearance of the initializer of individual variables and defines in the
Chris@486 366 # documentation can be controlled using \showinitializer or \hideinitializer
Chris@486 367 # command in the documentation regardless of this setting.
Chris@486 368
Chris@486 369 MAX_INITIALIZER_LINES = 30
Chris@486 370
Chris@486 371 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
Chris@486 372 # at the bottom of the documentation of classes and structs. If set to YES the
Chris@486 373 # list will mention the files that were used to generate the documentation.
Chris@486 374
Chris@486 375 SHOW_USED_FILES = YES
Chris@486 376
Chris@486 377 # If the sources in your project are distributed over multiple directories
Chris@486 378 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
Chris@486 379 # in the documentation. The default is YES.
Chris@486 380
Chris@486 381 SHOW_DIRECTORIES = YES
Chris@486 382
Chris@486 383 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
Chris@486 384 # doxygen should invoke to get the current version for each file (typically from the
Chris@486 385 # version control system). Doxygen will invoke the program by executing (via
Chris@486 386 # popen()) the command <command> <input-file>, where <command> is the value of
Chris@486 387 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
Chris@486 388 # provided by doxygen. Whatever the progam writes to standard output
Chris@486 389 # is used as the file version. See the manual for examples.
Chris@486 390
Chris@486 391 FILE_VERSION_FILTER =
Chris@486 392
Chris@486 393 #---------------------------------------------------------------------------
Chris@486 394 # configuration options related to warning and progress messages
Chris@486 395 #---------------------------------------------------------------------------
Chris@486 396
Chris@486 397 # The QUIET tag can be used to turn on/off the messages that are generated
Chris@486 398 # by doxygen. Possible values are YES and NO. If left blank NO is used.
Chris@486 399
Chris@486 400 QUIET = NO
Chris@486 401
Chris@486 402 # The WARNINGS tag can be used to turn on/off the warning messages that are
Chris@486 403 # generated by doxygen. Possible values are YES and NO. If left blank
Chris@486 404 # NO is used.
Chris@486 405
Chris@486 406 WARNINGS = YES
Chris@486 407
Chris@486 408 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
Chris@486 409 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
Chris@486 410 # automatically be disabled.
Chris@486 411
Chris@486 412 WARN_IF_UNDOCUMENTED = YES
Chris@486 413
Chris@486 414 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
Chris@486 415 # potential errors in the documentation, such as not documenting some
Chris@486 416 # parameters in a documented function, or documenting parameters that
Chris@486 417 # don't exist or using markup commands wrongly.
Chris@486 418
Chris@486 419 WARN_IF_DOC_ERROR = YES
Chris@486 420
Chris@486 421 # This WARN_NO_PARAMDOC option can be abled to get warnings for
Chris@486 422 # functions that are documented, but have no documentation for their parameters
Chris@486 423 # or return value. If set to NO (the default) doxygen will only warn about
Chris@486 424 # wrong or incomplete parameter documentation, but not about the absence of
Chris@486 425 # documentation.
Chris@486 426
Chris@486 427 WARN_NO_PARAMDOC = YES
Chris@486 428
Chris@486 429 # The WARN_FORMAT tag determines the format of the warning messages that
Chris@486 430 # doxygen can produce. The string should contain the $file, $line, and $text
Chris@486 431 # tags, which will be replaced by the file and line number from which the
Chris@486 432 # warning originated and the warning text. Optionally the format may contain
Chris@486 433 # $version, which will be replaced by the version of the file (if it could
Chris@486 434 # be obtained via FILE_VERSION_FILTER)
Chris@486 435
Chris@486 436 WARN_FORMAT = "$file:$line: $text"
Chris@486 437
Chris@486 438 # The WARN_LOGFILE tag can be used to specify a file to which warning
Chris@486 439 # and error messages should be written. If left blank the output is written
Chris@486 440 # to stderr.
Chris@486 441
Chris@486 442 WARN_LOGFILE = docs/doxygen/warning.log
Chris@486 443
Chris@486 444 #---------------------------------------------------------------------------
Chris@486 445 # configuration options related to the input files
Chris@486 446 #---------------------------------------------------------------------------
Chris@486 447
Chris@486 448 # The INPUT tag can be used to specify the files and/or directories that contain
Chris@486 449 # documented source files. You may enter file names like "myfile.cpp" or
Chris@486 450 # directories like "/usr/src/myproject". Separate the files or directories
Chris@486 451 # with spaces.
Chris@486 452
Chris@486 453 INPUT = main
Chris@486 454
Chris@486 455 # If the value of the INPUT tag contains directories, you can use the
Chris@486 456 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
Chris@486 457 # and *.h) to filter out the source-files in the directories. If left
Chris@486 458 # blank the following patterns are tested:
Chris@486 459 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
Chris@486 460 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
Chris@486 461
Chris@486 462 FILE_PATTERNS = *.h \
Chris@486 463 *.C \
Chris@486 464 *.cpp \
Chris@486 465 *.cc
Chris@486 466
Chris@486 467 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
Chris@486 468 # should be searched for input files as well. Possible values are YES and NO.
Chris@486 469 # If left blank NO is used.
Chris@486 470
Chris@486 471 RECURSIVE = NO
Chris@486 472
Chris@486 473 # The EXCLUDE tag can be used to specify files and/or directories that should
Chris@486 474 # excluded from the INPUT source files. This way you can easily exclude a
Chris@486 475 # subdirectory from a directory tree whose root is specified with the INPUT tag.
Chris@486 476
Chris@486 477 EXCLUDE =
Chris@486 478
Chris@486 479 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
Chris@486 480 # directories that are symbolic links (a Unix filesystem feature) are excluded
Chris@486 481 # from the input.
Chris@486 482
Chris@486 483 EXCLUDE_SYMLINKS = NO
Chris@486 484
Chris@486 485 # If the value of the INPUT tag contains directories, you can use the
Chris@486 486 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
Chris@486 487 # certain files from those directories. Note that the wildcards are matched
Chris@486 488 # against the file with absolute path, so to exclude all test directories
Chris@486 489 # for example use the pattern */test/*
Chris@486 490
Chris@486 491 EXCLUDE_PATTERNS = qrc_*.cpp \
Chris@486 492 moc_*.cpp \
Chris@486 493 *.moc.cpp \
Chris@486 494 *_skel.cpp
Chris@486 495
Chris@486 496 # The EXAMPLE_PATH tag can be used to specify one or more files or
Chris@486 497 # directories that contain example code fragments that are included (see
Chris@486 498 # the \include command).
Chris@486 499
Chris@486 500 EXAMPLE_PATH =
Chris@486 501
Chris@486 502 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
Chris@486 503 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
Chris@486 504 # and *.h) to filter out the source-files in the directories. If left
Chris@486 505 # blank all files are included.
Chris@486 506
Chris@486 507 EXAMPLE_PATTERNS =
Chris@486 508
Chris@486 509 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
Chris@486 510 # searched for input files to be used with the \include or \dontinclude
Chris@486 511 # commands irrespective of the value of the RECURSIVE tag.
Chris@486 512 # Possible values are YES and NO. If left blank NO is used.
Chris@486 513
Chris@486 514 EXAMPLE_RECURSIVE = NO
Chris@486 515
Chris@486 516 # The IMAGE_PATH tag can be used to specify one or more files or
Chris@486 517 # directories that contain image that are included in the documentation (see
Chris@486 518 # the \image command).
Chris@486 519
Chris@486 520 IMAGE_PATH =
Chris@486 521
Chris@486 522 # The INPUT_FILTER tag can be used to specify a program that doxygen should
Chris@486 523 # invoke to filter for each input file. Doxygen will invoke the filter program
Chris@486 524 # by executing (via popen()) the command <filter> <input-file>, where <filter>
Chris@486 525 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
Chris@486 526 # input file. Doxygen will then use the output that the filter program writes
Chris@486 527 # to standard output. If FILTER_PATTERNS is specified, this tag will be
Chris@486 528 # ignored.
Chris@486 529
Chris@486 530 INPUT_FILTER =
Chris@486 531
Chris@486 532 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
Chris@486 533 # basis. Doxygen will compare the file name with each pattern and apply the
Chris@486 534 # filter if there is a match. The filters are a list of the form:
Chris@486 535 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
Chris@486 536 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
Chris@486 537 # is applied to all files.
Chris@486 538
Chris@486 539 FILTER_PATTERNS =
Chris@486 540
Chris@486 541 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
Chris@486 542 # INPUT_FILTER) will be used to filter the input files when producing source
Chris@486 543 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
Chris@486 544
Chris@486 545 FILTER_SOURCE_FILES = NO
Chris@486 546
Chris@486 547 #---------------------------------------------------------------------------
Chris@486 548 # configuration options related to source browsing
Chris@486 549 #---------------------------------------------------------------------------
Chris@486 550
Chris@486 551 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
Chris@486 552 # be generated. Documented entities will be cross-referenced with these sources.
Chris@486 553 # Note: To get rid of all source code in the generated output, make sure also
Chris@486 554 # VERBATIM_HEADERS is set to NO.
Chris@486 555
Chris@486 556 SOURCE_BROWSER = YES
Chris@486 557
Chris@486 558 # Setting the INLINE_SOURCES tag to YES will include the body
Chris@486 559 # of functions and classes directly in the documentation.
Chris@486 560
Chris@486 561 INLINE_SOURCES = NO
Chris@486 562
Chris@486 563 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
Chris@486 564 # doxygen to hide any special comment blocks from generated source code
Chris@486 565 # fragments. Normal C and C++ comments will always remain visible.
Chris@486 566
Chris@486 567 STRIP_CODE_COMMENTS = YES
Chris@486 568
Chris@486 569 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
Chris@486 570 # then for each documented function all documented
Chris@486 571 # functions referencing it will be listed.
Chris@486 572
Chris@486 573 REFERENCED_BY_RELATION = YES
Chris@486 574
Chris@486 575 # If the REFERENCES_RELATION tag is set to YES (the default)
Chris@486 576 # then for each documented function all documented entities
Chris@486 577 # called/used by that function will be listed.
Chris@486 578
Chris@486 579 REFERENCES_RELATION = YES
Chris@486 580
Chris@486 581 # If the USE_HTAGS tag is set to YES then the references to source code
Chris@486 582 # will point to the HTML generated by the htags(1) tool instead of doxygen
Chris@486 583 # built-in source browser. The htags tool is part of GNU's global source
Chris@486 584 # tagging system (see http://www.gnu.org/software/global/global.html). You
Chris@486 585 # will need version 4.8.6 or higher.
Chris@486 586
Chris@486 587 #USE_HTAGS = NO
Chris@486 588
Chris@486 589 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
Chris@486 590 # will generate a verbatim copy of the header file for each class for
Chris@486 591 # which an include is specified. Set to NO to disable this.
Chris@486 592
Chris@486 593 VERBATIM_HEADERS = YES
Chris@486 594
Chris@486 595 #---------------------------------------------------------------------------
Chris@486 596 # configuration options related to the alphabetical class index
Chris@486 597 #---------------------------------------------------------------------------
Chris@486 598
Chris@486 599 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
Chris@486 600 # of all compounds will be generated. Enable this if the project
Chris@486 601 # contains a lot of classes, structs, unions or interfaces.
Chris@486 602
Chris@486 603 ALPHABETICAL_INDEX = YES
Chris@486 604
Chris@486 605 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
Chris@486 606 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
Chris@486 607 # in which this list will be split (can be a number in the range [1..20])
Chris@486 608
Chris@486 609 COLS_IN_ALPHA_INDEX = 3
Chris@486 610
Chris@486 611 # In case all classes in a project start with a common prefix, all
Chris@486 612 # classes will be put under the same header in the alphabetical index.
Chris@486 613 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
Chris@486 614 # should be ignored while generating the index headers.
Chris@486 615
Chris@486 616 IGNORE_PREFIX =
Chris@486 617
Chris@486 618 #---------------------------------------------------------------------------
Chris@486 619 # configuration options related to the HTML output
Chris@486 620 #---------------------------------------------------------------------------
Chris@486 621
Chris@486 622 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
Chris@486 623 # generate HTML output.
Chris@486 624
Chris@486 625 GENERATE_HTML = YES
Chris@486 626
Chris@486 627 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
Chris@486 628 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
Chris@486 629 # put in front of it. If left blank `html' will be used as the default path.
Chris@486 630
Chris@486 631 HTML_OUTPUT = html
Chris@486 632
Chris@486 633 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
Chris@486 634 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
Chris@486 635 # doxygen will generate files with .html extension.
Chris@486 636
Chris@486 637 HTML_FILE_EXTENSION = .html
Chris@486 638
Chris@486 639 # The HTML_HEADER tag can be used to specify a personal HTML header for
Chris@486 640 # each generated HTML page. If it is left blank doxygen will generate a
Chris@486 641 # standard header.
Chris@486 642
Chris@486 643 HTML_HEADER =
Chris@486 644
Chris@486 645 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
Chris@486 646 # each generated HTML page. If it is left blank doxygen will generate a
Chris@486 647 # standard footer.
Chris@486 648
Chris@486 649 HTML_FOOTER =
Chris@486 650
Chris@486 651 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
Chris@486 652 # style sheet that is used by each HTML page. It can be used to
Chris@486 653 # fine-tune the look of the HTML output. If the tag is left blank doxygen
Chris@486 654 # will generate a default style sheet. Note that doxygen will try to copy
Chris@486 655 # the style sheet file to the HTML output directory, so don't put your own
Chris@486 656 # stylesheet in the HTML output directory as well, or it will be erased!
Chris@486 657
Chris@486 658 HTML_STYLESHEET =
Chris@486 659
Chris@486 660 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
Chris@486 661 # files or namespaces will be aligned in HTML using tables. If set to
Chris@486 662 # NO a bullet list will be used.
Chris@486 663
Chris@486 664 HTML_ALIGN_MEMBERS = YES
Chris@486 665
Chris@486 666 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
Chris@486 667 # will be generated that can be used as input for tools like the
Chris@486 668 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
Chris@486 669 # of the generated HTML documentation.
Chris@486 670
Chris@486 671 GENERATE_HTMLHELP = NO
Chris@486 672
Chris@486 673 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
Chris@486 674 # be used to specify the file name of the resulting .chm file. You
Chris@486 675 # can add a path in front of the file if the result should not be
Chris@486 676 # written to the html output directory.
Chris@486 677
Chris@486 678 CHM_FILE =
Chris@486 679
Chris@486 680 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
Chris@486 681 # be used to specify the location (absolute path including file name) of
Chris@486 682 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
Chris@486 683 # the HTML help compiler on the generated index.hhp.
Chris@486 684
Chris@486 685 HHC_LOCATION =
Chris@486 686
Chris@486 687 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
Chris@486 688 # controls if a separate .chi index file is generated (YES) or that
Chris@486 689 # it should be included in the master .chm file (NO).
Chris@486 690
Chris@486 691 GENERATE_CHI = NO
Chris@486 692
Chris@486 693 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
Chris@486 694 # controls whether a binary table of contents is generated (YES) or a
Chris@486 695 # normal table of contents (NO) in the .chm file.
Chris@486 696
Chris@486 697 BINARY_TOC = NO
Chris@486 698
Chris@486 699 # The TOC_EXPAND flag can be set to YES to add extra items for group members
Chris@486 700 # to the contents of the HTML help documentation and to the tree view.
Chris@486 701
Chris@486 702 TOC_EXPAND = NO
Chris@486 703
Chris@486 704 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
Chris@486 705 # top of each HTML page. The value NO (the default) enables the index and
Chris@486 706 # the value YES disables it.
Chris@486 707
Chris@486 708 DISABLE_INDEX = NO
Chris@486 709
Chris@486 710 # This tag can be used to set the number of enum values (range [1..20])
Chris@486 711 # that doxygen will group on one line in the generated HTML documentation.
Chris@486 712
Chris@486 713 ENUM_VALUES_PER_LINE = 4
Chris@486 714
Chris@486 715 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
Chris@486 716 # generated containing a tree-like index structure (just like the one that
Chris@486 717 # is generated for HTML Help). For this to work a browser that supports
Chris@486 718 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
Chris@486 719 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
Chris@486 720 # probably better off using the HTML help feature.
Chris@486 721
Chris@486 722 GENERATE_TREEVIEW = YES
Chris@486 723
Chris@486 724 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
Chris@486 725 # used to set the initial width (in pixels) of the frame in which the tree
Chris@486 726 # is shown.
Chris@486 727
Chris@486 728 TREEVIEW_WIDTH = 250
Chris@486 729
Chris@486 730 #---------------------------------------------------------------------------
Chris@486 731 # configuration options related to the LaTeX output
Chris@486 732 #---------------------------------------------------------------------------
Chris@486 733
Chris@486 734 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
Chris@486 735 # generate Latex output.
Chris@486 736
Chris@486 737 GENERATE_LATEX = NO
Chris@486 738
Chris@486 739 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
Chris@486 740 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
Chris@486 741 # put in front of it. If left blank `latex' will be used as the default path.
Chris@486 742
Chris@486 743 LATEX_OUTPUT = latex
Chris@486 744
Chris@486 745 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
Chris@486 746 # invoked. If left blank `latex' will be used as the default command name.
Chris@486 747
Chris@486 748 LATEX_CMD_NAME = latex
Chris@486 749
Chris@486 750 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
Chris@486 751 # generate index for LaTeX. If left blank `makeindex' will be used as the
Chris@486 752 # default command name.
Chris@486 753
Chris@486 754 MAKEINDEX_CMD_NAME = makeindex
Chris@486 755
Chris@486 756 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
Chris@486 757 # LaTeX documents. This may be useful for small projects and may help to
Chris@486 758 # save some trees in general.
Chris@486 759
Chris@486 760 COMPACT_LATEX = NO
Chris@486 761
Chris@486 762 # The PAPER_TYPE tag can be used to set the paper type that is used
Chris@486 763 # by the printer. Possible values are: a4, a4wide, letter, legal and
Chris@486 764 # executive. If left blank a4wide will be used.
Chris@486 765
Chris@486 766 PAPER_TYPE = a4wide
Chris@486 767
Chris@486 768 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
Chris@486 769 # packages that should be included in the LaTeX output.
Chris@486 770
Chris@486 771 EXTRA_PACKAGES =
Chris@486 772
Chris@486 773 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
Chris@486 774 # the generated latex document. The header should contain everything until
Chris@486 775 # the first chapter. If it is left blank doxygen will generate a
Chris@486 776 # standard header. Notice: only use this tag if you know what you are doing!
Chris@486 777
Chris@486 778 LATEX_HEADER =
Chris@486 779
Chris@486 780 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
Chris@486 781 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
Chris@486 782 # contain links (just like the HTML output) instead of page references
Chris@486 783 # This makes the output suitable for online browsing using a pdf viewer.
Chris@486 784
Chris@486 785 PDF_HYPERLINKS = NO
Chris@486 786
Chris@486 787 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
Chris@486 788 # plain latex in the generated Makefile. Set this option to YES to get a
Chris@486 789 # higher quality PDF documentation.
Chris@486 790
Chris@486 791 USE_PDFLATEX = NO
Chris@486 792
Chris@486 793 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
Chris@486 794 # command to the generated LaTeX files. This will instruct LaTeX to keep
Chris@486 795 # running if errors occur, instead of asking the user for help.
Chris@486 796 # This option is also used when generating formulas in HTML.
Chris@486 797
Chris@486 798 LATEX_BATCHMODE = NO
Chris@486 799
Chris@486 800 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
Chris@486 801 # include the index chapters (such as File Index, Compound Index, etc.)
Chris@486 802 # in the output.
Chris@486 803
Chris@486 804 LATEX_HIDE_INDICES = NO
Chris@486 805
Chris@486 806 #---------------------------------------------------------------------------
Chris@486 807 # configuration options related to the RTF output
Chris@486 808 #---------------------------------------------------------------------------
Chris@486 809
Chris@486 810 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
Chris@486 811 # The RTF output is optimized for Word 97 and may not look very pretty with
Chris@486 812 # other RTF readers or editors.
Chris@486 813
Chris@486 814 GENERATE_RTF = NO
Chris@486 815
Chris@486 816 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
Chris@486 817 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
Chris@486 818 # put in front of it. If left blank `rtf' will be used as the default path.
Chris@486 819
Chris@486 820 RTF_OUTPUT = rtf
Chris@486 821
Chris@486 822 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
Chris@486 823 # RTF documents. This may be useful for small projects and may help to
Chris@486 824 # save some trees in general.
Chris@486 825
Chris@486 826 COMPACT_RTF = NO
Chris@486 827
Chris@486 828 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
Chris@486 829 # will contain hyperlink fields. The RTF file will
Chris@486 830 # contain links (just like the HTML output) instead of page references.
Chris@486 831 # This makes the output suitable for online browsing using WORD or other
Chris@486 832 # programs which support those fields.
Chris@486 833 # Note: wordpad (write) and others do not support links.
Chris@486 834
Chris@486 835 RTF_HYPERLINKS = NO
Chris@486 836
Chris@486 837 # Load stylesheet definitions from file. Syntax is similar to doxygen's
Chris@486 838 # config file, i.e. a series of assignments. You only have to provide
Chris@486 839 # replacements, missing definitions are set to their default value.
Chris@486 840
Chris@486 841 RTF_STYLESHEET_FILE =
Chris@486 842
Chris@486 843 # Set optional variables used in the generation of an rtf document.
Chris@486 844 # Syntax is similar to doxygen's config file.
Chris@486 845
Chris@486 846 RTF_EXTENSIONS_FILE =
Chris@486 847
Chris@486 848 #---------------------------------------------------------------------------
Chris@486 849 # configuration options related to the man page output
Chris@486 850 #---------------------------------------------------------------------------
Chris@486 851
Chris@486 852 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
Chris@486 853 # generate man pages
Chris@486 854
Chris@486 855 GENERATE_MAN = NO
Chris@486 856
Chris@486 857 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
Chris@486 858 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
Chris@486 859 # put in front of it. If left blank `man' will be used as the default path.
Chris@486 860
Chris@486 861 MAN_OUTPUT = man
Chris@486 862
Chris@486 863 # The MAN_EXTENSION tag determines the extension that is added to
Chris@486 864 # the generated man pages (default is the subroutine's section .3)
Chris@486 865
Chris@486 866 MAN_EXTENSION = .3
Chris@486 867
Chris@486 868 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
Chris@486 869 # then it will generate one additional man file for each entity
Chris@486 870 # documented in the real man page(s). These additional files
Chris@486 871 # only source the real man page, but without them the man command
Chris@486 872 # would be unable to find the correct page. The default is NO.
Chris@486 873
Chris@486 874 MAN_LINKS = NO
Chris@486 875
Chris@486 876 #---------------------------------------------------------------------------
Chris@486 877 # configuration options related to the XML output
Chris@486 878 #---------------------------------------------------------------------------
Chris@486 879
Chris@486 880 # If the GENERATE_XML tag is set to YES Doxygen will
Chris@486 881 # generate an XML file that captures the structure of
Chris@486 882 # the code including all documentation.
Chris@486 883
Chris@486 884 GENERATE_XML = NO
Chris@486 885
Chris@486 886 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
Chris@486 887 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
Chris@486 888 # put in front of it. If left blank `xml' will be used as the default path.
Chris@486 889
Chris@486 890 XML_OUTPUT = xml
Chris@486 891
Chris@486 892 # The XML_SCHEMA tag can be used to specify an XML schema,
Chris@486 893 # which can be used by a validating XML parser to check the
Chris@486 894 # syntax of the XML files.
Chris@486 895
Chris@486 896 XML_SCHEMA =
Chris@486 897
Chris@486 898 # The XML_DTD tag can be used to specify an XML DTD,
Chris@486 899 # which can be used by a validating XML parser to check the
Chris@486 900 # syntax of the XML files.
Chris@486 901
Chris@486 902 XML_DTD =
Chris@486 903
Chris@486 904 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
Chris@486 905 # dump the program listings (including syntax highlighting
Chris@486 906 # and cross-referencing information) to the XML output. Note that
Chris@486 907 # enabling this will significantly increase the size of the XML output.
Chris@486 908
Chris@486 909 XML_PROGRAMLISTING = YES
Chris@486 910
Chris@486 911 #---------------------------------------------------------------------------
Chris@486 912 # configuration options for the AutoGen Definitions output
Chris@486 913 #---------------------------------------------------------------------------
Chris@486 914
Chris@486 915 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
Chris@486 916 # generate an AutoGen Definitions (see autogen.sf.net) file
Chris@486 917 # that captures the structure of the code including all
Chris@486 918 # documentation. Note that this feature is still experimental
Chris@486 919 # and incomplete at the moment.
Chris@486 920
Chris@486 921 GENERATE_AUTOGEN_DEF = NO
Chris@486 922
Chris@486 923 #---------------------------------------------------------------------------
Chris@486 924 # configuration options related to the Perl module output
Chris@486 925 #---------------------------------------------------------------------------
Chris@486 926
Chris@486 927 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
Chris@486 928 # generate a Perl module file that captures the structure of
Chris@486 929 # the code including all documentation. Note that this
Chris@486 930 # feature is still experimental and incomplete at the
Chris@486 931 # moment.
Chris@486 932
Chris@486 933 GENERATE_PERLMOD = NO
Chris@486 934
Chris@486 935 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
Chris@486 936 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
Chris@486 937 # to generate PDF and DVI output from the Perl module output.
Chris@486 938
Chris@486 939 PERLMOD_LATEX = NO
Chris@486 940
Chris@486 941 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
Chris@486 942 # nicely formatted so it can be parsed by a human reader. This is useful
Chris@486 943 # if you want to understand what is going on. On the other hand, if this
Chris@486 944 # tag is set to NO the size of the Perl module output will be much smaller
Chris@486 945 # and Perl will parse it just the same.
Chris@486 946
Chris@486 947 PERLMOD_PRETTY = YES
Chris@486 948
Chris@486 949 # The names of the make variables in the generated doxyrules.make file
Chris@486 950 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
Chris@486 951 # This is useful so different doxyrules.make files included by the same
Chris@486 952 # Makefile don't overwrite each other's variables.
Chris@486 953
Chris@486 954 PERLMOD_MAKEVAR_PREFIX =
Chris@486 955
Chris@486 956 #---------------------------------------------------------------------------
Chris@486 957 # Configuration options related to the preprocessor
Chris@486 958 #---------------------------------------------------------------------------
Chris@486 959
Chris@486 960 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
Chris@486 961 # evaluate all C-preprocessor directives found in the sources and include
Chris@486 962 # files.
Chris@486 963
Chris@486 964 ENABLE_PREPROCESSING = YES
Chris@486 965
Chris@486 966 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
Chris@486 967 # names in the source code. If set to NO (the default) only conditional
Chris@486 968 # compilation will be performed. Macro expansion can be done in a controlled
Chris@486 969 # way by setting EXPAND_ONLY_PREDEF to YES.
Chris@486 970
Chris@486 971 MACRO_EXPANSION = NO
Chris@486 972
Chris@486 973 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
Chris@486 974 # then the macro expansion is limited to the macros specified with the
Chris@486 975 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
Chris@486 976
Chris@486 977 EXPAND_ONLY_PREDEF = NO
Chris@486 978
Chris@486 979 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
Chris@486 980 # in the INCLUDE_PATH (see below) will be search if a #include is found.
Chris@486 981
Chris@486 982 SEARCH_INCLUDES = YES
Chris@486 983
Chris@486 984 # The INCLUDE_PATH tag can be used to specify one or more directories that
Chris@486 985 # contain include files that are not input files but should be processed by
Chris@486 986 # the preprocessor.
Chris@486 987
Chris@487 988 INCLUDE_PATH =
Chris@486 989
Chris@486 990 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
Chris@486 991 # patterns (like *.h and *.hpp) to filter out the header-files in the
Chris@486 992 # directories. If left blank, the patterns specified with FILE_PATTERNS will
Chris@486 993 # be used.
Chris@486 994
Chris@486 995 INCLUDE_FILE_PATTERNS = Q* *.h
Chris@486 996
Chris@486 997 # The PREDEFINED tag can be used to specify one or more macro names that
Chris@486 998 # are defined before the preprocessor is started (similar to the -D option of
Chris@486 999 # gcc). The argument of the tag is a list of macros of the form: name
Chris@486 1000 # or name=definition (no spaces). If the definition and the = are
Chris@486 1001 # omitted =1 is assumed. To prevent a macro definition from being
Chris@486 1002 # undefined via #undef or recursively expanded use the := operator
Chris@486 1003 # instead of the = operator.
Chris@486 1004
Chris@486 1005 PREDEFINED = HAVE_FFTW3F HAVE_FISHSOUND HAVE_JACK HAVE_LIBLO HAVE_LRDF HAVE_MAD HAVE_OGGZ HAVE_PORTAUDIO HAVE_SAMPLERATE HAVE_SNDFILE HAVE_VAMP
Chris@486 1006
Chris@486 1007 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
Chris@486 1008 # this tag can be used to specify a list of macro names that should be expanded.
Chris@486 1009 # The macro definition that is found in the sources will be used.
Chris@486 1010 # Use the PREDEFINED tag if you want to use a different macro definition.
Chris@486 1011
Chris@486 1012 EXPAND_AS_DEFINED =
Chris@486 1013
Chris@486 1014 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
Chris@486 1015 # doxygen's preprocessor will remove all function-like macros that are alone
Chris@486 1016 # on a line, have an all uppercase name, and do not end with a semicolon. Such
Chris@486 1017 # function macros are typically used for boiler-plate code, and will confuse
Chris@486 1018 # the parser if not removed.
Chris@486 1019
Chris@486 1020 SKIP_FUNCTION_MACROS = YES
Chris@486 1021
Chris@486 1022 #---------------------------------------------------------------------------
Chris@486 1023 # Configuration::additions related to external references
Chris@486 1024 #---------------------------------------------------------------------------
Chris@486 1025
Chris@486 1026 # The TAGFILES option can be used to specify one or more tagfiles.
Chris@486 1027 # Optionally an initial location of the external documentation
Chris@486 1028 # can be added for each tagfile. The format of a tag file without
Chris@486 1029 # this location is as follows:
Chris@486 1030 # TAGFILES = file1 file2 ...
Chris@486 1031 # Adding location for the tag files is done as follows:
Chris@486 1032 # TAGFILES = file1=loc1 "file2 = loc2" ...
Chris@486 1033 # where "loc1" and "loc2" can be relative or absolute paths or
Chris@486 1034 # URLs. If a location is present for each tag, the installdox tool
Chris@486 1035 # does not have to be run to correct the links.
Chris@486 1036 # Note that each tag file must have a unique name
Chris@486 1037 # (where the name does NOT include the path)
Chris@486 1038 # If a tag file is not located in the directory in which doxygen
Chris@486 1039 # is run, you must also specify the path to the tagfile here.
Chris@486 1040
Chris@486 1041 TAGFILES =
Chris@486 1042
Chris@486 1043 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
Chris@486 1044 # a tag file that is based on the input files it reads.
Chris@486 1045
Chris@486 1046 GENERATE_TAGFILE =
Chris@486 1047
Chris@486 1048 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
Chris@486 1049 # in the class index. If set to NO only the inherited external classes
Chris@486 1050 # will be listed.
Chris@486 1051
Chris@486 1052 ALLEXTERNALS = NO
Chris@486 1053
Chris@486 1054 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
Chris@486 1055 # in the modules index. If set to NO, only the current project's groups will
Chris@486 1056 # be listed.
Chris@486 1057
Chris@486 1058 EXTERNAL_GROUPS = YES
Chris@486 1059
Chris@486 1060 # The PERL_PATH should be the absolute path and name of the perl script
Chris@486 1061 # interpreter (i.e. the result of `which perl').
Chris@486 1062
Chris@486 1063 PERL_PATH = /usr/bin/perl
Chris@486 1064
Chris@486 1065 #---------------------------------------------------------------------------
Chris@486 1066 # Configuration options related to the dot tool
Chris@486 1067 #---------------------------------------------------------------------------
Chris@486 1068
Chris@486 1069 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
Chris@486 1070 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
Chris@486 1071 # or super classes. Setting the tag to NO turns the diagrams off. Note that
Chris@486 1072 # this option is superseded by the HAVE_DOT option below. This is only a
Chris@486 1073 # fallback. It is recommended to install and use dot, since it yields more
Chris@486 1074 # powerful graphs.
Chris@486 1075
Chris@486 1076 CLASS_DIAGRAMS = NO
Chris@486 1077
Chris@486 1078 # If set to YES, the inheritance and collaboration graphs will hide
Chris@486 1079 # inheritance and usage relations if the target is undocumented
Chris@486 1080 # or is not a class.
Chris@486 1081
Chris@486 1082 HIDE_UNDOC_RELATIONS = YES
Chris@486 1083
Chris@486 1084 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
Chris@486 1085 # available from the path. This tool is part of Graphviz, a graph visualization
Chris@486 1086 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
Chris@486 1087 # have no effect if this option is set to NO (the default)
Chris@486 1088
Chris@486 1089 HAVE_DOT = YES
Chris@486 1090
Chris@486 1091 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
Chris@486 1092 # will generate a graph for each documented class showing the direct and
Chris@486 1093 # indirect inheritance relations. Setting this tag to YES will force the
Chris@486 1094 # the CLASS_DIAGRAMS tag to NO.
Chris@486 1095
Chris@486 1096 CLASS_GRAPH = YES
Chris@486 1097
Chris@486 1098 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
Chris@486 1099 # will generate a graph for each documented class showing the direct and
Chris@486 1100 # indirect implementation dependencies (inheritance, containment, and
Chris@486 1101 # class references variables) of the class with other documented classes.
Chris@486 1102
Chris@486 1103 COLLABORATION_GRAPH = YES
Chris@486 1104
Chris@486 1105 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
Chris@486 1106 # will generate a graph for groups, showing the direct groups dependencies
Chris@486 1107
Chris@486 1108 GROUP_GRAPHS = YES
Chris@486 1109
Chris@486 1110 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
Chris@486 1111 # collaboration diagrams in a style similar to the OMG's Unified Modeling
Chris@486 1112 # Language.
Chris@486 1113
Chris@486 1114 UML_LOOK = NO
Chris@486 1115
Chris@486 1116 # If set to YES, the inheritance and collaboration graphs will show the
Chris@486 1117 # relations between templates and their instances.
Chris@486 1118
Chris@486 1119 TEMPLATE_RELATIONS = NO
Chris@486 1120
Chris@486 1121 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
Chris@486 1122 # tags are set to YES then doxygen will generate a graph for each documented
Chris@486 1123 # file showing the direct and indirect include dependencies of the file with
Chris@486 1124 # other documented files.
Chris@486 1125
Chris@486 1126 INCLUDE_GRAPH = YES
Chris@486 1127
Chris@486 1128 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
Chris@486 1129 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
Chris@486 1130 # documented header file showing the documented files that directly or
Chris@486 1131 # indirectly include this file.
Chris@486 1132
Chris@486 1133 INCLUDED_BY_GRAPH = YES
Chris@486 1134
Chris@486 1135 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
Chris@486 1136 # generate a call dependency graph for every global function or class method.
Chris@486 1137 # Note that enabling this option will significantly increase the time of a run.
Chris@486 1138 # So in most cases it will be better to enable call graphs for selected
Chris@486 1139 # functions only using the \callgraph command.
Chris@486 1140
Chris@486 1141 CALL_GRAPH = NO
Chris@486 1142
Chris@486 1143 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
Chris@486 1144 # will graphical hierarchy of all classes instead of a textual one.
Chris@486 1145
Chris@486 1146 GRAPHICAL_HIERARCHY = YES
Chris@486 1147
Chris@486 1148 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
Chris@486 1149 # then doxygen will show the dependencies a directory has on other directories
Chris@486 1150 # in a graphical way. The dependency relations are determined by the #include
Chris@486 1151 # relations between the files in the directories.
Chris@486 1152
Chris@486 1153 DIRECTORY_GRAPH = YES
Chris@486 1154
Chris@486 1155 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
Chris@486 1156 # generated by dot. Possible values are png, jpg, or gif
Chris@486 1157 # If left blank png will be used.
Chris@486 1158
Chris@486 1159 DOT_IMAGE_FORMAT = png
Chris@486 1160
Chris@486 1161 # The tag DOT_PATH can be used to specify the path where the dot tool can be
Chris@486 1162 # found. If left blank, it is assumed the dot tool can be found in the path.
Chris@486 1163
Chris@486 1164 DOT_PATH =
Chris@486 1165
Chris@486 1166 # The DOTFILE_DIRS tag can be used to specify one or more directories that
Chris@486 1167 # contain dot files that are included in the documentation (see the
Chris@486 1168 # \dotfile command).
Chris@486 1169
Chris@486 1170 DOTFILE_DIRS =
Chris@486 1171
Chris@486 1172 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
Chris@486 1173 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
Chris@486 1174 # this value, doxygen will try to truncate the graph, so that it fits within
Chris@486 1175 # the specified constraint. Beware that most browsers cannot cope with very
Chris@486 1176 # large images.
Chris@486 1177
Chris@486 1178 MAX_DOT_GRAPH_WIDTH = 1024
Chris@486 1179
Chris@486 1180 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
Chris@486 1181 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
Chris@486 1182 # this value, doxygen will try to truncate the graph, so that it fits within
Chris@486 1183 # the specified constraint. Beware that most browsers cannot cope with very
Chris@486 1184 # large images.
Chris@486 1185
Chris@486 1186 MAX_DOT_GRAPH_HEIGHT = 1024
Chris@486 1187
Chris@486 1188 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
Chris@486 1189 # graphs generated by dot. A depth value of 3 means that only nodes reachable
Chris@486 1190 # from the root by following a path via at most 3 edges will be shown. Nodes
Chris@486 1191 # that lay further from the root node will be omitted. Note that setting this
Chris@486 1192 # option to 1 or 2 may greatly reduce the computation time needed for large
Chris@486 1193 # code bases. Also note that a graph may be further truncated if the graph's
Chris@486 1194 # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
Chris@486 1195 # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
Chris@486 1196 # the graph is not depth-constrained.
Chris@486 1197
Chris@486 1198 MAX_DOT_GRAPH_DEPTH = 0
Chris@486 1199
Chris@486 1200 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
Chris@486 1201 # background. This is disabled by default, which results in a white background.
Chris@486 1202 # Warning: Depending on the platform used, enabling this option may lead to
Chris@486 1203 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
Chris@486 1204 # read).
Chris@486 1205
Chris@486 1206 DOT_TRANSPARENT = NO
Chris@486 1207
Chris@486 1208 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
Chris@486 1209 # files in one run (i.e. multiple -o and -T options on the command line). This
Chris@486 1210 # makes dot run faster, but since only newer versions of dot (>1.8.10)
Chris@486 1211 # support this, this feature is disabled by default.
Chris@486 1212
Chris@486 1213 DOT_MULTI_TARGETS = YES
Chris@486 1214
Chris@486 1215 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
Chris@486 1216 # generate a legend page explaining the meaning of the various boxes and
Chris@486 1217 # arrows in the dot generated graphs.
Chris@486 1218
Chris@486 1219 GENERATE_LEGEND = YES
Chris@486 1220
Chris@486 1221 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
Chris@486 1222 # remove the intermediate dot files that are used to generate
Chris@486 1223 # the various graphs.
Chris@486 1224
Chris@486 1225 DOT_CLEANUP = YES
Chris@486 1226
Chris@486 1227 #---------------------------------------------------------------------------
Chris@486 1228 # Configuration::additions related to the search engine
Chris@486 1229 #---------------------------------------------------------------------------
Chris@486 1230
Chris@486 1231 # The SEARCHENGINE tag specifies whether or not a search engine should be
Chris@486 1232 # used. If set to NO the values of all tags below this one will be ignored.
Chris@486 1233
Chris@486 1234 SEARCHENGINE = NO