annotate Doxyfile @ 1636:05e3ea2237f5 single-point

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