Doxyfile

Mon, 30 Dec 2019 09:52:44 +0100

author
Mike Becker <universe@uap-core.de>
date
Mon, 30 Dec 2019 09:52:44 +0100
changeset 388
871a8ffe6c9d
parent 266
33d229634809
child 462
1bcf7c8d4b47
permissions
-rw-r--r--

merges closed feature/array branch

universe@208 1 # Doxyfile 1.8.7
universe@208 2
universe@114 3 # This file describes the settings to be used by the documentation system
universe@114 4 # doxygen (www.doxygen.org) for a project.
universe@114 5 #
universe@208 6 # All text after a double hash (##) is considered a comment and is placed in
universe@208 7 # front of the TAG it is preceding.
universe@208 8 #
universe@208 9 # All text after a single hash (#) is considered a comment and will be ignored.
universe@114 10 # The format is:
universe@208 11 # TAG = value [value, ...]
universe@208 12 # For lists, items can also be appended using:
universe@208 13 # TAG += value [value, ...]
universe@208 14 # Values that contain spaces should be placed between quotes (\" \").
universe@114 15
universe@114 16 #---------------------------------------------------------------------------
universe@114 17 # Project related configuration options
universe@114 18 #---------------------------------------------------------------------------
universe@114 19
universe@114 20 # This tag specifies the encoding used for all characters in the config file
universe@208 21 # that follow. The default is UTF-8 which is also the encoding used for all text
universe@208 22 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
universe@208 23 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
universe@208 24 # for the list of possible encodings.
universe@208 25 # The default value is: UTF-8.
universe@114 26
universe@114 27 DOXYFILE_ENCODING = UTF-8
universe@114 28
universe@208 29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
universe@208 30 # double-quotes, unless you are using Doxywizard) that should identify the
universe@208 31 # project for which the documentation is generated. This name is used in the
universe@208 32 # title of most generated pages and in a few other places.
universe@208 33 # The default value is: My Project.
universe@114 34
universe@114 35 PROJECT_NAME = "ucx"
universe@114 36
universe@208 37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
universe@208 38 # could be handy for archiving the generated documentation or if some version
universe@208 39 # control system is used.
universe@114 40
universe@114 41 PROJECT_NUMBER =
universe@114 42
universe@114 43 # Using the PROJECT_BRIEF tag one can provide an optional one line description
universe@208 44 # for a project that appears at the top of each page and should give viewer a
universe@208 45 # quick idea about the purpose of the project. Keep the description short.
universe@114 46
universe@114 47 PROJECT_BRIEF = "UAP Common Extensions"
universe@114 48
universe@208 49 # With the PROJECT_LOGO tag one can specify an logo or icon that is included in
universe@208 50 # the documentation. The maximum height of the logo should not exceed 55 pixels
universe@208 51 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
universe@208 52 # to the output directory.
universe@114 53
universe@114 54 PROJECT_LOGO = ./uaplogo.png
universe@114 55
universe@208 56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
universe@208 57 # into which the generated documentation will be written. If a relative path is
universe@208 58 # entered, it will be relative to the location where doxygen was started. If
universe@208 59 # left blank the current directory will be used.
universe@114 60
universe@256 61 OUTPUT_DIRECTORY = docs
universe@114 62
universe@208 63 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
universe@208 64 # directories (in 2 levels) under the output directory of each output format and
universe@208 65 # will distribute the generated files over these directories. Enabling this
universe@208 66 # option can be useful when feeding doxygen a huge amount of source files, where
universe@208 67 # putting all generated files in the same directory would otherwise causes
universe@208 68 # performance problems for the file system.
universe@208 69 # The default value is: NO.
universe@114 70
universe@114 71 CREATE_SUBDIRS = NO
universe@114 72
universe@208 73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
universe@208 74 # characters to appear in the names of generated files. If set to NO, non-ASCII
universe@208 75 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
universe@208 76 # U+3044.
universe@208 77 # The default value is: NO.
universe@208 78
universe@208 79 ALLOW_UNICODE_NAMES = NO
universe@208 80
universe@114 81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
universe@114 82 # documentation generated by doxygen is written. Doxygen will use this
universe@114 83 # information to generate all constant output in the proper language.
universe@208 84 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
universe@208 85 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
universe@208 86 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
universe@208 87 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
universe@208 88 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
universe@208 89 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
universe@208 90 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
universe@208 91 # Ukrainian and Vietnamese.
universe@208 92 # The default value is: English.
universe@114 93
universe@114 94 OUTPUT_LANGUAGE = English
universe@114 95
universe@208 96 # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
universe@208 97 # descriptions after the members that are listed in the file and class
universe@208 98 # documentation (similar to Javadoc). Set to NO to disable this.
universe@208 99 # The default value is: YES.
universe@114 100
universe@114 101 BRIEF_MEMBER_DESC = YES
universe@114 102
universe@208 103 # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
universe@208 104 # description of a member or function before the detailed description
universe@208 105 #
universe@208 106 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
universe@114 107 # brief descriptions will be completely suppressed.
universe@208 108 # The default value is: YES.
universe@114 109
universe@114 110 REPEAT_BRIEF = YES
universe@114 111
universe@208 112 # This tag implements a quasi-intelligent brief description abbreviator that is
universe@208 113 # used to form the text in various listings. Each string in this list, if found
universe@208 114 # as the leading text of the brief description, will be stripped from the text
universe@208 115 # and the result, after processing the whole list, is used as the annotated
universe@208 116 # text. Otherwise, the brief description is used as-is. If left blank, the
universe@208 117 # following values are used ($name is automatically replaced with the name of
universe@208 118 # the entity):The $name class, The $name widget, The $name file, is, provides,
universe@208 119 # specifies, contains, represents, a, an and the.
universe@114 120
universe@114 121 ABBREVIATE_BRIEF =
universe@114 122
universe@114 123 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
universe@208 124 # doxygen will generate a detailed section even if there is only a brief
universe@114 125 # description.
universe@208 126 # The default value is: NO.
universe@114 127
universe@114 128 ALWAYS_DETAILED_SEC = NO
universe@114 129
universe@114 130 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
universe@114 131 # inherited members of a class in the documentation of that class as if those
universe@114 132 # members were ordinary class members. Constructors, destructors and assignment
universe@114 133 # operators of the base classes will not be shown.
universe@208 134 # The default value is: NO.
universe@114 135
universe@114 136 INLINE_INHERITED_MEMB = NO
universe@114 137
universe@208 138 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
universe@208 139 # before files name in the file list and in the header files. If set to NO the
universe@208 140 # shortest path that makes the file name unique will be used
universe@208 141 # The default value is: YES.
universe@114 142
universe@114 143 FULL_PATH_NAMES = YES
universe@114 144
universe@208 145 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
universe@208 146 # Stripping is only done if one of the specified strings matches the left-hand
universe@208 147 # part of the path. The tag can be used to show relative paths in the file list.
universe@208 148 # If left blank the directory from which doxygen is run is used as the path to
universe@208 149 # strip.
universe@208 150 #
universe@208 151 # Note that you can specify absolute paths here, but also relative paths, which
universe@208 152 # will be relative from the directory where doxygen is started.
universe@208 153 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
universe@114 154
universe@114 155 STRIP_FROM_PATH =
universe@114 156
universe@208 157 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
universe@208 158 # path mentioned in the documentation of a class, which tells the reader which
universe@208 159 # header file to include in order to use a class. If left blank only the name of
universe@208 160 # the header file containing the class definition is used. Otherwise one should
universe@208 161 # specify the list of include paths that are normally passed to the compiler
universe@208 162 # using the -I flag.
universe@114 163
universe@114 164 STRIP_FROM_INC_PATH =
universe@114 165
universe@208 166 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
universe@208 167 # less readable) file names. This can be useful is your file systems doesn't
universe@208 168 # support long names like on DOS, Mac, or CD-ROM.
universe@208 169 # The default value is: NO.
universe@114 170
universe@114 171 SHORT_NAMES = NO
universe@114 172
universe@208 173 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
universe@208 174 # first line (until the first dot) of a Javadoc-style comment as the brief
universe@208 175 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
universe@208 176 # style comments (thus requiring an explicit @brief command for a brief
universe@208 177 # description.)
universe@208 178 # The default value is: NO.
universe@114 179
universe@114 180 JAVADOC_AUTOBRIEF = YES
universe@114 181
universe@208 182 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
universe@208 183 # line (until the first dot) of a Qt-style comment as the brief description. If
universe@208 184 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
universe@208 185 # requiring an explicit \brief command for a brief description.)
universe@208 186 # The default value is: NO.
universe@114 187
universe@114 188 QT_AUTOBRIEF = NO
universe@114 189
universe@208 190 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
universe@208 191 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
universe@208 192 # a brief description. This used to be the default behavior. The new default is
universe@208 193 # to treat a multi-line C++ comment block as a detailed description. Set this
universe@208 194 # tag to YES if you prefer the old behavior instead.
universe@208 195 #
universe@208 196 # Note that setting this tag to YES also means that rational rose comments are
universe@208 197 # not recognized any more.
universe@208 198 # The default value is: NO.
universe@114 199
universe@114 200 MULTILINE_CPP_IS_BRIEF = NO
universe@114 201
universe@208 202 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
universe@208 203 # documentation from any documented member that it re-implements.
universe@208 204 # The default value is: YES.
universe@114 205
universe@114 206 INHERIT_DOCS = YES
universe@114 207
universe@208 208 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
universe@208 209 # new page for each member. If set to NO, the documentation of a member will be
universe@208 210 # part of the file/class/namespace that contains it.
universe@208 211 # The default value is: NO.
universe@114 212
universe@114 213 SEPARATE_MEMBER_PAGES = NO
universe@114 214
universe@208 215 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
universe@208 216 # uses this value to replace tabs by spaces in code fragments.
universe@208 217 # Minimum value: 1, maximum value: 16, default value: 4.
universe@114 218
universe@114 219 TAB_SIZE = 4
universe@114 220
universe@208 221 # This tag can be used to specify a number of aliases that act as commands in
universe@208 222 # the documentation. An alias has the form:
universe@208 223 # name=value
universe@208 224 # For example adding
universe@208 225 # "sideeffect=@par Side Effects:\n"
universe@208 226 # will allow you to put the command \sideeffect (or @sideeffect) in the
universe@208 227 # documentation, which will result in a user-defined paragraph with heading
universe@208 228 # "Side Effects:". You can put \n's in the value part of an alias to insert
universe@208 229 # newlines.
universe@114 230
universe@114 231 ALIASES =
universe@114 232
universe@114 233 # This tag can be used to specify a number of word-keyword mappings (TCL only).
universe@208 234 # A mapping has the form "name=value". For example adding "class=itcl::class"
universe@208 235 # will allow you to use the command class in the itcl::class meaning.
universe@114 236
universe@114 237 TCL_SUBST =
universe@114 238
universe@208 239 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
universe@208 240 # only. Doxygen will then generate output that is more tailored for C. For
universe@208 241 # instance, some of the names that are used will be different. The list of all
universe@208 242 # members will be omitted, etc.
universe@208 243 # The default value is: NO.
universe@114 244
universe@114 245 OPTIMIZE_OUTPUT_FOR_C = YES
universe@114 246
universe@208 247 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
universe@208 248 # Python sources only. Doxygen will then generate output that is more tailored
universe@208 249 # for that language. For instance, namespaces will be presented as packages,
universe@208 250 # qualified scopes will look different, etc.
universe@208 251 # The default value is: NO.
universe@114 252
universe@114 253 OPTIMIZE_OUTPUT_JAVA = NO
universe@114 254
universe@114 255 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
universe@208 256 # sources. Doxygen will then generate output that is tailored for Fortran.
universe@208 257 # The default value is: NO.
universe@114 258
universe@114 259 OPTIMIZE_FOR_FORTRAN = NO
universe@114 260
universe@114 261 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
universe@208 262 # sources. Doxygen will then generate output that is tailored for VHDL.
universe@208 263 # The default value is: NO.
universe@114 264
universe@114 265 OPTIMIZE_OUTPUT_VHDL = NO
universe@114 266
universe@114 267 # Doxygen selects the parser to use depending on the extension of the files it
universe@208 268 # parses. With this tag you can assign which parser to use for a given
universe@208 269 # extension. Doxygen has a built-in mapping, but you can override or extend it
universe@208 270 # using this tag. The format is ext=language, where ext is a file extension, and
universe@208 271 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
universe@208 272 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
universe@208 273 # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
universe@208 274 # Fortran. In the later case the parser tries to guess whether the code is fixed
universe@208 275 # or free formatted code, this is the default for Fortran type files), VHDL. For
universe@208 276 # instance to make doxygen treat .inc files as Fortran files (default is PHP),
universe@208 277 # and .f files as C (default is Fortran), use: inc=Fortran f=C.
universe@208 278 #
universe@208 279 # Note For files without extension you can use no_extension as a placeholder.
universe@208 280 #
universe@208 281 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
universe@208 282 # the files are not read by doxygen.
universe@114 283
universe@114 284 EXTENSION_MAPPING =
universe@114 285
universe@208 286 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
universe@208 287 # according to the Markdown format, which allows for more readable
universe@208 288 # documentation. See http://daringfireball.net/projects/markdown/ for details.
universe@208 289 # The output of markdown processing is further processed by doxygen, so you can
universe@208 290 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
universe@208 291 # case of backward compatibilities issues.
universe@208 292 # The default value is: YES.
universe@208 293
universe@208 294 MARKDOWN_SUPPORT = YES
universe@208 295
universe@208 296 # When enabled doxygen tries to link words that correspond to documented
universe@208 297 # classes, or namespaces to their corresponding documentation. Such a link can
universe@208 298 # be prevented in individual cases by by putting a % sign in front of the word
universe@208 299 # or globally by setting AUTOLINK_SUPPORT to NO.
universe@208 300 # The default value is: YES.
universe@208 301
universe@208 302 AUTOLINK_SUPPORT = YES
universe@208 303
universe@114 304 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
universe@208 305 # to include (a tag file for) the STL sources as input, then you should set this
universe@208 306 # tag to YES in order to let doxygen match functions declarations and
universe@208 307 # definitions whose arguments contain STL classes (e.g. func(std::string);
universe@208 308 # versus func(std::string) {}). This also make the inheritance and collaboration
universe@114 309 # diagrams that involve STL classes more complete and accurate.
universe@208 310 # The default value is: NO.
universe@114 311
universe@114 312 BUILTIN_STL_SUPPORT = NO
universe@114 313
universe@114 314 # If you use Microsoft's C++/CLI language, you should set this option to YES to
universe@114 315 # enable parsing support.
universe@208 316 # The default value is: NO.
universe@114 317
universe@114 318 CPP_CLI_SUPPORT = NO
universe@114 319
universe@208 320 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
universe@208 321 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
universe@208 322 # will parse them like normal C++ but will assume all classes use public instead
universe@208 323 # of private inheritance when no explicit protection keyword is present.
universe@208 324 # The default value is: NO.
universe@114 325
universe@114 326 SIP_SUPPORT = NO
universe@114 327
universe@208 328 # For Microsoft's IDL there are propget and propput attributes to indicate
universe@208 329 # getter and setter methods for a property. Setting this option to YES will make
universe@208 330 # doxygen to replace the get and set methods by a property in the documentation.
universe@208 331 # This will only work if the methods are indeed getting or setting a simple
universe@208 332 # type. If this is not the case, or you want to show the methods anyway, you
universe@208 333 # should set this option to NO.
universe@208 334 # The default value is: YES.
universe@114 335
universe@114 336 IDL_PROPERTY_SUPPORT = YES
universe@114 337
universe@114 338 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
universe@114 339 # tag is set to YES, then doxygen will reuse the documentation of the first
universe@114 340 # member in the group (if any) for the other members of the group. By default
universe@114 341 # all members of a group must be documented explicitly.
universe@208 342 # The default value is: NO.
universe@114 343
universe@114 344 DISTRIBUTE_GROUP_DOC = NO
universe@114 345
universe@208 346 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
universe@208 347 # (for instance a group of public functions) to be put as a subgroup of that
universe@208 348 # type (e.g. under the Public Functions section). Set it to NO to prevent
universe@208 349 # subgrouping. Alternatively, this can be done per class using the
universe@208 350 # \nosubgrouping command.
universe@208 351 # The default value is: YES.
universe@114 352
universe@114 353 SUBGROUPING = YES
universe@114 354
universe@208 355 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
universe@208 356 # are shown inside the group in which they are included (e.g. using \ingroup)
universe@208 357 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
universe@208 358 # and RTF).
universe@208 359 #
universe@208 360 # Note that this feature does not work in combination with
universe@208 361 # SEPARATE_MEMBER_PAGES.
universe@208 362 # The default value is: NO.
universe@114 363
universe@114 364 INLINE_GROUPED_CLASSES = NO
universe@114 365
universe@208 366 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
universe@208 367 # with only public data fields or simple typedef fields will be shown inline in
universe@208 368 # the documentation of the scope in which they are defined (i.e. file,
universe@208 369 # namespace, or group documentation), provided this scope is documented. If set
universe@208 370 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
universe@208 371 # Man pages) or section (for LaTeX and RTF).
universe@208 372 # The default value is: NO.
universe@114 373
universe@114 374 INLINE_SIMPLE_STRUCTS = NO
universe@114 375
universe@208 376 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
universe@208 377 # enum is documented as struct, union, or enum with the name of the typedef. So
universe@114 378 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
universe@114 379 # with name TypeT. When disabled the typedef will appear as a member of a file,
universe@208 380 # namespace, or class. And the struct will be named TypeS. This can typically be
universe@208 381 # useful for C code in case the coding convention dictates that all compound
universe@114 382 # types are typedef'ed and only the typedef is referenced, never the tag name.
universe@208 383 # The default value is: NO.
universe@114 384
universe@114 385 TYPEDEF_HIDES_STRUCT = NO
universe@114 386
universe@208 387 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
universe@208 388 # cache is used to resolve symbols given their name and scope. Since this can be
universe@208 389 # an expensive process and often the same symbol appears multiple times in the
universe@208 390 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
universe@208 391 # doxygen will become slower. If the cache is too large, memory is wasted. The
universe@208 392 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
universe@208 393 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
universe@208 394 # symbols. At the end of a run doxygen will report the cache usage and suggest
universe@208 395 # the optimal cache size from a speed point of view.
universe@208 396 # Minimum value: 0, maximum value: 9, default value: 0.
universe@114 397
universe@114 398 LOOKUP_CACHE_SIZE = 0
universe@114 399
universe@114 400 #---------------------------------------------------------------------------
universe@114 401 # Build related configuration options
universe@114 402 #---------------------------------------------------------------------------
universe@114 403
universe@114 404 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
universe@208 405 # documentation are documented, even if no documentation was available. Private
universe@208 406 # class members and static file members will be hidden unless the
universe@208 407 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
universe@208 408 # Note: This will also disable the warnings about undocumented members that are
universe@208 409 # normally produced when WARNINGS is set to YES.
universe@208 410 # The default value is: NO.
universe@114 411
universe@114 412 EXTRACT_ALL = NO
universe@114 413
universe@208 414 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
universe@208 415 # be included in the documentation.
universe@208 416 # The default value is: NO.
universe@114 417
universe@114 418 EXTRACT_PRIVATE = NO
universe@114 419
universe@208 420 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
universe@208 421 # scope will be included in the documentation.
universe@208 422 # The default value is: NO.
universe@208 423
universe@208 424 EXTRACT_PACKAGE = NO
universe@208 425
universe@208 426 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
universe@208 427 # included in the documentation.
universe@208 428 # The default value is: NO.
universe@114 429
universe@114 430 EXTRACT_STATIC = NO
universe@114 431
universe@208 432 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
universe@208 433 # locally in source files will be included in the documentation. If set to NO
universe@208 434 # only classes defined in header files are included. Does not have any effect
universe@208 435 # for Java sources.
universe@208 436 # The default value is: YES.
universe@114 437
universe@114 438 EXTRACT_LOCAL_CLASSES = YES
universe@114 439
universe@208 440 # This flag is only useful for Objective-C code. When set to YES local methods,
universe@208 441 # which are defined in the implementation section but not in the interface are
universe@208 442 # included in the documentation. If set to NO only methods in the interface are
universe@208 443 # included.
universe@208 444 # The default value is: NO.
universe@114 445
universe@114 446 EXTRACT_LOCAL_METHODS = NO
universe@114 447
universe@114 448 # If this flag is set to YES, the members of anonymous namespaces will be
universe@114 449 # extracted and appear in the documentation as a namespace called
universe@208 450 # 'anonymous_namespace{file}', where file will be replaced with the base name of
universe@208 451 # the file that contains the anonymous namespace. By default anonymous namespace
universe@208 452 # are hidden.
universe@208 453 # The default value is: NO.
universe@114 454
universe@114 455 EXTRACT_ANON_NSPACES = NO
universe@114 456
universe@208 457 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
universe@208 458 # undocumented members inside documented classes or files. If set to NO these
universe@208 459 # members will be included in the various overviews, but no documentation
universe@208 460 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
universe@208 461 # The default value is: NO.
universe@114 462
universe@114 463 HIDE_UNDOC_MEMBERS = NO
universe@114 464
universe@208 465 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
universe@208 466 # undocumented classes that are normally visible in the class hierarchy. If set
universe@208 467 # to NO these classes will be included in the various overviews. This option has
universe@208 468 # no effect if EXTRACT_ALL is enabled.
universe@208 469 # The default value is: NO.
universe@114 470
universe@114 471 HIDE_UNDOC_CLASSES = NO
universe@114 472
universe@208 473 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
universe@208 474 # (class|struct|union) declarations. If set to NO these declarations will be
universe@208 475 # included in the documentation.
universe@208 476 # The default value is: NO.
universe@114 477
universe@114 478 HIDE_FRIEND_COMPOUNDS = NO
universe@114 479
universe@208 480 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
universe@208 481 # documentation blocks found inside the body of a function. If set to NO these
universe@208 482 # blocks will be appended to the function's detailed documentation block.
universe@208 483 # The default value is: NO.
universe@114 484
universe@114 485 HIDE_IN_BODY_DOCS = NO
universe@114 486
universe@208 487 # The INTERNAL_DOCS tag determines if documentation that is typed after a
universe@208 488 # \internal command is included. If the tag is set to NO then the documentation
universe@208 489 # will be excluded. Set it to YES to include the internal documentation.
universe@208 490 # The default value is: NO.
universe@114 491
universe@114 492 INTERNAL_DOCS = NO
universe@114 493
universe@208 494 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
universe@208 495 # names in lower-case letters. If set to YES upper-case letters are also
universe@114 496 # allowed. This is useful if you have classes or files whose names only differ
universe@114 497 # in case and if your file system supports case sensitive file names. Windows
universe@114 498 # and Mac users are advised to set this option to NO.
universe@208 499 # The default value is: system dependent.
universe@114 500
universe@114 501 CASE_SENSE_NAMES = YES
universe@114 502
universe@208 503 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
universe@208 504 # their full class and namespace scopes in the documentation. If set to YES the
universe@208 505 # scope will be hidden.
universe@208 506 # The default value is: NO.
universe@114 507
universe@114 508 HIDE_SCOPE_NAMES = NO
universe@114 509
universe@208 510 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
universe@208 511 # the files that are included by a file in the documentation of that file.
universe@208 512 # The default value is: YES.
universe@114 513
universe@114 514 SHOW_INCLUDE_FILES = YES
universe@114 515
universe@208 516 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
universe@208 517 # grouped member an include statement to the documentation, telling the reader
universe@208 518 # which file to include in order to use the member.
universe@208 519 # The default value is: NO.
universe@208 520
universe@208 521 SHOW_GROUPED_MEMB_INC = NO
universe@208 522
universe@208 523 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
universe@208 524 # files with double quotes in the documentation rather than with sharp brackets.
universe@208 525 # The default value is: NO.
universe@114 526
universe@114 527 FORCE_LOCAL_INCLUDES = NO
universe@114 528
universe@208 529 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
universe@208 530 # documentation for inline members.
universe@208 531 # The default value is: YES.
universe@114 532
universe@114 533 INLINE_INFO = YES
universe@114 534
universe@208 535 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
universe@208 536 # (detailed) documentation of file and class members alphabetically by member
universe@208 537 # name. If set to NO the members will appear in declaration order.
universe@208 538 # The default value is: YES.
universe@114 539
universe@114 540 SORT_MEMBER_DOCS = YES
universe@114 541
universe@208 542 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
universe@208 543 # descriptions of file, namespace and class members alphabetically by member
universe@208 544 # name. If set to NO the members will appear in declaration order. Note that
universe@208 545 # this will also influence the order of the classes in the class list.
universe@208 546 # The default value is: NO.
universe@114 547
universe@114 548 SORT_BRIEF_DOCS = NO
universe@114 549
universe@208 550 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
universe@208 551 # (brief and detailed) documentation of class members so that constructors and
universe@208 552 # destructors are listed first. If set to NO the constructors will appear in the
universe@208 553 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
universe@208 554 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
universe@208 555 # member documentation.
universe@208 556 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
universe@208 557 # detailed member documentation.
universe@208 558 # The default value is: NO.
universe@114 559
universe@114 560 SORT_MEMBERS_CTORS_1ST = NO
universe@114 561
universe@208 562 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
universe@208 563 # of group names into alphabetical order. If set to NO the group names will
universe@208 564 # appear in their defined order.
universe@208 565 # The default value is: NO.
universe@114 566
universe@114 567 SORT_GROUP_NAMES = NO
universe@114 568
universe@208 569 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
universe@208 570 # fully-qualified names, including namespaces. If set to NO, the class list will
universe@208 571 # be sorted only by class name, not including the namespace part.
universe@114 572 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
universe@208 573 # Note: This option applies only to the class list, not to the alphabetical
universe@208 574 # list.
universe@208 575 # The default value is: NO.
universe@114 576
universe@114 577 SORT_BY_SCOPE_NAME = NO
universe@114 578
universe@208 579 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
universe@208 580 # type resolution of all parameters of a function it will reject a match between
universe@208 581 # the prototype and the implementation of a member function even if there is
universe@208 582 # only one candidate or it is obvious which candidate to choose by doing a
universe@208 583 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
universe@208 584 # accept a match between prototype and implementation in such cases.
universe@208 585 # The default value is: NO.
universe@114 586
universe@114 587 STRICT_PROTO_MATCHING = NO
universe@114 588
universe@208 589 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
universe@208 590 # todo list. This list is created by putting \todo commands in the
universe@208 591 # documentation.
universe@208 592 # The default value is: YES.
universe@114 593
universe@114 594 GENERATE_TODOLIST = YES
universe@114 595
universe@208 596 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
universe@208 597 # test list. This list is created by putting \test commands in the
universe@208 598 # documentation.
universe@208 599 # The default value is: YES.
universe@114 600
universe@114 601 GENERATE_TESTLIST = YES
universe@114 602
universe@208 603 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
universe@208 604 # list. This list is created by putting \bug commands in the documentation.
universe@208 605 # The default value is: YES.
universe@114 606
universe@114 607 GENERATE_BUGLIST = YES
universe@114 608
universe@208 609 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
universe@208 610 # the deprecated list. This list is created by putting \deprecated commands in
universe@208 611 # the documentation.
universe@208 612 # The default value is: YES.
universe@114 613
universe@114 614 GENERATE_DEPRECATEDLIST= YES
universe@114 615
universe@208 616 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
universe@208 617 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
universe@208 618 # ... \endcond blocks.
universe@114 619
universe@114 620 ENABLED_SECTIONS =
universe@114 621
universe@208 622 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
universe@208 623 # initial value of a variable or macro / define can have for it to appear in the
universe@208 624 # documentation. If the initializer consists of more lines than specified here
universe@208 625 # it will be hidden. Use a value of 0 to hide initializers completely. The
universe@208 626 # appearance of the value of individual variables and macros / defines can be
universe@208 627 # controlled using \showinitializer or \hideinitializer command in the
universe@208 628 # documentation regardless of this setting.
universe@208 629 # Minimum value: 0, maximum value: 10000, default value: 30.
universe@114 630
universe@114 631 MAX_INITIALIZER_LINES = 30
universe@114 632
universe@208 633 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
universe@208 634 # the bottom of the documentation of classes and structs. If set to YES the list
universe@208 635 # will mention the files that were used to generate the documentation.
universe@208 636 # The default value is: YES.
universe@114 637
universe@114 638 SHOW_USED_FILES = YES
universe@114 639
universe@208 640 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
universe@208 641 # will remove the Files entry from the Quick Index and from the Folder Tree View
universe@208 642 # (if specified).
universe@208 643 # The default value is: YES.
universe@114 644
universe@114 645 SHOW_FILES = YES
universe@114 646
universe@208 647 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
universe@208 648 # page. This will remove the Namespaces entry from the Quick Index and from the
universe@208 649 # Folder Tree View (if specified).
universe@208 650 # The default value is: YES.
universe@114 651
universe@114 652 SHOW_NAMESPACES = YES
universe@114 653
universe@114 654 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
universe@114 655 # doxygen should invoke to get the current version for each file (typically from
universe@114 656 # the version control system). Doxygen will invoke the program by executing (via
universe@208 657 # popen()) the command command input-file, where command is the value of the
universe@208 658 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
universe@208 659 # by doxygen. Whatever the program writes to standard output is used as the file
universe@208 660 # version. For an example see the documentation.
universe@114 661
universe@114 662 FILE_VERSION_FILTER =
universe@114 663
universe@114 664 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
universe@114 665 # by doxygen. The layout file controls the global structure of the generated
universe@208 666 # output files in an output format independent way. To create the layout file
universe@208 667 # that represents doxygen's defaults, run doxygen with the -l option. You can
universe@208 668 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
universe@208 669 # will be used as the name of the layout file.
universe@208 670 #
universe@208 671 # Note that if you run doxygen from a directory containing a file called
universe@208 672 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
universe@208 673 # tag is left empty.
universe@114 674
universe@114 675 LAYOUT_FILE =
universe@114 676
universe@208 677 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
universe@208 678 # the reference definitions. This must be a list of .bib files. The .bib
universe@208 679 # extension is automatically appended if omitted. This requires the bibtex tool
universe@208 680 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
universe@208 681 # For LaTeX the style of the bibliography can be controlled using
universe@208 682 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
universe@208 683 # search path. Do not use file names with spaces, bibtex cannot handle them. See
universe@208 684 # also \cite for info how to create references.
universe@114 685
universe@114 686 CITE_BIB_FILES =
universe@114 687
universe@114 688 #---------------------------------------------------------------------------
universe@208 689 # Configuration options related to warning and progress messages
universe@114 690 #---------------------------------------------------------------------------
universe@114 691
universe@208 692 # The QUIET tag can be used to turn on/off the messages that are generated to
universe@208 693 # standard output by doxygen. If QUIET is set to YES this implies that the
universe@208 694 # messages are off.
universe@208 695 # The default value is: NO.
universe@114 696
universe@114 697 QUIET = NO
universe@114 698
universe@114 699 # The WARNINGS tag can be used to turn on/off the warning messages that are
universe@208 700 # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
universe@208 701 # this implies that the warnings are on.
universe@208 702 #
universe@208 703 # Tip: Turn warnings on while writing the documentation.
universe@208 704 # The default value is: YES.
universe@114 705
universe@114 706 WARNINGS = YES
universe@114 707
universe@208 708 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
universe@208 709 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
universe@208 710 # will automatically be disabled.
universe@208 711 # The default value is: YES.
universe@114 712
universe@114 713 WARN_IF_UNDOCUMENTED = YES
universe@114 714
universe@208 715 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
universe@208 716 # potential errors in the documentation, such as not documenting some parameters
universe@208 717 # in a documented function, or documenting parameters that don't exist or using
universe@208 718 # markup commands wrongly.
universe@208 719 # The default value is: YES.
universe@114 720
universe@114 721 WARN_IF_DOC_ERROR = YES
universe@114 722
universe@208 723 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
universe@208 724 # are documented, but have no documentation for their parameters or return
universe@208 725 # value. If set to NO doxygen will only warn about wrong or incomplete parameter
universe@208 726 # documentation, but not about the absence of documentation.
universe@208 727 # The default value is: NO.
universe@114 728
universe@115 729 WARN_NO_PARAMDOC = YES
universe@114 730
universe@208 731 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
universe@208 732 # can produce. The string should contain the $file, $line, and $text tags, which
universe@208 733 # will be replaced by the file and line number from which the warning originated
universe@208 734 # and the warning text. Optionally the format may contain $version, which will
universe@208 735 # be replaced by the version of the file (if it could be obtained via
universe@208 736 # FILE_VERSION_FILTER)
universe@208 737 # The default value is: $file:$line: $text.
universe@114 738
universe@114 739 WARN_FORMAT = "$file:$line: $text"
universe@114 740
universe@208 741 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
universe@208 742 # messages should be written. If left blank the output is written to standard
universe@208 743 # error (stderr).
universe@114 744
universe@114 745 WARN_LOGFILE =
universe@114 746
universe@114 747 #---------------------------------------------------------------------------
universe@208 748 # Configuration options related to the input files
universe@114 749 #---------------------------------------------------------------------------
universe@114 750
universe@208 751 # The INPUT tag is used to specify the files and/or directories that contain
universe@208 752 # documented source files. You may enter file names like myfile.cpp or
universe@208 753 # directories like /usr/src/myproject. Separate the files or directories with
universe@208 754 # spaces.
universe@208 755 # Note: If this tag is empty the current directory is searched.
universe@114 756
universe@256 757 INPUT = ./src
universe@114 758
universe@114 759 # This tag can be used to specify the character encoding of the source files
universe@208 760 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
universe@208 761 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
universe@208 762 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
universe@208 763 # possible encodings.
universe@208 764 # The default value is: UTF-8.
universe@114 765
universe@114 766 INPUT_ENCODING = UTF-8
universe@114 767
universe@114 768 # If the value of the INPUT tag contains directories, you can use the
universe@208 769 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
universe@208 770 # *.h) to filter out the source-files in the directories. If left blank the
universe@208 771 # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
universe@208 772 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
universe@208 773 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
universe@208 774 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
universe@208 775 # *.qsf, *.as and *.js.
universe@114 776
universe@114 777 FILE_PATTERNS =
universe@114 778
universe@208 779 # The RECURSIVE tag can be used to specify whether or not subdirectories should
universe@208 780 # be searched for input files as well.
universe@208 781 # The default value is: NO.
universe@114 782
universe@114 783 RECURSIVE = YES
universe@114 784
universe@114 785 # The EXCLUDE tag can be used to specify files and/or directories that should be
universe@114 786 # excluded from the INPUT source files. This way you can easily exclude a
universe@114 787 # subdirectory from a directory tree whose root is specified with the INPUT tag.
universe@208 788 #
universe@114 789 # Note that relative paths are relative to the directory from which doxygen is
universe@114 790 # run.
universe@114 791
universe@114 792 EXCLUDE =
universe@114 793
universe@114 794 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
universe@114 795 # directories that are symbolic links (a Unix file system feature) are excluded
universe@114 796 # from the input.
universe@208 797 # The default value is: NO.
universe@114 798
universe@114 799 EXCLUDE_SYMLINKS = NO
universe@114 800
universe@114 801 # If the value of the INPUT tag contains directories, you can use the
universe@114 802 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
universe@208 803 # certain files from those directories.
universe@208 804 #
universe@208 805 # Note that the wildcards are matched against the file with absolute path, so to
universe@208 806 # exclude all test directories for example use the pattern */test/*
universe@208 807
universe@208 808 EXCLUDE_PATTERNS =
universe@114 809
universe@114 810 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
universe@114 811 # (namespaces, classes, functions, etc.) that should be excluded from the
universe@114 812 # output. The symbol name can be a fully qualified name, a word, or if the
universe@114 813 # wildcard * is used, a substring. Examples: ANamespace, AClass,
universe@114 814 # AClass::ANamespace, ANamespace::*Test
universe@208 815 #
universe@208 816 # Note that the wildcards are matched against the file with absolute path, so to
universe@208 817 # exclude all test directories use the pattern */test/*
universe@114 818
universe@114 819 EXCLUDE_SYMBOLS =
universe@114 820
universe@208 821 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
universe@208 822 # that contain example code fragments that are included (see the \include
universe@208 823 # command).
universe@114 824
universe@114 825 EXAMPLE_PATH =
universe@114 826
universe@114 827 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
universe@208 828 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
universe@208 829 # *.h) to filter out the source-files in the directories. If left blank all
universe@208 830 # files are included.
universe@114 831
universe@114 832 EXAMPLE_PATTERNS =
universe@114 833
universe@114 834 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
universe@208 835 # searched for input files to be used with the \include or \dontinclude commands
universe@208 836 # irrespective of the value of the RECURSIVE tag.
universe@208 837 # The default value is: NO.
universe@114 838
universe@114 839 EXAMPLE_RECURSIVE = NO
universe@114 840
universe@208 841 # The IMAGE_PATH tag can be used to specify one or more files or directories
universe@208 842 # that contain images that are to be included in the documentation (see the
universe@208 843 # \image command).
universe@114 844
universe@114 845 IMAGE_PATH =
universe@114 846
universe@114 847 # The INPUT_FILTER tag can be used to specify a program that doxygen should
universe@114 848 # invoke to filter for each input file. Doxygen will invoke the filter program
universe@208 849 # by executing (via popen()) the command:
universe@208 850 #
universe@208 851 # <filter> <input-file>
universe@208 852 #
universe@208 853 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
universe@208 854 # name of an input file. Doxygen will then use the output that the filter
universe@208 855 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
universe@208 856 # will be ignored.
universe@208 857 #
universe@208 858 # Note that the filter must not add or remove lines; it is applied before the
universe@208 859 # code is scanned, but not when the output code is generated. If lines are added
universe@208 860 # or removed, the anchors will not be placed correctly.
universe@114 861
universe@114 862 INPUT_FILTER =
universe@114 863
universe@114 864 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
universe@208 865 # basis. Doxygen will compare the file name with each pattern and apply the
universe@208 866 # filter if there is a match. The filters are a list of the form: pattern=filter
universe@208 867 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
universe@208 868 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
universe@208 869 # patterns match the file name, INPUT_FILTER is applied.
universe@114 870
universe@114 871 FILTER_PATTERNS =
universe@114 872
universe@114 873 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
universe@208 874 # INPUT_FILTER ) will also be used to filter the input files that are used for
universe@208 875 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
universe@208 876 # The default value is: NO.
universe@114 877
universe@114 878 FILTER_SOURCE_FILES = NO
universe@114 879
universe@114 880 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
universe@208 881 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
universe@208 882 # it is also possible to disable source filtering for a specific pattern using
universe@208 883 # *.ext= (so without naming a filter).
universe@208 884 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
universe@114 885
universe@114 886 FILTER_SOURCE_PATTERNS =
universe@114 887
universe@208 888 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
universe@208 889 # is part of the input, its contents will be placed on the main page
universe@208 890 # (index.html). This can be useful if you have a project on for instance GitHub
universe@208 891 # and want to reuse the introduction page also for the doxygen output.
universe@208 892
universe@208 893 USE_MDFILE_AS_MAINPAGE =
universe@208 894
universe@114 895 #---------------------------------------------------------------------------
universe@208 896 # Configuration options related to source browsing
universe@114 897 #---------------------------------------------------------------------------
universe@114 898
universe@208 899 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
universe@208 900 # generated. Documented entities will be cross-referenced with these sources.
universe@208 901 #
universe@208 902 # Note: To get rid of all source code in the generated output, make sure that
universe@208 903 # also VERBATIM_HEADERS is set to NO.
universe@208 904 # The default value is: NO.
universe@114 905
universe@114 906 SOURCE_BROWSER = NO
universe@114 907
universe@208 908 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
universe@208 909 # classes and enums directly into the documentation.
universe@208 910 # The default value is: NO.
universe@114 911
universe@114 912 INLINE_SOURCES = NO
universe@114 913
universe@208 914 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
universe@208 915 # special comment blocks from generated source code fragments. Normal C, C++ and
universe@208 916 # Fortran comments will always remain visible.
universe@208 917 # The default value is: YES.
universe@114 918
universe@114 919 STRIP_CODE_COMMENTS = YES
universe@114 920
universe@208 921 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
universe@208 922 # function all documented functions referencing it will be listed.
universe@208 923 # The default value is: NO.
universe@114 924
universe@114 925 REFERENCED_BY_RELATION = NO
universe@114 926
universe@208 927 # If the REFERENCES_RELATION tag is set to YES then for each documented function
universe@208 928 # all documented entities called/used by that function will be listed.
universe@208 929 # The default value is: NO.
universe@114 930
universe@114 931 REFERENCES_RELATION = NO
universe@114 932
universe@208 933 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
universe@208 934 # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
universe@208 935 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
universe@208 936 # link to the documentation.
universe@208 937 # The default value is: YES.
universe@114 938
universe@114 939 REFERENCES_LINK_SOURCE = YES
universe@114 940
universe@208 941 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
universe@208 942 # source code will show a tooltip with additional information such as prototype,
universe@208 943 # brief description and links to the definition and documentation. Since this
universe@208 944 # will make the HTML file larger and loading of large files a bit slower, you
universe@208 945 # can opt to disable this feature.
universe@208 946 # The default value is: YES.
universe@208 947 # This tag requires that the tag SOURCE_BROWSER is set to YES.
universe@208 948
universe@208 949 SOURCE_TOOLTIPS = YES
universe@208 950
universe@208 951 # If the USE_HTAGS tag is set to YES then the references to source code will
universe@208 952 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
universe@208 953 # source browser. The htags tool is part of GNU's global source tagging system
universe@208 954 # (see http://www.gnu.org/software/global/global.html). You will need version
universe@208 955 # 4.8.6 or higher.
universe@208 956 #
universe@208 957 # To use it do the following:
universe@208 958 # - Install the latest version of global
universe@208 959 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
universe@208 960 # - Make sure the INPUT points to the root of the source tree
universe@208 961 # - Run doxygen as normal
universe@208 962 #
universe@208 963 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
universe@208 964 # tools must be available from the command line (i.e. in the search path).
universe@208 965 #
universe@208 966 # The result: instead of the source browser generated by doxygen, the links to
universe@208 967 # source code will now point to the output of htags.
universe@208 968 # The default value is: NO.
universe@208 969 # This tag requires that the tag SOURCE_BROWSER is set to YES.
universe@114 970
universe@114 971 USE_HTAGS = NO
universe@114 972
universe@208 973 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
universe@208 974 # verbatim copy of the header file for each class for which an include is
universe@208 975 # specified. Set to NO to disable this.
universe@208 976 # See also: Section \class.
universe@208 977 # The default value is: YES.
universe@114 978
universe@114 979 VERBATIM_HEADERS = YES
universe@114 980
universe@114 981 #---------------------------------------------------------------------------
universe@208 982 # Configuration options related to the alphabetical class index
universe@114 983 #---------------------------------------------------------------------------
universe@114 984
universe@208 985 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
universe@208 986 # compounds will be generated. Enable this if the project contains a lot of
universe@208 987 # classes, structs, unions or interfaces.
universe@208 988 # The default value is: YES.
universe@114 989
universe@114 990 ALPHABETICAL_INDEX = YES
universe@114 991
universe@208 992 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
universe@208 993 # which the alphabetical index list will be split.
universe@208 994 # Minimum value: 1, maximum value: 20, default value: 5.
universe@208 995 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
universe@114 996
universe@114 997 COLS_IN_ALPHA_INDEX = 5
universe@114 998
universe@208 999 # In case all classes in a project start with a common prefix, all classes will
universe@208 1000 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
universe@208 1001 # can be used to specify a prefix (or a list of prefixes) that should be ignored
universe@208 1002 # while generating the index headers.
universe@208 1003 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
universe@114 1004
universe@114 1005 IGNORE_PREFIX =
universe@114 1006
universe@114 1007 #---------------------------------------------------------------------------
universe@208 1008 # Configuration options related to the HTML output
universe@114 1009 #---------------------------------------------------------------------------
universe@114 1010
universe@208 1011 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
universe@208 1012 # The default value is: YES.
universe@114 1013
universe@114 1014 GENERATE_HTML = YES
universe@114 1015
universe@208 1016 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
universe@208 1017 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
universe@208 1018 # it.
universe@208 1019 # The default directory is: html.
universe@208 1020 # This tag requires that the tag GENERATE_HTML is set to YES.
universe@114 1021
universe@256 1022 HTML_OUTPUT = web/api
universe@114 1023
universe@208 1024 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
universe@208 1025 # generated HTML page (for example: .htm, .php, .asp).
universe@208 1026 # The default value is: .html.
universe@208 1027 # This tag requires that the tag GENERATE_HTML is set to YES.
universe@114 1028
universe@114 1029 HTML_FILE_EXTENSION = .html
universe@114 1030
universe@208 1031 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
universe@208 1032 # each generated HTML page. If the tag is left blank doxygen will generate a
universe@208 1033 # standard header.
universe@208 1034 #
universe@208 1035 # To get valid HTML the header file that includes any scripts and style sheets
universe@208 1036 # that doxygen needs, which is dependent on the configuration options used (e.g.
universe@208 1037 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
universe@208 1038 # default header using
universe@208 1039 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
universe@208 1040 # YourConfigFile
universe@208 1041 # and then modify the file new_header.html. See also section "Doxygen usage"
universe@208 1042 # for information on how to generate the default header that doxygen normally
universe@208 1043 # uses.
universe@208 1044 # Note: The header is subject to change so you typically have to regenerate the
universe@208 1045 # default header when upgrading to a newer version of doxygen. For a description
universe@208 1046 # of the possible markers and block names see the documentation.
universe@208 1047 # This tag requires that the tag GENERATE_HTML is set to YES.
universe@114 1048
universe@114 1049 HTML_HEADER =
universe@114 1050
universe@208 1051 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
universe@208 1052 # generated HTML page. If the tag is left blank doxygen will generate a standard
universe@208 1053 # footer. See HTML_HEADER for more information on how to generate a default
universe@208 1054 # footer and what special commands can be used inside the footer. See also
universe@208 1055 # section "Doxygen usage" for information on how to generate the default footer
universe@208 1056 # that doxygen normally uses.
universe@208 1057 # This tag requires that the tag GENERATE_HTML is set to YES.
universe@114 1058
universe@114 1059 HTML_FOOTER =
universe@114 1060
universe@208 1061 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
universe@208 1062 # sheet that is used by each HTML page. It can be used to fine-tune the look of
universe@208 1063 # the HTML output. If left blank doxygen will generate a default style sheet.
universe@208 1064 # See also section "Doxygen usage" for information on how to generate the style
universe@208 1065 # sheet that doxygen normally uses.
universe@208 1066 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
universe@208 1067 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
universe@208 1068 # obsolete.
universe@208 1069 # This tag requires that the tag GENERATE_HTML is set to YES.
universe@114 1070
universe@114 1071 HTML_STYLESHEET =
universe@114 1072
universe@208 1073 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
universe@208 1074 # defined cascading style sheet that is included after the standard style sheets
universe@208 1075 # created by doxygen. Using this option one can overrule certain style aspects.
universe@208 1076 # This is preferred over using HTML_STYLESHEET since it does not replace the
universe@208 1077 # standard style sheet and is therefor more robust against future updates.
universe@208 1078 # Doxygen will copy the style sheet file to the output directory. For an example
universe@208 1079 # see the documentation.
universe@208 1080 # This tag requires that the tag GENERATE_HTML is set to YES.
universe@208 1081
universe@208 1082 HTML_EXTRA_STYLESHEET =
universe@208 1083
universe@114 1084 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
universe@114 1085 # other source files which should be copied to the HTML output directory. Note
universe@114 1086 # that these files will be copied to the base HTML output directory. Use the
universe@208 1087 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
universe@208 1088 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
universe@208 1089 # files will be copied as-is; there are no commands or markers available.
universe@208 1090 # This tag requires that the tag GENERATE_HTML is set to YES.
universe@114 1091
universe@114 1092 HTML_EXTRA_FILES =
universe@114 1093
universe@208 1094 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
universe@208 1095 # will adjust the colors in the stylesheet and background images according to
universe@208 1096 # this color. Hue is specified as an angle on a colorwheel, see
universe@208 1097 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
universe@208 1098 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
universe@208 1099 # purple, and 360 is red again.
universe@208 1100 # Minimum value: 0, maximum value: 359, default value: 220.
universe@208 1101 # This tag requires that the tag GENERATE_HTML is set to YES.
universe@114 1102
universe@114 1103 HTML_COLORSTYLE_HUE = 220
universe@114 1104
universe@208 1105 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
universe@208 1106 # in the HTML output. For a value of 0 the output will use grayscales only. A
universe@208 1107 # value of 255 will produce the most vivid colors.
universe@208 1108 # Minimum value: 0, maximum value: 255, default value: 100.
universe@208 1109 # This tag requires that the tag GENERATE_HTML is set to YES.
universe@114 1110
universe@114 1111 HTML_COLORSTYLE_SAT = 100
universe@114 1112
universe@208 1113 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
universe@208 1114 # luminance component of the colors in the HTML output. Values below 100
universe@208 1115 # gradually make the output lighter, whereas values above 100 make the output
universe@208 1116 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
universe@208 1117 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
universe@208 1118 # change the gamma.
universe@208 1119 # Minimum value: 40, maximum value: 240, default value: 80.
universe@208 1120 # This tag requires that the tag GENERATE_HTML is set to YES.
universe@114 1121
universe@114 1122 HTML_COLORSTYLE_GAMMA = 80
universe@114 1123
universe@114 1124 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
universe@208 1125 # page will contain the date and time when the page was generated. Setting this
universe@208 1126 # to NO can help when comparing the output of multiple runs.
universe@208 1127 # The default value is: YES.
universe@208 1128 # This tag requires that the tag GENERATE_HTML is set to YES.
universe@114 1129
universe@114 1130 HTML_TIMESTAMP = YES
universe@114 1131
universe@114 1132 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
universe@114 1133 # documentation will contain sections that can be hidden and shown after the
universe@208 1134 # page has loaded.
universe@208 1135 # The default value is: NO.
universe@208 1136 # This tag requires that the tag GENERATE_HTML is set to YES.
universe@114 1137
universe@114 1138 HTML_DYNAMIC_SECTIONS = NO
universe@114 1139
universe@208 1140 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
universe@208 1141 # shown in the various tree structured indices initially; the user can expand
universe@208 1142 # and collapse entries dynamically later on. Doxygen will expand the tree to
universe@208 1143 # such a level that at most the specified number of entries are visible (unless
universe@208 1144 # a fully collapsed tree already exceeds this amount). So setting the number of
universe@208 1145 # entries 1 will produce a full collapsed tree by default. 0 is a special value
universe@208 1146 # representing an infinite number of entries and will result in a full expanded
universe@208 1147 # tree by default.
universe@208 1148 # Minimum value: 0, maximum value: 9999, default value: 100.
universe@208 1149 # This tag requires that the tag GENERATE_HTML is set to YES.
universe@208 1150
universe@208 1151 HTML_INDEX_NUM_ENTRIES = 100
universe@208 1152
universe@208 1153 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
universe@208 1154 # generated that can be used as input for Apple's Xcode 3 integrated development
universe@208 1155 # environment (see: http://developer.apple.com/tools/xcode/), introduced with
universe@208 1156 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
universe@208 1157 # Makefile in the HTML output directory. Running make will produce the docset in
universe@208 1158 # that directory and running make install will install the docset in
universe@208 1159 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
universe@208 1160 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
universe@114 1161 # for more information.
universe@208 1162 # The default value is: NO.
universe@208 1163 # This tag requires that the tag GENERATE_HTML is set to YES.
universe@114 1164
universe@114 1165 GENERATE_DOCSET = NO
universe@114 1166
universe@208 1167 # This tag determines the name of the docset feed. A documentation feed provides
universe@208 1168 # an umbrella under which multiple documentation sets from a single provider
universe@208 1169 # (such as a company or product suite) can be grouped.
universe@208 1170 # The default value is: Doxygen generated docs.
universe@208 1171 # This tag requires that the tag GENERATE_DOCSET is set to YES.
universe@114 1172
universe@114 1173 DOCSET_FEEDNAME = "Doxygen generated docs"
universe@114 1174
universe@208 1175 # This tag specifies a string that should uniquely identify the documentation
universe@208 1176 # set bundle. This should be a reverse domain-name style string, e.g.
universe@208 1177 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
universe@208 1178 # The default value is: org.doxygen.Project.
universe@208 1179 # This tag requires that the tag GENERATE_DOCSET is set to YES.
universe@114 1180
universe@114 1181 DOCSET_BUNDLE_ID = org.doxygen.Project
universe@114 1182
universe@208 1183 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
universe@114 1184 # the documentation publisher. This should be a reverse domain-name style
universe@114 1185 # string, e.g. com.mycompany.MyDocSet.documentation.
universe@208 1186 # The default value is: org.doxygen.Publisher.
universe@208 1187 # This tag requires that the tag GENERATE_DOCSET is set to YES.
universe@114 1188
universe@114 1189 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
universe@114 1190
universe@208 1191 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
universe@208 1192 # The default value is: Publisher.
universe@208 1193 # This tag requires that the tag GENERATE_DOCSET is set to YES.
universe@114 1194
universe@114 1195 DOCSET_PUBLISHER_NAME = Publisher
universe@114 1196
universe@208 1197 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
universe@208 1198 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
universe@208 1199 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
universe@208 1200 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
universe@208 1201 # Windows.
universe@208 1202 #
universe@208 1203 # The HTML Help Workshop contains a compiler that can convert all HTML output
universe@208 1204 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
universe@208 1205 # files are now used as the Windows 98 help format, and will replace the old
universe@208 1206 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
universe@208 1207 # HTML files also contain an index, a table of contents, and you can search for
universe@208 1208 # words in the documentation. The HTML workshop also contains a viewer for
universe@208 1209 # compressed HTML files.
universe@208 1210 # The default value is: NO.
universe@208 1211 # This tag requires that the tag GENERATE_HTML is set to YES.
universe@114 1212
universe@114 1213 GENERATE_HTMLHELP = NO
universe@114 1214
universe@208 1215 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
universe@208 1216 # file. You can add a path in front of the file if the result should not be
universe@114 1217 # written to the html output directory.
universe@208 1218 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
universe@114 1219
universe@114 1220 CHM_FILE =
universe@114 1221
universe@208 1222 # The HHC_LOCATION tag can be used to specify the location (absolute path
universe@208 1223 # including file name) of the HTML help compiler ( hhc.exe). If non-empty
universe@208 1224 # doxygen will try to run the HTML help compiler on the generated index.hhp.
universe@208 1225 # The file has to be specified with full path.
universe@208 1226 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
universe@114 1227
universe@114 1228 HHC_LOCATION =
universe@114 1229
universe@208 1230 # The GENERATE_CHI flag controls if a separate .chi index file is generated (
universe@208 1231 # YES) or that it should be included in the master .chm file ( NO).
universe@208 1232 # The default value is: NO.
universe@208 1233 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
universe@114 1234
universe@114 1235 GENERATE_CHI = NO
universe@114 1236
universe@208 1237 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
universe@208 1238 # and project file content.
universe@208 1239 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
universe@114 1240
universe@114 1241 CHM_INDEX_ENCODING =
universe@114 1242
universe@208 1243 # The BINARY_TOC flag controls whether a binary table of contents is generated (
universe@208 1244 # YES) or a normal table of contents ( NO) in the .chm file. Furthermore it
universe@208 1245 # enables the Previous and Next buttons.
universe@208 1246 # The default value is: NO.
universe@208 1247 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
universe@114 1248
universe@114 1249 BINARY_TOC = NO
universe@114 1250
universe@208 1251 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
universe@208 1252 # the table of contents of the HTML help documentation and to the tree view.
universe@208 1253 # The default value is: NO.
universe@208 1254 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
universe@114 1255
universe@114 1256 TOC_EXPAND = NO
universe@114 1257
universe@114 1258 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
universe@208 1259 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
universe@208 1260 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
universe@208 1261 # (.qch) of the generated HTML documentation.
universe@208 1262 # The default value is: NO.
universe@208 1263 # This tag requires that the tag GENERATE_HTML is set to YES.
universe@114 1264
universe@114 1265 GENERATE_QHP = NO
universe@114 1266
universe@208 1267 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
universe@208 1268 # the file name of the resulting .qch file. The path specified is relative to
universe@208 1269 # the HTML output folder.
universe@208 1270 # This tag requires that the tag GENERATE_QHP is set to YES.
universe@114 1271
universe@114 1272 QCH_FILE =
universe@114 1273
universe@208 1274 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
universe@208 1275 # Project output. For more information please see Qt Help Project / Namespace
universe@208 1276 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
universe@208 1277 # The default value is: org.doxygen.Project.
universe@208 1278 # This tag requires that the tag GENERATE_QHP is set to YES.
universe@114 1279
universe@114 1280 QHP_NAMESPACE = org.doxygen.Project
universe@114 1281
universe@208 1282 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
universe@208 1283 # Help Project output. For more information please see Qt Help Project / Virtual
universe@208 1284 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
universe@208 1285 # folders).
universe@208 1286 # The default value is: doc.
universe@208 1287 # This tag requires that the tag GENERATE_QHP is set to YES.
universe@114 1288
universe@114 1289 QHP_VIRTUAL_FOLDER = doc
universe@114 1290
universe@208 1291 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
universe@208 1292 # filter to add. For more information please see Qt Help Project / Custom
universe@208 1293 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
universe@208 1294 # filters).
universe@208 1295 # This tag requires that the tag GENERATE_QHP is set to YES.
universe@114 1296
universe@114 1297 QHP_CUST_FILTER_NAME =
universe@114 1298
universe@208 1299 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
universe@208 1300 # custom filter to add. For more information please see Qt Help Project / Custom
universe@208 1301 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
universe@208 1302 # filters).
universe@208 1303 # This tag requires that the tag GENERATE_QHP is set to YES.
universe@114 1304
universe@114 1305 QHP_CUST_FILTER_ATTRS =
universe@114 1306
universe@114 1307 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
universe@208 1308 # project's filter section matches. Qt Help Project / Filter Attributes (see:
universe@208 1309 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
universe@208 1310 # This tag requires that the tag GENERATE_QHP is set to YES.
universe@114 1311
universe@114 1312 QHP_SECT_FILTER_ATTRS =
universe@114 1313
universe@208 1314 # The QHG_LOCATION tag can be used to specify the location of Qt's
universe@208 1315 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
universe@208 1316 # generated .qhp file.
universe@208 1317 # This tag requires that the tag GENERATE_QHP is set to YES.
universe@114 1318
universe@114 1319 QHG_LOCATION =
universe@114 1320
universe@208 1321 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
universe@208 1322 # generated, together with the HTML files, they form an Eclipse help plugin. To
universe@208 1323 # install this plugin and make it available under the help contents menu in
universe@208 1324 # Eclipse, the contents of the directory containing the HTML and XML files needs
universe@208 1325 # to be copied into the plugins directory of eclipse. The name of the directory
universe@208 1326 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
universe@208 1327 # After copying Eclipse needs to be restarted before the help appears.
universe@208 1328 # The default value is: NO.
universe@208 1329 # This tag requires that the tag GENERATE_HTML is set to YES.
universe@114 1330
universe@114 1331 GENERATE_ECLIPSEHELP = NO
universe@114 1332
universe@208 1333 # A unique identifier for the Eclipse help plugin. When installing the plugin
universe@208 1334 # the directory name containing the HTML and XML files should also have this
universe@208 1335 # name. Each documentation set should have its own identifier.
universe@208 1336 # The default value is: org.doxygen.Project.
universe@208 1337 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
universe@114 1338
universe@114 1339 ECLIPSE_DOC_ID = org.doxygen.Project
universe@114 1340
universe@208 1341 # If you want full control over the layout of the generated HTML pages it might
universe@208 1342 # be necessary to disable the index and replace it with your own. The
universe@208 1343 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
universe@208 1344 # of each HTML page. A value of NO enables the index and the value YES disables
universe@208 1345 # it. Since the tabs in the index contain the same information as the navigation
universe@208 1346 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
universe@208 1347 # The default value is: NO.
universe@208 1348 # This tag requires that the tag GENERATE_HTML is set to YES.
universe@114 1349
universe@114 1350 DISABLE_INDEX = NO
universe@114 1351
universe@114 1352 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
universe@208 1353 # structure should be generated to display hierarchical information. If the tag
universe@208 1354 # value is set to YES, a side panel will be generated containing a tree-like
universe@208 1355 # index structure (just like the one that is generated for HTML Help). For this
universe@208 1356 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
universe@208 1357 # (i.e. any modern browser). Windows users are probably better off using the
universe@208 1358 # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
universe@208 1359 # further fine-tune the look of the index. As an example, the default style
universe@208 1360 # sheet generated by doxygen has an example that shows how to put an image at
universe@208 1361 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
universe@208 1362 # the same information as the tab index, you could consider setting
universe@208 1363 # DISABLE_INDEX to YES when enabling this option.
universe@208 1364 # The default value is: NO.
universe@208 1365 # This tag requires that the tag GENERATE_HTML is set to YES.
universe@114 1366
universe@114 1367 GENERATE_TREEVIEW = NO
universe@114 1368
universe@208 1369 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
universe@208 1370 # doxygen will group on one line in the generated HTML documentation.
universe@208 1371 #
universe@208 1372 # Note that a value of 0 will completely suppress the enum values from appearing
universe@208 1373 # in the overview section.
universe@208 1374 # Minimum value: 0, maximum value: 20, default value: 4.
universe@208 1375 # This tag requires that the tag GENERATE_HTML is set to YES.
universe@114 1376
universe@114 1377 ENUM_VALUES_PER_LINE = 4
universe@114 1378
universe@208 1379 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
universe@208 1380 # to set the initial width (in pixels) of the frame in which the tree is shown.
universe@208 1381 # Minimum value: 0, maximum value: 1500, default value: 250.
universe@208 1382 # This tag requires that the tag GENERATE_HTML is set to YES.
universe@114 1383
universe@114 1384 TREEVIEW_WIDTH = 250
universe@114 1385
universe@208 1386 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
universe@208 1387 # external symbols imported via tag files in a separate window.
universe@208 1388 # The default value is: NO.
universe@208 1389 # This tag requires that the tag GENERATE_HTML is set to YES.
universe@114 1390
universe@114 1391 EXT_LINKS_IN_WINDOW = NO
universe@114 1392
universe@208 1393 # Use this tag to change the font size of LaTeX formulas included as images in
universe@208 1394 # the HTML documentation. When you change the font size after a successful
universe@208 1395 # doxygen run you need to manually remove any form_*.png images from the HTML
universe@208 1396 # output directory to force them to be regenerated.
universe@208 1397 # Minimum value: 8, maximum value: 50, default value: 10.
universe@208 1398 # This tag requires that the tag GENERATE_HTML is set to YES.
universe@114 1399
universe@114 1400 FORMULA_FONTSIZE = 10
universe@114 1401
universe@114 1402 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
universe@208 1403 # generated for formulas are transparent PNGs. Transparent PNGs are not
universe@208 1404 # supported properly for IE 6.0, but are supported on all modern browsers.
universe@208 1405 #
universe@208 1406 # Note that when changing this option you need to delete any form_*.png files in
universe@208 1407 # the HTML output directory before the changes have effect.
universe@208 1408 # The default value is: YES.
universe@208 1409 # This tag requires that the tag GENERATE_HTML is set to YES.
universe@114 1410
universe@114 1411 FORMULA_TRANSPARENT = YES
universe@114 1412
universe@208 1413 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
universe@208 1414 # http://www.mathjax.org) which uses client side Javascript for the rendering
universe@208 1415 # instead of using prerendered bitmaps. Use this if you do not have LaTeX
universe@208 1416 # installed or if you want to formulas look prettier in the HTML output. When
universe@208 1417 # enabled you may also need to install MathJax separately and configure the path
universe@208 1418 # to it using the MATHJAX_RELPATH option.
universe@208 1419 # The default value is: NO.
universe@208 1420 # This tag requires that the tag GENERATE_HTML is set to YES.
universe@114 1421
universe@114 1422 USE_MATHJAX = NO
universe@114 1423
universe@208 1424 # When MathJax is enabled you can set the default output format to be used for
universe@208 1425 # the MathJax output. See the MathJax site (see:
universe@208 1426 # http://docs.mathjax.org/en/latest/output.html) for more details.
universe@208 1427 # Possible values are: HTML-CSS (which is slower, but has the best
universe@208 1428 # compatibility), NativeMML (i.e. MathML) and SVG.
universe@208 1429 # The default value is: HTML-CSS.
universe@208 1430 # This tag requires that the tag USE_MATHJAX is set to YES.
universe@208 1431
universe@208 1432 MATHJAX_FORMAT = HTML-CSS
universe@208 1433
universe@208 1434 # When MathJax is enabled you need to specify the location relative to the HTML
universe@208 1435 # output directory using the MATHJAX_RELPATH option. The destination directory
universe@208 1436 # should contain the MathJax.js script. For instance, if the mathjax directory
universe@208 1437 # is located at the same level as the HTML output directory, then
universe@208 1438 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
universe@208 1439 # Content Delivery Network so you can quickly see the result without installing
universe@208 1440 # MathJax. However, it is strongly recommended to install a local copy of
universe@208 1441 # MathJax from http://www.mathjax.org before deployment.
universe@208 1442 # The default value is: http://cdn.mathjax.org/mathjax/latest.
universe@208 1443 # This tag requires that the tag USE_MATHJAX is set to YES.
universe@114 1444
universe@114 1445 MATHJAX_RELPATH = http://www.mathjax.org/mathjax
universe@114 1446
universe@208 1447 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
universe@208 1448 # extension names that should be enabled during MathJax rendering. For example
universe@208 1449 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
universe@208 1450 # This tag requires that the tag USE_MATHJAX is set to YES.
universe@114 1451
universe@114 1452 MATHJAX_EXTENSIONS =
universe@114 1453
universe@208 1454 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
universe@208 1455 # of code that will be used on startup of the MathJax code. See the MathJax site
universe@208 1456 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
universe@208 1457 # example see the documentation.
universe@208 1458 # This tag requires that the tag USE_MATHJAX is set to YES.
universe@208 1459
universe@208 1460 MATHJAX_CODEFILE =
universe@208 1461
universe@208 1462 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
universe@208 1463 # the HTML output. The underlying search engine uses javascript and DHTML and
universe@208 1464 # should work on any modern browser. Note that when using HTML help
universe@208 1465 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
universe@208 1466 # there is already a search function so this one should typically be disabled.
universe@208 1467 # For large projects the javascript based search engine can be slow, then
universe@208 1468 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
universe@208 1469 # search using the keyboard; to jump to the search box use <access key> + S
universe@208 1470 # (what the <access key> is depends on the OS and browser, but it is typically
universe@208 1471 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
universe@208 1472 # key> to jump into the search results window, the results can be navigated
universe@208 1473 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
universe@208 1474 # the search. The filter options can be selected when the cursor is inside the
universe@208 1475 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
universe@208 1476 # to select a filter and <Enter> or <escape> to activate or cancel the filter
universe@208 1477 # option.
universe@208 1478 # The default value is: YES.
universe@208 1479 # This tag requires that the tag GENERATE_HTML is set to YES.
universe@114 1480
universe@114 1481 SEARCHENGINE = YES
universe@114 1482
universe@114 1483 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
universe@208 1484 # implemented using a web server instead of a web client using Javascript. There
universe@208 1485 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
universe@208 1486 # setting. When disabled, doxygen will generate a PHP script for searching and
universe@208 1487 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
universe@208 1488 # and searching needs to be provided by external tools. See the section
universe@208 1489 # "External Indexing and Searching" for details.
universe@208 1490 # The default value is: NO.
universe@208 1491 # This tag requires that the tag SEARCHENGINE is set to YES.
universe@114 1492
universe@114 1493 SERVER_BASED_SEARCH = NO
universe@114 1494
universe@208 1495 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
universe@208 1496 # script for searching. Instead the search results are written to an XML file
universe@208 1497 # which needs to be processed by an external indexer. Doxygen will invoke an
universe@208 1498 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
universe@208 1499 # search results.
universe@208 1500 #
universe@208 1501 # Doxygen ships with an example indexer ( doxyindexer) and search engine
universe@208 1502 # (doxysearch.cgi) which are based on the open source search engine library
universe@208 1503 # Xapian (see: http://xapian.org/).
universe@208 1504 #
universe@208 1505 # See the section "External Indexing and Searching" for details.
universe@208 1506 # The default value is: NO.
universe@208 1507 # This tag requires that the tag SEARCHENGINE is set to YES.
universe@208 1508
universe@208 1509 EXTERNAL_SEARCH = NO
universe@208 1510
universe@208 1511 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
universe@208 1512 # which will return the search results when EXTERNAL_SEARCH is enabled.
universe@208 1513 #
universe@208 1514 # Doxygen ships with an example indexer ( doxyindexer) and search engine
universe@208 1515 # (doxysearch.cgi) which are based on the open source search engine library
universe@208 1516 # Xapian (see: http://xapian.org/). See the section "External Indexing and
universe@208 1517 # Searching" for details.
universe@208 1518 # This tag requires that the tag SEARCHENGINE is set to YES.
universe@208 1519
universe@208 1520 SEARCHENGINE_URL =
universe@208 1521
universe@208 1522 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
universe@208 1523 # search data is written to a file for indexing by an external tool. With the
universe@208 1524 # SEARCHDATA_FILE tag the name of this file can be specified.
universe@208 1525 # The default file is: searchdata.xml.
universe@208 1526 # This tag requires that the tag SEARCHENGINE is set to YES.
universe@208 1527
universe@208 1528 SEARCHDATA_FILE = searchdata.xml
universe@208 1529
universe@208 1530 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
universe@208 1531 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
universe@208 1532 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
universe@208 1533 # projects and redirect the results back to the right project.
universe@208 1534 # This tag requires that the tag SEARCHENGINE is set to YES.
universe@208 1535
universe@208 1536 EXTERNAL_SEARCH_ID =
universe@208 1537
universe@208 1538 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
universe@208 1539 # projects other than the one defined by this configuration file, but that are
universe@208 1540 # all added to the same external search index. Each project needs to have a
universe@208 1541 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
universe@208 1542 # to a relative location where the documentation can be found. The format is:
universe@208 1543 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
universe@208 1544 # This tag requires that the tag SEARCHENGINE is set to YES.
universe@208 1545
universe@208 1546 EXTRA_SEARCH_MAPPINGS =
universe@208 1547
universe@114 1548 #---------------------------------------------------------------------------
universe@208 1549 # Configuration options related to the LaTeX output
universe@114 1550 #---------------------------------------------------------------------------
universe@114 1551
universe@208 1552 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
universe@208 1553 # The default value is: YES.
universe@114 1554
universe@114 1555 GENERATE_LATEX = NO
universe@114 1556
universe@208 1557 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
universe@208 1558 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
universe@208 1559 # it.
universe@208 1560 # The default directory is: latex.
universe@208 1561 # This tag requires that the tag GENERATE_LATEX is set to YES.
universe@114 1562
universe@114 1563 LATEX_OUTPUT = latex
universe@114 1564
universe@114 1565 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
universe@208 1566 # invoked.
universe@208 1567 #
universe@208 1568 # Note that when enabling USE_PDFLATEX this option is only used for generating
universe@208 1569 # bitmaps for formulas in the HTML output, but not in the Makefile that is
universe@208 1570 # written to the output directory.
universe@208 1571 # The default file is: latex.
universe@208 1572 # This tag requires that the tag GENERATE_LATEX is set to YES.
universe@114 1573
universe@114 1574 LATEX_CMD_NAME = latex
universe@114 1575
universe@208 1576 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
universe@208 1577 # index for LaTeX.
universe@208 1578 # The default file is: makeindex.
universe@208 1579 # This tag requires that the tag GENERATE_LATEX is set to YES.
universe@114 1580
universe@114 1581 MAKEINDEX_CMD_NAME = makeindex
universe@114 1582
universe@208 1583 # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
universe@208 1584 # documents. This may be useful for small projects and may help to save some
universe@208 1585 # trees in general.
universe@208 1586 # The default value is: NO.
universe@208 1587 # This tag requires that the tag GENERATE_LATEX is set to YES.
universe@114 1588
universe@114 1589 COMPACT_LATEX = NO
universe@114 1590
universe@208 1591 # The PAPER_TYPE tag can be used to set the paper type that is used by the
universe@208 1592 # printer.
universe@208 1593 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
universe@208 1594 # 14 inches) and executive (7.25 x 10.5 inches).
universe@208 1595 # The default value is: a4.
universe@208 1596 # This tag requires that the tag GENERATE_LATEX is set to YES.
universe@114 1597
universe@114 1598 PAPER_TYPE = a4
universe@114 1599
universe@208 1600 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
universe@208 1601 # that should be included in the LaTeX output. To get the times font for
universe@208 1602 # instance you can specify
universe@208 1603 # EXTRA_PACKAGES=times
universe@208 1604 # If left blank no extra packages will be included.
universe@208 1605 # This tag requires that the tag GENERATE_LATEX is set to YES.
universe@114 1606
universe@114 1607 EXTRA_PACKAGES =
universe@114 1608
universe@208 1609 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
universe@208 1610 # generated LaTeX document. The header should contain everything until the first
universe@208 1611 # chapter. If it is left blank doxygen will generate a standard header. See
universe@208 1612 # section "Doxygen usage" for information on how to let doxygen write the
universe@208 1613 # default header to a separate file.
universe@208 1614 #
universe@208 1615 # Note: Only use a user-defined header if you know what you are doing! The
universe@208 1616 # following commands have a special meaning inside the header: $title,
universe@208 1617 # $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
universe@208 1618 # replace them by respectively the title of the page, the current date and time,
universe@208 1619 # only the current date, the version number of doxygen, the project name (see
universe@208 1620 # PROJECT_NAME), or the project number (see PROJECT_NUMBER).
universe@208 1621 # This tag requires that the tag GENERATE_LATEX is set to YES.
universe@114 1622
universe@114 1623 LATEX_HEADER =
universe@114 1624
universe@208 1625 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
universe@208 1626 # generated LaTeX document. The footer should contain everything after the last
universe@208 1627 # chapter. If it is left blank doxygen will generate a standard footer.
universe@208 1628 #
universe@208 1629 # Note: Only use a user-defined footer if you know what you are doing!
universe@208 1630 # This tag requires that the tag GENERATE_LATEX is set to YES.
universe@114 1631
universe@114 1632 LATEX_FOOTER =
universe@114 1633
universe@208 1634 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
universe@208 1635 # other source files which should be copied to the LATEX_OUTPUT output
universe@208 1636 # directory. Note that the files will be copied as-is; there are no commands or
universe@208 1637 # markers available.
universe@208 1638 # This tag requires that the tag GENERATE_LATEX is set to YES.
universe@208 1639
universe@208 1640 LATEX_EXTRA_FILES =
universe@208 1641
universe@208 1642 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
universe@208 1643 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
universe@208 1644 # contain links (just like the HTML output) instead of page references. This
universe@208 1645 # makes the output suitable for online browsing using a PDF viewer.
universe@208 1646 # The default value is: YES.
universe@208 1647 # This tag requires that the tag GENERATE_LATEX is set to YES.
universe@114 1648
universe@114 1649 PDF_HYPERLINKS = YES
universe@114 1650
universe@208 1651 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
universe@208 1652 # the PDF file directly from the LaTeX files. Set this option to YES to get a
universe@114 1653 # higher quality PDF documentation.
universe@208 1654 # The default value is: YES.
universe@208 1655 # This tag requires that the tag GENERATE_LATEX is set to YES.
universe@114 1656
universe@114 1657 USE_PDFLATEX = YES
universe@114 1658
universe@208 1659 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
universe@208 1660 # command to the generated LaTeX files. This will instruct LaTeX to keep running
universe@208 1661 # if errors occur, instead of asking the user for help. This option is also used
universe@208 1662 # when generating formulas in HTML.
universe@208 1663 # The default value is: NO.
universe@208 1664 # This tag requires that the tag GENERATE_LATEX is set to YES.
universe@114 1665
universe@114 1666 LATEX_BATCHMODE = NO
universe@114 1667
universe@208 1668 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
universe@208 1669 # index chapters (such as File Index, Compound Index, etc.) in the output.
universe@208 1670 # The default value is: NO.
universe@208 1671 # This tag requires that the tag GENERATE_LATEX is set to YES.
universe@114 1672
universe@114 1673 LATEX_HIDE_INDICES = NO
universe@114 1674
universe@208 1675 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
universe@208 1676 # code with syntax highlighting in the LaTeX output.
universe@208 1677 #
universe@208 1678 # Note that which sources are shown also depends on other settings such as
universe@208 1679 # SOURCE_BROWSER.
universe@208 1680 # The default value is: NO.
universe@208 1681 # This tag requires that the tag GENERATE_LATEX is set to YES.
universe@114 1682
universe@114 1683 LATEX_SOURCE_CODE = NO
universe@114 1684
universe@114 1685 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
universe@208 1686 # bibliography, e.g. plainnat, or ieeetr. See
universe@208 1687 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
universe@208 1688 # The default value is: plain.
universe@208 1689 # This tag requires that the tag GENERATE_LATEX is set to YES.
universe@114 1690
universe@114 1691 LATEX_BIB_STYLE = plain
universe@114 1692
universe@114 1693 #---------------------------------------------------------------------------
universe@208 1694 # Configuration options related to the RTF output
universe@114 1695 #---------------------------------------------------------------------------
universe@114 1696
universe@208 1697 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
universe@208 1698 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
universe@208 1699 # readers/editors.
universe@208 1700 # The default value is: NO.
universe@114 1701
universe@114 1702 GENERATE_RTF = NO
universe@114 1703
universe@208 1704 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
universe@208 1705 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
universe@208 1706 # it.
universe@208 1707 # The default directory is: rtf.
universe@208 1708 # This tag requires that the tag GENERATE_RTF is set to YES.
universe@114 1709
universe@114 1710 RTF_OUTPUT = rtf
universe@114 1711
universe@208 1712 # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
universe@208 1713 # documents. This may be useful for small projects and may help to save some
universe@208 1714 # trees in general.
universe@208 1715 # The default value is: NO.
universe@208 1716 # This tag requires that the tag GENERATE_RTF is set to YES.
universe@114 1717
universe@114 1718 COMPACT_RTF = NO
universe@114 1719
universe@208 1720 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
universe@208 1721 # contain hyperlink fields. The RTF file will contain links (just like the HTML
universe@208 1722 # output) instead of page references. This makes the output suitable for online
universe@208 1723 # browsing using Word or some other Word compatible readers that support those
universe@208 1724 # fields.
universe@208 1725 #
universe@208 1726 # Note: WordPad (write) and others do not support links.
universe@208 1727 # The default value is: NO.
universe@208 1728 # This tag requires that the tag GENERATE_RTF is set to YES.
universe@114 1729
universe@114 1730 RTF_HYPERLINKS = NO
universe@114 1731
universe@208 1732 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
universe@208 1733 # file, i.e. a series of assignments. You only have to provide replacements,
universe@208 1734 # missing definitions are set to their default value.
universe@208 1735 #
universe@208 1736 # See also section "Doxygen usage" for information on how to generate the
universe@208 1737 # default style sheet that doxygen normally uses.
universe@208 1738 # This tag requires that the tag GENERATE_RTF is set to YES.
universe@114 1739
universe@114 1740 RTF_STYLESHEET_FILE =
universe@114 1741
universe@208 1742 # Set optional variables used in the generation of an RTF document. Syntax is
universe@208 1743 # similar to doxygen's config file. A template extensions file can be generated
universe@208 1744 # using doxygen -e rtf extensionFile.
universe@208 1745 # This tag requires that the tag GENERATE_RTF is set to YES.
universe@114 1746
universe@114 1747 RTF_EXTENSIONS_FILE =
universe@114 1748
universe@114 1749 #---------------------------------------------------------------------------
universe@208 1750 # Configuration options related to the man page output
universe@114 1751 #---------------------------------------------------------------------------
universe@114 1752
universe@208 1753 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
universe@208 1754 # classes and files.
universe@208 1755 # The default value is: NO.
universe@114 1756
universe@266 1757 GENERATE_MAN = NO
universe@114 1758
universe@208 1759 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
universe@208 1760 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
universe@208 1761 # it. A directory man3 will be created inside the directory specified by
universe@208 1762 # MAN_OUTPUT.
universe@208 1763 # The default directory is: man.
universe@208 1764 # This tag requires that the tag GENERATE_MAN is set to YES.
universe@114 1765
universe@114 1766 MAN_OUTPUT = man
universe@114 1767
universe@208 1768 # The MAN_EXTENSION tag determines the extension that is added to the generated
universe@208 1769 # man pages. In case the manual section does not start with a number, the number
universe@208 1770 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
universe@208 1771 # optional.
universe@208 1772 # The default value is: .3.
universe@208 1773 # This tag requires that the tag GENERATE_MAN is set to YES.
universe@114 1774
universe@114 1775 MAN_EXTENSION = .3
universe@114 1776
universe@208 1777 # The MAN_SUBDIR tag determines the name of the directory created within
universe@208 1778 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
universe@208 1779 # MAN_EXTENSION with the initial . removed.
universe@208 1780 # This tag requires that the tag GENERATE_MAN is set to YES.
universe@208 1781
universe@208 1782 MAN_SUBDIR =
universe@208 1783
universe@208 1784 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
universe@208 1785 # will generate one additional man file for each entity documented in the real
universe@208 1786 # man page(s). These additional files only source the real man page, but without
universe@208 1787 # them the man command would be unable to find the correct page.
universe@208 1788 # The default value is: NO.
universe@208 1789 # This tag requires that the tag GENERATE_MAN is set to YES.
universe@114 1790
universe@114 1791 MAN_LINKS = NO
universe@114 1792
universe@114 1793 #---------------------------------------------------------------------------
universe@208 1794 # Configuration options related to the XML output
universe@114 1795 #---------------------------------------------------------------------------
universe@114 1796
universe@208 1797 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
universe@208 1798 # captures the structure of the code including all documentation.
universe@208 1799 # The default value is: NO.
universe@114 1800
universe@114 1801 GENERATE_XML = NO
universe@114 1802
universe@208 1803 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
universe@208 1804 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
universe@208 1805 # it.
universe@208 1806 # The default directory is: xml.
universe@208 1807 # This tag requires that the tag GENERATE_XML is set to YES.
universe@114 1808
universe@114 1809 XML_OUTPUT = xml
universe@114 1810
universe@208 1811 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
universe@208 1812 # listings (including syntax highlighting and cross-referencing information) to
universe@208 1813 # the XML output. Note that enabling this will significantly increase the size
universe@208 1814 # of the XML output.
universe@208 1815 # The default value is: YES.
universe@208 1816 # This tag requires that the tag GENERATE_XML is set to YES.
universe@114 1817
universe@114 1818 XML_PROGRAMLISTING = YES
universe@114 1819
universe@114 1820 #---------------------------------------------------------------------------
universe@208 1821 # Configuration options related to the DOCBOOK output
universe@114 1822 #---------------------------------------------------------------------------
universe@114 1823
universe@208 1824 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
universe@208 1825 # that can be used to generate PDF.
universe@208 1826 # The default value is: NO.
universe@208 1827
universe@208 1828 GENERATE_DOCBOOK = NO
universe@208 1829
universe@208 1830 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
universe@208 1831 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
universe@208 1832 # front of it.
universe@208 1833 # The default directory is: docbook.
universe@208 1834 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
universe@208 1835
universe@208 1836 DOCBOOK_OUTPUT = docbook
universe@208 1837
universe@208 1838 #---------------------------------------------------------------------------
universe@208 1839 # Configuration options for the AutoGen Definitions output
universe@208 1840 #---------------------------------------------------------------------------
universe@208 1841
universe@208 1842 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
universe@208 1843 # Definitions (see http://autogen.sf.net) file that captures the structure of
universe@208 1844 # the code including all documentation. Note that this feature is still
universe@208 1845 # experimental and incomplete at the moment.
universe@208 1846 # The default value is: NO.
universe@114 1847
universe@114 1848 GENERATE_AUTOGEN_DEF = NO
universe@114 1849
universe@114 1850 #---------------------------------------------------------------------------
universe@208 1851 # Configuration options related to the Perl module output
universe@114 1852 #---------------------------------------------------------------------------
universe@114 1853
universe@208 1854 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
universe@208 1855 # file that captures the structure of the code including all documentation.
universe@208 1856 #
universe@208 1857 # Note that this feature is still experimental and incomplete at the moment.
universe@208 1858 # The default value is: NO.
universe@114 1859
universe@114 1860 GENERATE_PERLMOD = NO
universe@114 1861
universe@208 1862 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
universe@208 1863 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
universe@208 1864 # output from the Perl module output.
universe@208 1865 # The default value is: NO.
universe@208 1866 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
universe@114 1867
universe@114 1868 PERLMOD_LATEX = NO
universe@114 1869
universe@208 1870 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
universe@208 1871 # formatted so it can be parsed by a human reader. This is useful if you want to
universe@208 1872 # understand what is going on. On the other hand, if this tag is set to NO the
universe@208 1873 # size of the Perl module output will be much smaller and Perl will parse it
universe@208 1874 # just the same.
universe@208 1875 # The default value is: YES.
universe@208 1876 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
universe@114 1877
universe@114 1878 PERLMOD_PRETTY = YES
universe@114 1879
universe@208 1880 # The names of the make variables in the generated doxyrules.make file are
universe@208 1881 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
universe@208 1882 # so different doxyrules.make files included by the same Makefile don't
universe@208 1883 # overwrite each other's variables.
universe@208 1884 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
universe@114 1885
universe@114 1886 PERLMOD_MAKEVAR_PREFIX =
universe@114 1887
universe@114 1888 #---------------------------------------------------------------------------
universe@114 1889 # Configuration options related to the preprocessor
universe@114 1890 #---------------------------------------------------------------------------
universe@114 1891
universe@208 1892 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
universe@208 1893 # C-preprocessor directives found in the sources and include files.
universe@208 1894 # The default value is: YES.
universe@114 1895
universe@114 1896 ENABLE_PREPROCESSING = YES
universe@114 1897
universe@208 1898 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
universe@208 1899 # in the source code. If set to NO only conditional compilation will be
universe@208 1900 # performed. Macro expansion can be done in a controlled way by setting
universe@208 1901 # EXPAND_ONLY_PREDEF to YES.
universe@208 1902 # The default value is: NO.
universe@208 1903 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
universe@114 1904
universe@114 1905 MACRO_EXPANSION = NO
universe@114 1906
universe@208 1907 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
universe@208 1908 # the macro expansion is limited to the macros specified with the PREDEFINED and
universe@208 1909 # EXPAND_AS_DEFINED tags.
universe@208 1910 # The default value is: NO.
universe@208 1911 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
universe@114 1912
universe@114 1913 EXPAND_ONLY_PREDEF = NO
universe@114 1914
universe@208 1915 # If the SEARCH_INCLUDES tag is set to YES the includes files in the
universe@208 1916 # INCLUDE_PATH will be searched if a #include is found.
universe@208 1917 # The default value is: YES.
universe@208 1918 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
universe@114 1919
universe@114 1920 SEARCH_INCLUDES = YES
universe@114 1921
universe@114 1922 # The INCLUDE_PATH tag can be used to specify one or more directories that
universe@208 1923 # contain include files that are not input files but should be processed by the
universe@208 1924 # preprocessor.
universe@208 1925 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
universe@114 1926
universe@114 1927 INCLUDE_PATH =
universe@114 1928
universe@114 1929 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
universe@114 1930 # patterns (like *.h and *.hpp) to filter out the header-files in the
universe@208 1931 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
universe@208 1932 # used.
universe@208 1933 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
universe@114 1934
universe@114 1935 INCLUDE_FILE_PATTERNS =
universe@114 1936
universe@208 1937 # The PREDEFINED tag can be used to specify one or more macro names that are
universe@208 1938 # defined before the preprocessor is started (similar to the -D option of e.g.
universe@208 1939 # gcc). The argument of the tag is a list of macros of the form: name or
universe@208 1940 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
universe@208 1941 # is assumed. To prevent a macro definition from being undefined via #undef or
universe@208 1942 # recursively expanded use the := operator instead of the = operator.
universe@208 1943 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
universe@114 1944
universe@114 1945 PREDEFINED =
universe@114 1946
universe@208 1947 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
universe@208 1948 # tag can be used to specify a list of macro names that should be expanded. The
universe@208 1949 # macro definition that is found in the sources will be used. Use the PREDEFINED
universe@208 1950 # tag if you want to use a different macro definition that overrules the
universe@208 1951 # definition found in the source code.
universe@208 1952 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
universe@114 1953
universe@114 1954 EXPAND_AS_DEFINED =
universe@114 1955
universe@208 1956 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
universe@208 1957 # remove all references to function-like macros that are alone on a line, have
universe@208 1958 # an all uppercase name, and do not end with a semicolon. Such function macros
universe@208 1959 # are typically used for boiler-plate code, and will confuse the parser if not
universe@208 1960 # removed.
universe@208 1961 # The default value is: YES.
universe@208 1962 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
universe@114 1963
universe@114 1964 SKIP_FUNCTION_MACROS = YES
universe@114 1965
universe@114 1966 #---------------------------------------------------------------------------
universe@208 1967 # Configuration options related to external references
universe@114 1968 #---------------------------------------------------------------------------
universe@114 1969
universe@208 1970 # The TAGFILES tag can be used to specify one or more tag files. For each tag
universe@208 1971 # file the location of the external documentation should be added. The format of
universe@208 1972 # a tag file without this location is as follows:
universe@114 1973 # TAGFILES = file1 file2 ...
universe@114 1974 # Adding location for the tag files is done as follows:
universe@114 1975 # TAGFILES = file1=loc1 "file2 = loc2" ...
universe@208 1976 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
universe@208 1977 # section "Linking to external documentation" for more information about the use
universe@208 1978 # of tag files.
universe@208 1979 # Note: Each tag file must have a unique name (where the name does NOT include
universe@208 1980 # the path). If a tag file is not located in the directory in which doxygen is
universe@208 1981 # run, you must also specify the path to the tagfile here.
universe@114 1982
universe@114 1983 TAGFILES =
universe@114 1984
universe@208 1985 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
universe@208 1986 # tag file that is based on the input files it reads. See section "Linking to
universe@208 1987 # external documentation" for more information about the usage of tag files.
universe@114 1988
universe@114 1989 GENERATE_TAGFILE =
universe@114 1990
universe@208 1991 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
universe@208 1992 # class index. If set to NO only the inherited external classes will be listed.
universe@208 1993 # The default value is: NO.
universe@114 1994
universe@114 1995 ALLEXTERNALS = NO
universe@114 1996
universe@208 1997 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
universe@208 1998 # the modules index. If set to NO, only the current project's groups will be
universe@208 1999 # listed.
universe@208 2000 # The default value is: YES.
universe@208 2001
universe@208 2002 EXTERNAL_GROUPS = YES
universe@208 2003
universe@208 2004 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
universe@208 2005 # the related pages index. If set to NO, only the current project's pages will
universe@114 2006 # be listed.
universe@208 2007 # The default value is: YES.
universe@208 2008
universe@208 2009 EXTERNAL_PAGES = YES
universe@114 2010
universe@114 2011 # The PERL_PATH should be the absolute path and name of the perl script
universe@208 2012 # interpreter (i.e. the result of 'which perl').
universe@208 2013 # The default file (with absolute path) is: /usr/bin/perl.
universe@114 2014
universe@114 2015 PERL_PATH = /usr/bin/perl
universe@114 2016
universe@114 2017 #---------------------------------------------------------------------------
universe@114 2018 # Configuration options related to the dot tool
universe@114 2019 #---------------------------------------------------------------------------
universe@114 2020
universe@208 2021 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
universe@208 2022 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
universe@208 2023 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
universe@208 2024 # disabled, but it is recommended to install and use dot, since it yields more
universe@208 2025 # powerful graphs.
universe@208 2026 # The default value is: YES.
universe@114 2027
universe@114 2028 CLASS_DIAGRAMS = YES
universe@114 2029
universe@114 2030 # You can define message sequence charts within doxygen comments using the \msc
universe@208 2031 # command. Doxygen will then run the mscgen tool (see:
universe@208 2032 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
universe@114 2033 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
universe@114 2034 # the mscgen tool resides. If left empty the tool is assumed to be found in the
universe@114 2035 # default search path.
universe@114 2036
universe@114 2037 MSCGEN_PATH =
universe@114 2038
universe@208 2039 # You can include diagrams made with dia in doxygen documentation. Doxygen will
universe@208 2040 # then run dia to produce the diagram and insert it in the documentation. The
universe@208 2041 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
universe@208 2042 # If left empty dia is assumed to be found in the default search path.
universe@208 2043
universe@208 2044 DIA_PATH =
universe@208 2045
universe@208 2046 # If set to YES, the inheritance and collaboration graphs will hide inheritance
universe@208 2047 # and usage relations if the target is undocumented or is not a class.
universe@208 2048 # The default value is: YES.
universe@114 2049
universe@114 2050 HIDE_UNDOC_RELATIONS = YES
universe@114 2051
universe@114 2052 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
universe@208 2053 # available from the path. This tool is part of Graphviz (see:
universe@208 2054 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
universe@208 2055 # Bell Labs. The other options in this section have no effect if this option is
universe@208 2056 # set to NO
universe@208 2057 # The default value is: YES.
universe@114 2058
universe@114 2059 HAVE_DOT = NO
universe@114 2060
universe@208 2061 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
universe@208 2062 # to run in parallel. When set to 0 doxygen will base this on the number of
universe@208 2063 # processors available in the system. You can set it explicitly to a value
universe@208 2064 # larger than 0 to get control over the balance between CPU load and processing
universe@208 2065 # speed.
universe@208 2066 # Minimum value: 0, maximum value: 32, default value: 0.
universe@208 2067 # This tag requires that the tag HAVE_DOT is set to YES.
universe@114 2068
universe@114 2069 DOT_NUM_THREADS = 0
universe@114 2070
universe@208 2071 # When you want a differently looking font n the dot files that doxygen
universe@208 2072 # generates you can specify the font name using DOT_FONTNAME. You need to make
universe@208 2073 # sure dot is able to find the font, which can be done by putting it in a
universe@208 2074 # standard location or by setting the DOTFONTPATH environment variable or by
universe@208 2075 # setting DOT_FONTPATH to the directory containing the font.
universe@208 2076 # The default value is: Helvetica.
universe@208 2077 # This tag requires that the tag HAVE_DOT is set to YES.
universe@114 2078
universe@114 2079 DOT_FONTNAME = Helvetica
universe@114 2080
universe@208 2081 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
universe@208 2082 # dot graphs.
universe@208 2083 # Minimum value: 4, maximum value: 24, default value: 10.
universe@208 2084 # This tag requires that the tag HAVE_DOT is set to YES.
universe@114 2085
universe@114 2086 DOT_FONTSIZE = 10
universe@114 2087
universe@208 2088 # By default doxygen will tell dot to use the default font as specified with
universe@208 2089 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
universe@208 2090 # the path where dot can find it using this tag.
universe@208 2091 # This tag requires that the tag HAVE_DOT is set to YES.
universe@114 2092
universe@114 2093 DOT_FONTPATH =
universe@114 2094
universe@208 2095 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
universe@208 2096 # each documented class showing the direct and indirect inheritance relations.
universe@208 2097 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
universe@208 2098 # The default value is: YES.
universe@208 2099 # This tag requires that the tag HAVE_DOT is set to YES.
universe@114 2100
universe@114 2101 CLASS_GRAPH = YES
universe@114 2102
universe@208 2103 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
universe@208 2104 # graph for each documented class showing the direct and indirect implementation
universe@208 2105 # dependencies (inheritance, containment, and class references variables) of the
universe@208 2106 # class with other documented classes.
universe@208 2107 # The default value is: YES.
universe@208 2108 # This tag requires that the tag HAVE_DOT is set to YES.
universe@114 2109
universe@114 2110 COLLABORATION_GRAPH = YES
universe@114 2111
universe@208 2112 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
universe@208 2113 # groups, showing the direct groups dependencies.
universe@208 2114 # The default value is: YES.
universe@208 2115 # This tag requires that the tag HAVE_DOT is set to YES.
universe@114 2116
universe@114 2117 GROUP_GRAPHS = YES
universe@114 2118
universe@114 2119 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
universe@114 2120 # collaboration diagrams in a style similar to the OMG's Unified Modeling
universe@114 2121 # Language.
universe@208 2122 # The default value is: NO.
universe@208 2123 # This tag requires that the tag HAVE_DOT is set to YES.
universe@114 2124
universe@114 2125 UML_LOOK = NO
universe@114 2126
universe@208 2127 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
universe@208 2128 # class node. If there are many fields or methods and many nodes the graph may
universe@208 2129 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
universe@208 2130 # number of items for each type to make the size more manageable. Set this to 0
universe@208 2131 # for no limit. Note that the threshold may be exceeded by 50% before the limit
universe@208 2132 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
universe@208 2133 # but if the number exceeds 15, the total amount of fields shown is limited to
universe@208 2134 # 10.
universe@208 2135 # Minimum value: 0, maximum value: 100, default value: 10.
universe@208 2136 # This tag requires that the tag HAVE_DOT is set to YES.
universe@208 2137
universe@208 2138 UML_LIMIT_NUM_FIELDS = 10
universe@208 2139
universe@208 2140 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
universe@208 2141 # collaboration graphs will show the relations between templates and their
universe@208 2142 # instances.
universe@208 2143 # The default value is: NO.
universe@208 2144 # This tag requires that the tag HAVE_DOT is set to YES.
universe@114 2145
universe@114 2146 TEMPLATE_RELATIONS = NO
universe@114 2147
universe@208 2148 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
universe@208 2149 # YES then doxygen will generate a graph for each documented file showing the
universe@208 2150 # direct and indirect include dependencies of the file with other documented
universe@208 2151 # files.
universe@208 2152 # The default value is: YES.
universe@208 2153 # This tag requires that the tag HAVE_DOT is set to YES.
universe@114 2154
universe@114 2155 INCLUDE_GRAPH = YES
universe@114 2156
universe@208 2157 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
universe@208 2158 # set to YES then doxygen will generate a graph for each documented file showing
universe@208 2159 # the direct and indirect include dependencies of the file with other documented
universe@208 2160 # files.
universe@208 2161 # The default value is: YES.
universe@208 2162 # This tag requires that the tag HAVE_DOT is set to YES.
universe@114 2163
universe@114 2164 INCLUDED_BY_GRAPH = YES
universe@114 2165
universe@208 2166 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
universe@208 2167 # dependency graph for every global function or class method.
universe@208 2168 #
universe@208 2169 # Note that enabling this option will significantly increase the time of a run.
universe@208 2170 # So in most cases it will be better to enable call graphs for selected
universe@208 2171 # functions only using the \callgraph command.
universe@208 2172 # The default value is: NO.
universe@208 2173 # This tag requires that the tag HAVE_DOT is set to YES.
universe@114 2174
universe@114 2175 CALL_GRAPH = NO
universe@114 2176
universe@208 2177 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
universe@208 2178 # dependency graph for every global function or class method.
universe@208 2179 #
universe@208 2180 # Note that enabling this option will significantly increase the time of a run.
universe@208 2181 # So in most cases it will be better to enable caller graphs for selected
universe@208 2182 # functions only using the \callergraph command.
universe@208 2183 # The default value is: NO.
universe@208 2184 # This tag requires that the tag HAVE_DOT is set to YES.
universe@114 2185
universe@114 2186 CALLER_GRAPH = NO
universe@114 2187
universe@208 2188 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
universe@208 2189 # hierarchy of all classes instead of a textual one.
universe@208 2190 # The default value is: YES.
universe@208 2191 # This tag requires that the tag HAVE_DOT is set to YES.
universe@114 2192
universe@114 2193 GRAPHICAL_HIERARCHY = YES
universe@114 2194
universe@208 2195 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
universe@208 2196 # dependencies a directory has on other directories in a graphical way. The
universe@208 2197 # dependency relations are determined by the #include relations between the
universe@208 2198 # files in the directories.
universe@208 2199 # The default value is: YES.
universe@208 2200 # This tag requires that the tag HAVE_DOT is set to YES.
universe@114 2201
universe@114 2202 DIRECTORY_GRAPH = YES
universe@114 2203
universe@114 2204 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
universe@208 2205 # generated by dot.
universe@208 2206 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
universe@208 2207 # to make the SVG files visible in IE 9+ (other browsers do not have this
universe@208 2208 # requirement).
universe@208 2209 # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
universe@208 2210 # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
universe@208 2211 # gif:cairo:gd, gif:gd, gif:gd:gd and svg.
universe@208 2212 # The default value is: png.
universe@208 2213 # This tag requires that the tag HAVE_DOT is set to YES.
universe@114 2214
universe@114 2215 DOT_IMAGE_FORMAT = png
universe@114 2216
universe@114 2217 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
universe@114 2218 # enable generation of interactive SVG images that allow zooming and panning.
universe@208 2219 #
universe@208 2220 # Note that this requires a modern browser other than Internet Explorer. Tested
universe@208 2221 # and working are Firefox, Chrome, Safari, and Opera.
universe@208 2222 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
universe@208 2223 # the SVG files visible. Older versions of IE do not have SVG support.
universe@208 2224 # The default value is: NO.
universe@208 2225 # This tag requires that the tag HAVE_DOT is set to YES.
universe@114 2226
universe@114 2227 INTERACTIVE_SVG = NO
universe@114 2228
universe@208 2229 # The DOT_PATH tag can be used to specify the path where the dot tool can be
universe@114 2230 # found. If left blank, it is assumed the dot tool can be found in the path.
universe@208 2231 # This tag requires that the tag HAVE_DOT is set to YES.
universe@114 2232
universe@114 2233 DOT_PATH =
universe@114 2234
universe@114 2235 # The DOTFILE_DIRS tag can be used to specify one or more directories that
universe@208 2236 # contain dot files that are included in the documentation (see the \dotfile
universe@208 2237 # command).
universe@208 2238 # This tag requires that the tag HAVE_DOT is set to YES.
universe@114 2239
universe@114 2240 DOTFILE_DIRS =
universe@114 2241
universe@114 2242 # The MSCFILE_DIRS tag can be used to specify one or more directories that
universe@208 2243 # contain msc files that are included in the documentation (see the \mscfile
universe@208 2244 # command).
universe@114 2245
universe@114 2246 MSCFILE_DIRS =
universe@114 2247
universe@208 2248 # The DIAFILE_DIRS tag can be used to specify one or more directories that
universe@208 2249 # contain dia files that are included in the documentation (see the \diafile
universe@208 2250 # command).
universe@208 2251
universe@208 2252 DIAFILE_DIRS =
universe@208 2253
universe@208 2254 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
universe@208 2255 # that will be shown in the graph. If the number of nodes in a graph becomes
universe@208 2256 # larger than this value, doxygen will truncate the graph, which is visualized
universe@208 2257 # by representing a node as a red box. Note that doxygen if the number of direct
universe@208 2258 # children of the root node in a graph is already larger than
universe@208 2259 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
universe@208 2260 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
universe@208 2261 # Minimum value: 0, maximum value: 10000, default value: 50.
universe@208 2262 # This tag requires that the tag HAVE_DOT is set to YES.
universe@114 2263
universe@114 2264 DOT_GRAPH_MAX_NODES = 50
universe@114 2265
universe@208 2266 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
universe@208 2267 # generated by dot. A depth value of 3 means that only nodes reachable from the
universe@208 2268 # root by following a path via at most 3 edges will be shown. Nodes that lay
universe@208 2269 # further from the root node will be omitted. Note that setting this option to 1
universe@208 2270 # or 2 may greatly reduce the computation time needed for large code bases. Also
universe@208 2271 # note that the size of a graph can be further restricted by
universe@114 2272 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
universe@208 2273 # Minimum value: 0, maximum value: 1000, default value: 0.
universe@208 2274 # This tag requires that the tag HAVE_DOT is set to YES.
universe@114 2275
universe@114 2276 MAX_DOT_GRAPH_DEPTH = 0
universe@114 2277
universe@114 2278 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
universe@208 2279 # background. This is disabled by default, because dot on Windows does not seem
universe@208 2280 # to support this out of the box.
universe@208 2281 #
universe@208 2282 # Warning: Depending on the platform used, enabling this option may lead to
universe@208 2283 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
universe@208 2284 # read).
universe@208 2285 # The default value is: NO.
universe@208 2286 # This tag requires that the tag HAVE_DOT is set to YES.
universe@114 2287
universe@114 2288 DOT_TRANSPARENT = NO
universe@114 2289
universe@114 2290 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
universe@114 2291 # files in one run (i.e. multiple -o and -T options on the command line). This
universe@208 2292 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
universe@208 2293 # this, this feature is disabled by default.
universe@208 2294 # The default value is: NO.
universe@208 2295 # This tag requires that the tag HAVE_DOT is set to YES.
universe@114 2296
universe@114 2297 DOT_MULTI_TARGETS = YES
universe@114 2298
universe@208 2299 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
universe@208 2300 # explaining the meaning of the various boxes and arrows in the dot generated
universe@208 2301 # graphs.
universe@208 2302 # The default value is: YES.
universe@208 2303 # This tag requires that the tag HAVE_DOT is set to YES.
universe@114 2304
universe@114 2305 GENERATE_LEGEND = YES
universe@114 2306
universe@208 2307 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
universe@208 2308 # files that are used to generate the various graphs.
universe@208 2309 # The default value is: YES.
universe@208 2310 # This tag requires that the tag HAVE_DOT is set to YES.
universe@114 2311
universe@114 2312 DOT_CLEANUP = YES

mercurial