annotate src/rubberband-1.8.1/Doxyfile @ 169:223a55898ab9 tip default

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