annotate src/vamp-plugin-sdk-2.5/build/Doxyfile @ 23:619f715526df sv_v2.1

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