annotate src/vamp-plugin-sdk-2.5/build/Doxyfile @ 108:1813f30f2f15

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