annotate Doxyfile @ 83:94a42248ec33

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