annotate src/rubberband-1.8.1/Doxyfile @ 83:ae30d91d2ffe

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