annotate Doxyfile @ 515:08bcc06c38ec tip master

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