annotate Doxyfile @ 165:de1a008fa912

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