annotate build/Doxyfile @ 541:0e32c328b02a tip

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