# Alpine3D Svn Source Tree

## Root/trunk/alpine3d/config.dox

 1 # Doxyfile 1.8.7␊ 2 ␊ 3 # This file describes the settings to be used by the documentation system␊ 4 # doxygen (www.doxygen.org) for a project.␊ 5 #␊ 6 # All text after a double hash (##) is considered a comment and is placed in␊ 7 # front of the TAG it is preceding.␊ 8 #␊ 9 # All text after a single hash (#) is considered a comment and will be ignored.␊ 10 # The format is:␊ 11 # TAG = value [value, ...]␊ 12 # For lists, items can also be appended using:␊ 13 # TAG += value [value, ...]␊ 14 # Values that contain spaces should be placed between quotes (\" \").␊ 15 ␊ 16 #---------------------------------------------------------------------------␊ 17 # Project related configuration options␊ 18 #---------------------------------------------------------------------------␊ 19 ␊ 20 # This tag specifies the encoding used for all characters in the config file␊ 21 # that follow. The default is UTF-8 which is also the encoding used for all text␊ 22 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv␊ 23 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv␊ 24 # for the list of possible encodings.␊ 25 # The default value is: UTF-8.␊ 26 ␊ 27 DOXYFILE_ENCODING = UTF-8␊ 28 ␊ 29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by␊ 30 # double-quotes, unless you are using Doxywizard) that should identify the␊ 31 # project for which the documentation is generated. This name is used in the␊ 32 # title of most generated pages and in a few other places.␊ 33 # The default value is: My Project.␊ 34 ␊ 35 PROJECT_NAME = Alpine3D␊ 36 ␊ 37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This␊ 38 # could be handy for archiving the generated documentation or if some version␊ 39 # control system is used.␊ 40 ␊ 41 PROJECT_NUMBER = Alpine3D-3.2.0␊ 42 ␊ 43 # Using the PROJECT_BRIEF tag one can provide an optional one line description␊ 44 # for a project that appears at the top of each page and should give viewer a␊ 45 # quick idea about the purpose of the project. Keep the description short.␊ 46 ␊ 47 PROJECT_BRIEF =␊ 48 ␊ 49 # With the PROJECT_LOGO tag one can specify an logo or icon that is included in␊ 50 # the documentation. The maximum height of the logo should not exceed 55 pixels␊ 51 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo␊ 52 # to the output directory.␊ 53 ␊ 54 PROJECT_LOGO =␊ 55 ␊ 56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path␊ 57 # into which the generated documentation will be written. If a relative path is␊ 58 # entered, it will be relative to the location where doxygen was started. If␊ 59 # left blank the current directory will be used.␊ 60 ␊ 61 OUTPUT_DIRECTORY = ./doc␊ 62 ␊ 63 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-␊ 64 # directories (in 2 levels) under the output directory of each output format and␊ 65 # will distribute the generated files over these directories. Enabling this␊ 66 # option can be useful when feeding doxygen a huge amount of source files, where␊ 67 # putting all generated files in the same directory would otherwise causes␊ 68 # performance problems for the file system.␊ 69 # The default value is: NO.␊ 70 ␊ 71 CREATE_SUBDIRS = NO␊ 72 ␊ 73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII␊ 74 # characters to appear in the names of generated files. If set to NO, non-ASCII␊ 75 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode␊ 76 # U+3044.␊ 77 # The default value is: NO.␊ 78 ␊ 79 ALLOW_UNICODE_NAMES = NO␊ 80 ␊ 81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all␊ 82 # documentation generated by doxygen is written. Doxygen will use this␊ 83 # information to generate all constant output in the proper language.␊ 84 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,␊ 85 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),␊ 86 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,␊ 87 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),␊ 88 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,␊ 89 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,␊ 90 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,␊ 91 # Ukrainian and Vietnamese.␊ 92 # The default value is: English.␊ 93 ␊ 94 OUTPUT_LANGUAGE = English␊ 95 ␊ 96 # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member␊ 97 # descriptions after the members that are listed in the file and class␊ 98 # documentation (similar to Javadoc). Set to NO to disable this.␊ 99 # The default value is: YES.␊ 100 ␊ 101 BRIEF_MEMBER_DESC = YES␊ 102 ␊ 103 # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief␊ 104 # description of a member or function before the detailed description␊ 105 #␊ 106 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the␊ 107 # brief descriptions will be completely suppressed.␊ 108 # The default value is: YES.␊ 109 ␊ 110 REPEAT_BRIEF = YES␊ 111 ␊ 112 # This tag implements a quasi-intelligent brief description abbreviator that is␊ 113 # used to form the text in various listings. Each string in this list, if found␊ 114 # as the leading text of the brief description, will be stripped from the text␊ 115 # and the result, after processing the whole list, is used as the annotated␊ 116 # text. Otherwise, the brief description is used as-is. If left blank, the␊ 117 # following values are used ($name is automatically replaced with the name of␊ 118 # the entity):The$name class, The $name widget, The$name file, is, provides,␊ 119 # specifies, contains, represents, a, an and the.␊ 120 ␊ 121 ABBREVIATE_BRIEF =␊ 122 ␊ 123 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then␊ 124 # doxygen will generate a detailed section even if there is only a brief␊ 125 # description.␊ 126 # The default value is: NO.␊ 127 ␊ 128 ALWAYS_DETAILED_SEC = NO␊ 129 ␊ 130 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all␊ 131 # inherited members of a class in the documentation of that class as if those␊ 132 # members were ordinary class members. Constructors, destructors and assignment␊ 133 # operators of the base classes will not be shown.␊ 134 # The default value is: NO.␊ 135 ␊ 136 INLINE_INHERITED_MEMB = NO␊ 137 ␊ 138 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path␊ 139 # before files name in the file list and in the header files. If set to NO the␊ 140 # shortest path that makes the file name unique will be used␊ 141 # The default value is: YES.␊ 142 ␊ 143 FULL_PATH_NAMES = NO␊ 144 ␊ 145 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.␊ 146 # Stripping is only done if one of the specified strings matches the left-hand␊ 147 # part of the path. The tag can be used to show relative paths in the file list.␊ 148 # If left blank the directory from which doxygen is run is used as the path to␊ 149 # strip.␊ 150 #␊ 151 # Note that you can specify absolute paths here, but also relative paths, which␊ 152 # will be relative from the directory where doxygen is started.␊ 153 # This tag requires that the tag FULL_PATH_NAMES is set to YES.␊ 154 ␊ 155 STRIP_FROM_PATH =␊ 156 ␊ 157 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the␊ 158 # path mentioned in the documentation of a class, which tells the reader which␊ 159 # header file to include in order to use a class. If left blank only the name of␊ 160 # the header file containing the class definition is used. Otherwise one should␊ 161 # specify the list of include paths that are normally passed to the compiler␊ 162 # using the -I flag.␊ 163 ␊ 164 STRIP_FROM_INC_PATH =␊ 165 ␊ 166 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but␊ 167 # less readable) file names. This can be useful is your file systems doesn't␊ 168 # support long names like on DOS, Mac, or CD-ROM.␊ 169 # The default value is: NO.␊ 170 ␊ 171 SHORT_NAMES = NO␊ 172 ␊ 173 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the␊ 174 # first line (until the first dot) of a Javadoc-style comment as the brief␊ 175 # description. If set to NO, the Javadoc-style will behave just like regular Qt-␊ 176 # style comments (thus requiring an explicit @brief command for a brief␊ 177 # description.)␊ 178 # The default value is: NO.␊ 179 ␊ 180 JAVADOC_AUTOBRIEF = NO␊ 181 ␊ 182 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first␊ 183 # line (until the first dot) of a Qt-style comment as the brief description. If␊ 184 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus␊ 185 # requiring an explicit \brief command for a brief description.)␊ 186 # The default value is: NO.␊ 187 ␊ 188 QT_AUTOBRIEF = NO␊ 189 ␊ 190 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a␊ 191 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as␊ 192 # a brief description. This used to be the default behavior. The new default is␊ 193 # to treat a multi-line C++ comment block as a detailed description. Set this␊ 194 # tag to YES if you prefer the old behavior instead.␊ 195 #␊ 196 # Note that setting this tag to YES also means that rational rose comments are␊ 197 # not recognized any more.␊ 198 # The default value is: NO.␊ 199 ␊ 200 MULTILINE_CPP_IS_BRIEF = NO␊ 201 ␊ 202 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the␊ 203 # documentation from any documented member that it re-implements.␊ 204 # The default value is: YES.␊ 205 ␊ 206 INHERIT_DOCS = YES␊ 207 ␊ 208 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a␊ 209 # new page for each member. If set to NO, the documentation of a member will be␊ 210 # part of the file/class/namespace that contains it.␊ 211 # The default value is: NO.␊ 212 ␊ 213 SEPARATE_MEMBER_PAGES = NO␊ 214 ␊ 215 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen␊ 216 # uses this value to replace tabs by spaces in code fragments.␊ 217 # Minimum value: 1, maximum value: 16, default value: 4.␊ 218 ␊ 219 TAB_SIZE = 8␊ 220 ␊ 221 # This tag can be used to specify a number of aliases that act as commands in␊ 222 # the documentation. An alias has the form:␊ 223 # name=value␊ 224 # For example adding␊ 225 # "sideeffect=@par Side Effects:\n"␊ 226 # will allow you to put the command \sideeffect (or @sideeffect) in the␊ 227 # documentation, which will result in a user-defined paragraph with heading␊ 228 # "Side Effects:". You can put \n's in the value part of an alias to insert␊ 229 # newlines.␊ 230 ␊ 231 ALIASES =␊ 232 ␊ 233 # This tag can be used to specify a number of word-keyword mappings (TCL only).␊ 234 # A mapping has the form "name=value". For example adding "class=itcl::class"␊ 235 # will allow you to use the command class in the itcl::class meaning.␊ 236 ␊ 237 TCL_SUBST =␊ 238 ␊ 239 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources␊ 240 # only. Doxygen will then generate output that is more tailored for C. For␊ 241 # instance, some of the names that are used will be different. The list of all␊ 242 # members will be omitted, etc.␊ 243 # The default value is: NO.␊ 244 ␊ 245 OPTIMIZE_OUTPUT_FOR_C = NO␊ 246 ␊ 247 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or␊ 248 # Python sources only. Doxygen will then generate output that is more tailored␊ 249 # for that language. For instance, namespaces will be presented as packages,␊ 250 # qualified scopes will look different, etc.␊ 251 # The default value is: NO.␊ 252 ␊ 253 OPTIMIZE_OUTPUT_JAVA = NO␊ 254 ␊ 255 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran␊ 256 # sources. Doxygen will then generate output that is tailored for Fortran.␊ 257 # The default value is: NO.␊ 258 ␊ 259 OPTIMIZE_FOR_FORTRAN = NO␊ 260 ␊ 261 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL␊ 262 # sources. Doxygen will then generate output that is tailored for VHDL.␊ 263 # The default value is: NO.␊ 264 ␊ 265 OPTIMIZE_OUTPUT_VHDL = NO␊ 266 ␊ 267 # Doxygen selects the parser to use depending on the extension of the files it␊ 268 # parses. With this tag you can assign which parser to use for a given␊ 269 # extension. Doxygen has a built-in mapping, but you can override or extend it␊ 270 # using this tag. The format is ext=language, where ext is a file extension, and␊ 271 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,␊ 272 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:␊ 273 # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:␊ 274 # Fortran. In the later case the parser tries to guess whether the code is fixed␊ 275 # or free formatted code, this is the default for Fortran type files), VHDL. For␊ 276 # instance to make doxygen treat .inc files as Fortran files (default is PHP),␊ 277 # and .f files as C (default is Fortran), use: inc=Fortran f=C.␊ 278 #␊ 279 # Note For files without extension you can use no_extension as a placeholder.␊ 280 #␊ 281 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise␊ 282 # the files are not read by doxygen.␊ 283 ␊ 284 EXTENSION_MAPPING =␊ 285 ␊ 286 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments␊ 287 # according to the Markdown format, which allows for more readable␊ 288 # documentation. See http://daringfireball.net/projects/markdown/ for details.␊ 289 # The output of markdown processing is further processed by doxygen, so you can␊ 290 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in␊ 291 # case of backward compatibilities issues.␊ 292 # The default value is: YES.␊ 293 ␊ 294 MARKDOWN_SUPPORT = YES␊ 295 ␊ 296 # When enabled doxygen tries to link words that correspond to documented␊ 297 # classes, or namespaces to their corresponding documentation. Such a link can␊ 298 # be prevented in individual cases by by putting a % sign in front of the word␊ 299 # or globally by setting AUTOLINK_SUPPORT to NO.␊ 300 # The default value is: YES.␊ 301 ␊ 302 AUTOLINK_SUPPORT = YES␊ 303 ␊ 304 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want␊ 305 # to include (a tag file for) the STL sources as input, then you should set this␊ 306 # tag to YES in order to let doxygen match functions declarations and␊ 307 # definitions whose arguments contain STL classes (e.g. func(std::string);␊ 308 # versus func(std::string) {}). This also make the inheritance and collaboration␊ 309 # diagrams that involve STL classes more complete and accurate.␊ 310 # The default value is: NO.␊ 311 ␊ 312 BUILTIN_STL_SUPPORT = YES␊ 313 ␊ 314 # If you use Microsoft's C++/CLI language, you should set this option to YES to␊ 315 # enable parsing support.␊ 316 # The default value is: NO.␊ 317 ␊ 318 CPP_CLI_SUPPORT = NO␊ 319 ␊ 320 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:␊ 321 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen␊ 322 # will parse them like normal C++ but will assume all classes use public instead␊ 323 # of private inheritance when no explicit protection keyword is present.␊ 324 # The default value is: NO.␊ 325 ␊ 326 SIP_SUPPORT = NO␊ 327 ␊ 328 # For Microsoft's IDL there are propget and propput attributes to indicate␊ 329 # getter and setter methods for a property. Setting this option to YES will make␊ 330 # doxygen to replace the get and set methods by a property in the documentation.␊ 331 # This will only work if the methods are indeed getting or setting a simple␊ 332 # type. If this is not the case, or you want to show the methods anyway, you␊ 333 # should set this option to NO.␊ 334 # The default value is: YES.␊ 335 ␊ 336 IDL_PROPERTY_SUPPORT = NO␊ 337 ␊ 338 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC␊ 339 # tag is set to YES, then doxygen will reuse the documentation of the first␊ 340 # member in the group (if any) for the other members of the group. By default␊ 341 # all members of a group must be documented explicitly.␊ 342 # The default value is: NO.␊ 343 ␊ 344 DISTRIBUTE_GROUP_DOC = NO␊ 345 ␊ 346 # Set the SUBGROUPING tag to YES to allow class member groups of the same type␊ 347 # (for instance a group of public functions) to be put as a subgroup of that␊ 348 # type (e.g. under the Public Functions section). Set it to NO to prevent␊ 349 # subgrouping. Alternatively, this can be done per class using the␊ 350 # \nosubgrouping command.␊ 351 # The default value is: YES.␊ 352 ␊ 353 SUBGROUPING = YES␊ 354 ␊ 355 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions␊ 356 # are shown inside the group in which they are included (e.g. using \ingroup)␊ 357 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX␊ 358 # and RTF).␊ 359 #␊ 360 # Note that this feature does not work in combination with␊ 361 # SEPARATE_MEMBER_PAGES.␊ 362 # The default value is: NO.␊ 363 ␊ 364 INLINE_GROUPED_CLASSES = NO␊ 365 ␊ 366 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions␊ 367 # with only public data fields or simple typedef fields will be shown inline in␊ 368 # the documentation of the scope in which they are defined (i.e. file,␊ 369 # namespace, or group documentation), provided this scope is documented. If set␊ 370 # to NO, structs, classes, and unions are shown on a separate page (for HTML and␊ 371 # Man pages) or section (for LaTeX and RTF).␊ 372 # The default value is: NO.␊ 373 ␊ 374 INLINE_SIMPLE_STRUCTS = NO␊ 375 ␊ 376 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or␊ 377 # enum is documented as struct, union, or enum with the name of the typedef. So␊ 378 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct␊ 379 # with name TypeT. When disabled the typedef will appear as a member of a file,␊ 380 # namespace, or class. And the struct will be named TypeS. This can typically be␊ 381 # useful for C code in case the coding convention dictates that all compound␊ 382 # types are typedef'ed and only the typedef is referenced, never the tag name.␊ 383 # The default value is: NO.␊ 384 ␊ 385 TYPEDEF_HIDES_STRUCT = YES␊ 386 ␊ 387 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This␊ 388 # cache is used to resolve symbols given their name and scope. Since this can be␊ 389 # an expensive process and often the same symbol appears multiple times in the␊ 390 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small␊ 391 # doxygen will become slower. If the cache is too large, memory is wasted. The␊ 392 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range␊ 393 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536␊ 394 # symbols. At the end of a run doxygen will report the cache usage and suggest␊ 395 # the optimal cache size from a speed point of view.␊ 396 # Minimum value: 0, maximum value: 9, default value: 0.␊ 397 ␊ 398 LOOKUP_CACHE_SIZE = 0␊ 399 ␊ 400 #---------------------------------------------------------------------------␊ 401 # Build related configuration options␊ 402 #---------------------------------------------------------------------------␊ 403 ␊ 404 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in␊ 405 # documentation are documented, even if no documentation was available. Private␊ 406 # class members and static file members will be hidden unless the␊ 407 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.␊ 408 # Note: This will also disable the warnings about undocumented members that are␊ 409 # normally produced when WARNINGS is set to YES.␊ 410 # The default value is: NO.␊ 411 ␊ 412 EXTRACT_ALL = YES␊ 413 ␊ 414 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will␊ 415 # be included in the documentation.␊ 416 # The default value is: NO.␊ 417 ␊ 418 EXTRACT_PRIVATE = NO␊ 419 ␊ 420 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal␊ 421 # scope will be included in the documentation.␊ 422 # The default value is: NO.␊ 423 ␊ 424 EXTRACT_PACKAGE = NO␊ 425 ␊ 426 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be␊ 427 # included in the documentation.␊ 428 # The default value is: NO.␊ 429 ␊ 430 EXTRACT_STATIC = YES␊ 431 ␊ 432 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined␊ 433 # locally in source files will be included in the documentation. If set to NO␊ 434 # only classes defined in header files are included. Does not have any effect␊ 435 # for Java sources.␊ 436 # The default value is: YES.␊ 437 ␊ 438 EXTRACT_LOCAL_CLASSES = YES␊ 439 ␊ 440 # This flag is only useful for Objective-C code. When set to YES local methods,␊ 441 # which are defined in the implementation section but not in the interface are␊ 442 # included in the documentation. If set to NO only methods in the interface are␊ 443 # included.␊ 444 # The default value is: NO.␊ 445 ␊ 446 EXTRACT_LOCAL_METHODS = NO␊ 447 ␊ 448 # If this flag is set to YES, the members of anonymous namespaces will be␊ 449 # extracted and appear in the documentation as a namespace called␊ 450 # 'anonymous_namespace{file}', where file will be replaced with the base name of␊ 451 # the file that contains the anonymous namespace. By default anonymous namespace␊ 452 # are hidden.␊ 453 # The default value is: NO.␊ 454 ␊ 455 EXTRACT_ANON_NSPACES = NO␊ 456 ␊ 457 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all␊ 458 # undocumented members inside documented classes or files. If set to NO these␊ 459 # members will be included in the various overviews, but no documentation␊ 460 # section is generated. This option has no effect if EXTRACT_ALL is enabled.␊ 461 # The default value is: NO.␊ 462 ␊ 463 HIDE_UNDOC_MEMBERS = NO␊ 464 ␊ 465 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all␊ 466 # undocumented classes that are normally visible in the class hierarchy. If set␊ 467 # to NO these classes will be included in the various overviews. This option has␊ 468 # no effect if EXTRACT_ALL is enabled.␊ 469 # The default value is: NO.␊ 470 ␊ 471 HIDE_UNDOC_CLASSES = NO␊ 472 ␊ 473 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend␊ 474 # (class|struct|union) declarations. If set to NO these declarations will be␊ 475 # included in the documentation.␊ 476 # The default value is: NO.␊ 477 ␊ 478 HIDE_FRIEND_COMPOUNDS = NO␊ 479 ␊ 480 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any␊ 481 # documentation blocks found inside the body of a function. If set to NO these␊ 482 # blocks will be appended to the function's detailed documentation block.␊ 483 # The default value is: NO.␊ 484 ␊ 485 HIDE_IN_BODY_DOCS = NO␊ 486 ␊ 487 # The INTERNAL_DOCS tag determines if documentation that is typed after a␊ 488 # \internal command is included. If the tag is set to NO then the documentation␊ 489 # will be excluded. Set it to YES to include the internal documentation.␊ 490 # The default value is: NO.␊ 491 ␊ 492 INTERNAL_DOCS = NO␊ 493 ␊ 494 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file␊ 495 # names in lower-case letters. If set to YES upper-case letters are also␊ 496 # allowed. This is useful if you have classes or files whose names only differ␊ 497 # in case and if your file system supports case sensitive file names. Windows␊ 498 # and Mac users are advised to set this option to NO.␊ 499 # The default value is: system dependent.␊ 500 ␊ 501 CASE_SENSE_NAMES = YES␊ 502 ␊ 503 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with␊ 504 # their full class and namespace scopes in the documentation. If set to YES the␊ 505 # scope will be hidden.␊ 506 # The default value is: NO.␊ 507 ␊ 508 HIDE_SCOPE_NAMES = NO␊ 509 ␊ 510 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of␊ 511 # the files that are included by a file in the documentation of that file.␊ 512 # The default value is: YES.␊ 513 ␊ 514 SHOW_INCLUDE_FILES = YES␊ 515 ␊ 516 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each␊ 517 # grouped member an include statement to the documentation, telling the reader␊ 518 # which file to include in order to use the member.␊ 519 # The default value is: NO.␊ 520 ␊ 521 SHOW_GROUPED_MEMB_INC = NO␊ 522 ␊ 523 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include␊ 524 # files with double quotes in the documentation rather than with sharp brackets.␊ 525 # The default value is: NO.␊ 526 ␊ 527 FORCE_LOCAL_INCLUDES = NO␊ 528 ␊ 529 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the␊ 530 # documentation for inline members.␊ 531 # The default value is: YES.␊ 532 ␊ 533 INLINE_INFO = YES␊ 534 ␊ 535 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the␊ 536 # (detailed) documentation of file and class members alphabetically by member␊ 537 # name. If set to NO the members will appear in declaration order.␊ 538 # The default value is: YES.␊ 539 ␊ 540 SORT_MEMBER_DOCS = YES␊ 541 ␊ 542 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief␊ 543 # descriptions of file, namespace and class members alphabetically by member␊ 544 # name. If set to NO the members will appear in declaration order. Note that␊ 545 # this will also influence the order of the classes in the class list.␊ 546 # The default value is: NO.␊ 547 ␊ 548 SORT_BRIEF_DOCS = NO␊ 549 ␊ 550 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the␊ 551 # (brief and detailed) documentation of class members so that constructors and␊ 552 # destructors are listed first. If set to NO the constructors will appear in the␊ 553 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.␊ 554 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief␊ 555 # member documentation.␊ 556 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting␊ 557 # detailed member documentation.␊ 558 # The default value is: NO.␊ 559 ␊ 560 SORT_MEMBERS_CTORS_1ST = YES␊ 561 ␊ 562 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy␊ 563 # of group names into alphabetical order. If set to NO the group names will␊ 564 # appear in their defined order.␊ 565 # The default value is: NO.␊ 566 ␊ 567 SORT_GROUP_NAMES = YES␊ 568 ␊ 569 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by␊ 570 # fully-qualified names, including namespaces. If set to NO, the class list will␊ 571 # be sorted only by class name, not including the namespace part.␊ 572 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.␊ 573 # Note: This option applies only to the class list, not to the alphabetical␊ 574 # list.␊ 575 # The default value is: NO.␊ 576 ␊ 577 SORT_BY_SCOPE_NAME = NO␊ 578 ␊ 579 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper␊ 580 # type resolution of all parameters of a function it will reject a match between␊ 581 # the prototype and the implementation of a member function even if there is␊ 582 # only one candidate or it is obvious which candidate to choose by doing a␊ 583 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still␊ 584 # accept a match between prototype and implementation in such cases.␊ 585 # The default value is: NO.␊ 586 ␊ 587 STRICT_PROTO_MATCHING = NO␊ 588 ␊ 589 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the␊ 590 # todo list. This list is created by putting \todo commands in the␊ 591 # documentation.␊ 592 # The default value is: YES.␊ 593 ␊ 594 GENERATE_TODOLIST = NO␊ 595 ␊ 596 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the␊ 597 # test list. This list is created by putting \test commands in the␊ 598 # documentation.␊ 599 # The default value is: YES.␊ 600 ␊ 601 GENERATE_TESTLIST = NO␊ 602 ␊ 603 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug␊ 604 # list. This list is created by putting \bug commands in the documentation.␊ 605 # The default value is: YES.␊ 606 ␊ 607 GENERATE_BUGLIST = NO␊ 608 ␊ 609 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)␊ 610 # the deprecated list. This list is created by putting \deprecated commands in␊ 611 # the documentation.␊ 612 # The default value is: YES.␊ 613 ␊ 614 GENERATE_DEPRECATEDLIST= YES␊ 615 ␊ 616 # The ENABLED_SECTIONS tag can be used to enable conditional documentation␊ 617 # sections, marked by \if ... \endif and \cond ␊ 618 # ... \endcond blocks.␊ 619 ␊ 620 ENABLED_SECTIONS =␊ 621 ␊ 622 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the␊ 623 # initial value of a variable or macro / define can have for it to appear in the␊ 624 # documentation. If the initializer consists of more lines than specified here␊ 625 # it will be hidden. Use a value of 0 to hide initializers completely. The␊ 626 # appearance of the value of individual variables and macros / defines can be␊ 627 # controlled using \showinitializer or \hideinitializer command in the␊ 628 # documentation regardless of this setting.␊ 629 # Minimum value: 0, maximum value: 10000, default value: 30.␊ 630 ␊ 631 MAX_INITIALIZER_LINES = 30␊ 632 ␊ 633 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at␊ 634 # the bottom of the documentation of classes and structs. If set to YES the list␊ 635 # will mention the files that were used to generate the documentation.␊ 636 # The default value is: YES.␊ 637 ␊ 638 SHOW_USED_FILES = YES␊ 639 ␊ 640 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This␊ 641 # will remove the Files entry from the Quick Index and from the Folder Tree View␊ 642 # (if specified).␊ 643 # The default value is: YES.␊ 644 ␊ 645 SHOW_FILES = YES␊ 646 ␊ 647 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces␊ 648 # page. This will remove the Namespaces entry from the Quick Index and from the␊ 649 # Folder Tree View (if specified).␊ 650 # The default value is: YES.␊ 651 ␊ 652 SHOW_NAMESPACES = YES␊ 653 ␊ 654 # The FILE_VERSION_FILTER tag can be used to specify a program or script that␊ 655 # doxygen should invoke to get the current version for each file (typically from␊ 656 # the version control system). Doxygen will invoke the program by executing (via␊ 657 # popen()) the command command input-file, where command is the value of the␊ 658 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided␊ 659 # by doxygen. Whatever the program writes to standard output is used as the file␊ 660 # version. For an example see the documentation.␊ 661 ␊ 662 FILE_VERSION_FILTER =␊ 663 ␊ 664 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed␊ 665 # by doxygen. The layout file controls the global structure of the generated␊ 666 # output files in an output format independent way. To create the layout file␊ 667 # that represents doxygen's defaults, run doxygen with the -l option. You can␊ 668 # optionally specify a file name after the option, if omitted DoxygenLayout.xml␊ 669 # will be used as the name of the layout file.␊ 670 #␊ 671 # Note that if you run doxygen from a directory containing a file called␊ 672 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE␊ 673 # tag is left empty.␊ 674 ␊ 675 LAYOUT_FILE = alpine3d/DoxygenLayout.xml␊ 676 ␊ 677 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing␊ 678 # the reference definitions. This must be a list of .bib files. The .bib␊ 679 # extension is automatically appended if omitted. This requires the bibtex tool␊ 680 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.␊ 681 # For LaTeX the style of the bibliography can be controlled using␊ 682 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the␊ 683 # search path. Do not use file names with spaces, bibtex cannot handle them. See␊ 684 # also \cite for info how to create references.␊ 685 ␊ 686 CITE_BIB_FILES =␊ 687 ␊ 688 #---------------------------------------------------------------------------␊ 689 # Configuration options related to warning and progress messages␊ 690 #---------------------------------------------------------------------------␊ 691 ␊ 692 # The QUIET tag can be used to turn on/off the messages that are generated to␊ 693 # standard output by doxygen. If QUIET is set to YES this implies that the␊ 694 # messages are off.␊ 695 # The default value is: NO.␊ 696 ␊ 697 QUIET = NO␊ 698 ␊ 699 # The WARNINGS tag can be used to turn on/off the warning messages that are␊ 700 # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES␊ 701 # this implies that the warnings are on.␊ 702 #␊ 703 # Tip: Turn warnings on while writing the documentation.␊ 704 # The default value is: YES.␊ 705 ␊ 706 WARNINGS = YES␊ 707 ␊ 708 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate␊ 709 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag␊ 710 # will automatically be disabled.␊ 711 # The default value is: YES.␊ 712 ␊ 713 WARN_IF_UNDOCUMENTED = YES␊ 714 ␊ 715 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for␊ 716 # potential errors in the documentation, such as not documenting some parameters␊ 717 # in a documented function, or documenting parameters that don't exist or using␊ 718 # markup commands wrongly.␊ 719 # The default value is: YES.␊ 720 ␊ 721 WARN_IF_DOC_ERROR = YES␊ 722 ␊ 723 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that␊ 724 # are documented, but have no documentation for their parameters or return␊ 725 # value. If set to NO doxygen will only warn about wrong or incomplete parameter␊ 726 # documentation, but not about the absence of documentation.␊ 727 # The default value is: NO.␊ 728 ␊ 729 WARN_NO_PARAMDOC = YES␊ 730 ␊ 731 # The WARN_FORMAT tag determines the format of the warning messages that doxygen␊ 732 # can produce. The string should contain the $file,$line, and $text tags, which␊ 733 # will be replaced by the file and line number from which the warning originated␊ 734 # and the warning text. Optionally the format may contain$version, which will␊ 735 # be replaced by the version of the file (if it could be obtained via␊ 736 # FILE_VERSION_FILTER)␊ 737 # The default value is: $file:$line: $text.␊ 738 ␊ 739 WARN_FORMAT = "$file:$line:$text"␊ 740 ␊ 741 # The WARN_LOGFILE tag can be used to specify a file to which warning and error␊ 742 # messages should be written. If left blank the output is written to standard␊ 743 # error (stderr).␊ 744 ␊ 745 WARN_LOGFILE =␊ 746 ␊ 747 #---------------------------------------------------------------------------␊ 748 # Configuration options related to the input files␊ 749 #---------------------------------------------------------------------------␊ 750 ␊ 751 # The INPUT tag is used to specify the files and/or directories that contain␊ 752 # documented source files. You may enter file names like myfile.cpp or␊ 753 # directories like /usr/src/myproject. Separate the files or directories with␊ 754 # spaces.␊ 755 # Note: If this tag is empty the current directory is searched.␊ 756 ␊ 757 INPUT = ./alpine3d \␊ 758 ./alpine3d/ebalance \␊ 759 ./alpine3d/runoff \␊ 760 ./alpine3d/runoff/prevah_runoff/Runoff.cc \␊ 761 ./alpine3d/runoff/prevah_runoff/Runoff.h \␊ 762 ./alpine3d/snowdrift␊ 763 ␊ 764 # This tag can be used to specify the character encoding of the source files␊ 765 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses␊ 766 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv␊ 767 # documentation (see: http://www.gnu.org/software/libiconv) for the list of␊ 768 # possible encodings.␊ 769 # The default value is: UTF-8.␊ 770 ␊ 771 INPUT_ENCODING = UTF-8␊ 772 ␊ 773 # If the value of the INPUT tag contains directories, you can use the␊ 774 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and␊ 775 # *.h) to filter out the source-files in the directories. If left blank the␊ 776 # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,␊ 777 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,␊ 778 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,␊ 779 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,␊ 780 # *.qsf, *.as and *.js.␊ 781 ␊ 782 FILE_PATTERNS = *.c \␊ 783 *.h \␊ 784 *.cpp \␊ 785 *.c++ \␊ 786 *.cc␊ 787 ␊ 788 # The RECURSIVE tag can be used to specify whether or not subdirectories should␊ 789 # be searched for input files as well.␊ 790 # The default value is: NO.␊ 791 ␊ 792 RECURSIVE = NO␊ 793 ␊ 794 # The EXCLUDE tag can be used to specify files and/or directories that should be␊ 795 # excluded from the INPUT source files. This way you can easily exclude a␊ 796 # subdirectory from a directory tree whose root is specified with the INPUT tag.␊ 797 #␊ 798 # Note that relative paths are relative to the directory from which doxygen is␊ 799 # run.␊ 800 ␊ 801 EXCLUDE =␊ 802 ␊ 803 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or␊ 804 # directories that are symbolic links (a Unix file system feature) are excluded␊ 805 # from the input.␊ 806 # The default value is: NO.␊ 807 ␊ 808 EXCLUDE_SYMLINKS = NO␊ 809 ␊ 810 # If the value of the INPUT tag contains directories, you can use the␊ 811 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude␊ 812 # certain files from those directories.␊ 813 #␊ 814 # Note that the wildcards are matched against the file with absolute path, so to␊ 815 # exclude all test directories for example use the pattern */test/*␊ 816 ␊ 817 EXCLUDE_PATTERNS = */plugins/*template*␊ 818 ␊ 819 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names␊ 820 # (namespaces, classes, functions, etc.) that should be excluded from the␊ 821 # output. The symbol name can be a fully qualified name, a word, or if the␊ 822 # wildcard * is used, a substring. Examples: ANamespace, AClass,␊ 823 # AClass::ANamespace, ANamespace::*Test␊ 824 #␊ 825 # Note that the wildcards are matched against the file with absolute path, so to␊ 826 # exclude all test directories use the pattern */test/*␊ 827 ␊ 828 EXCLUDE_SYMBOLS =␊ 829 ␊ 830 # The EXAMPLE_PATH tag can be used to specify one or more files or directories␊ 831 # that contain example code fragments that are included (see the \include␊ 832 # command).␊ 833 ␊ 834 EXAMPLE_PATH =␊ 835 ␊ 836 # If the value of the EXAMPLE_PATH tag contains directories, you can use the␊ 837 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and␊ 838 # *.h) to filter out the source-files in the directories. If left blank all␊ 839 # files are included.␊ 840 ␊ 841 EXAMPLE_PATTERNS =␊ 842 ␊ 843 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be␊ 844 # searched for input files to be used with the \include or \dontinclude commands␊ 845 # irrespective of the value of the RECURSIVE tag.␊ 846 # The default value is: NO.␊ 847 ␊ 848 EXAMPLE_RECURSIVE = NO␊ 849 ␊ 850 # The IMAGE_PATH tag can be used to specify one or more files or directories␊ 851 # that contain images that are to be included in the documentation (see the␊ 852 # \image command).␊ 853 ␊ 854 IMAGE_PATH = ./doc/images␊ 855 ␊ 856 # The INPUT_FILTER tag can be used to specify a program that doxygen should␊ 857 # invoke to filter for each input file. Doxygen will invoke the filter program␊ 858 # by executing (via popen()) the command:␊ 859 #␊ 860 # ␊ 861 #␊ 862 # where is the value of the INPUT_FILTER tag, and is the␊ 863 # name of an input file. Doxygen will then use the output that the filter␊ 864 # program writes to standard output. If FILTER_PATTERNS is specified, this tag␊ 865 # will be ignored.␊ 866 #␊ 867 # Note that the filter must not add or remove lines; it is applied before the␊ 868 # code is scanned, but not when the output code is generated. If lines are added␊ 869 # or removed, the anchors will not be placed correctly.␊ 870 ␊ 871 INPUT_FILTER =␊ 872 ␊ 873 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern␊ 874 # basis. Doxygen will compare the file name with each pattern and apply the␊ 875 # filter if there is a match. The filters are a list of the form: pattern=filter␊ 876 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how␊ 877 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the␊ 878 # patterns match the file name, INPUT_FILTER is applied.␊ 879 ␊ 880 FILTER_PATTERNS =␊ 881 ␊ 882 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using␊ 883 # INPUT_FILTER ) will also be used to filter the input files that are used for␊ 884 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).␊ 885 # The default value is: NO.␊ 886 ␊ 887 FILTER_SOURCE_FILES = NO␊ 888 ␊ 889 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file␊ 890 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and␊ 891 # it is also possible to disable source filtering for a specific pattern using␊ 892 # *.ext= (so without naming a filter).␊ 893 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.␊ 894 ␊ 895 FILTER_SOURCE_PATTERNS =␊ 896 ␊ 897 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that␊ 898 # is part of the input, its contents will be placed on the main page␊ 899 # (index.html). This can be useful if you have a project on for instance GitHub␊ 900 # and want to reuse the introduction page also for the doxygen output.␊ 901 ␊ 902 USE_MDFILE_AS_MAINPAGE =␊ 903 ␊ 904 #---------------------------------------------------------------------------␊ 905 # Configuration options related to source browsing␊ 906 #---------------------------------------------------------------------------␊ 907 ␊ 908 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be␊ 909 # generated. Documented entities will be cross-referenced with these sources.␊ 910 #␊ 911 # Note: To get rid of all source code in the generated output, make sure that␊ 912 # also VERBATIM_HEADERS is set to NO.␊ 913 # The default value is: NO.␊ 914 ␊ 915 SOURCE_BROWSER = NO␊ 916 ␊ 917 # Setting the INLINE_SOURCES tag to YES will include the body of functions,␊ 918 # classes and enums directly into the documentation.␊ 919 # The default value is: NO.␊ 920 ␊ 921 INLINE_SOURCES = NO␊ 922 ␊ 923 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any␊ 924 # special comment blocks from generated source code fragments. Normal C, C++ and␊ 925 # Fortran comments will always remain visible.␊ 926 # The default value is: YES.␊ 927 ␊ 928 STRIP_CODE_COMMENTS = YES␊ 929 ␊ 930 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented␊ 931 # function all documented functions referencing it will be listed.␊ 932 # The default value is: NO.␊ 933 ␊ 934 REFERENCED_BY_RELATION = NO␊ 935 ␊ 936 # If the REFERENCES_RELATION tag is set to YES then for each documented function␊ 937 # all documented entities called/used by that function will be listed.␊ 938 # The default value is: NO.␊ 939 ␊ 940 REFERENCES_RELATION = NO␊ 941 ␊ 942 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set␊ 943 # to YES, then the hyperlinks from functions in REFERENCES_RELATION and␊ 944 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will␊ 945 # link to the documentation.␊ 946 # The default value is: YES.␊ 947 ␊ 948 REFERENCES_LINK_SOURCE = YES␊ 949 ␊ 950 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the␊ 951 # source code will show a tooltip with additional information such as prototype,␊ 952 # brief description and links to the definition and documentation. Since this␊ 953 # will make the HTML file larger and loading of large files a bit slower, you␊ 954 # can opt to disable this feature.␊ 955 # The default value is: YES.␊ 956 # This tag requires that the tag SOURCE_BROWSER is set to YES.␊ 957 ␊ 958 SOURCE_TOOLTIPS = YES␊ 959 ␊ 960 # If the USE_HTAGS tag is set to YES then the references to source code will␊ 961 # point to the HTML generated by the htags(1) tool instead of doxygen built-in␊ 962 # source browser. The htags tool is part of GNU's global source tagging system␊ 963 # (see http://www.gnu.org/software/global/global.html). You will need version␊ 964 # 4.8.6 or higher.␊ 965 #␊ 966 # To use it do the following:␊ 967 # - Install the latest version of global␊ 968 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file␊ 969 # - Make sure the INPUT points to the root of the source tree␊ 970 # - Run doxygen as normal␊ 971 #␊ 972 # Doxygen will invoke htags (and that will in turn invoke gtags), so these␊ 973 # tools must be available from the command line (i.e. in the search path).␊ 974 #␊ 975 # The result: instead of the source browser generated by doxygen, the links to␊ 976 # source code will now point to the output of htags.␊ 977 # The default value is: NO.␊ 978 # This tag requires that the tag SOURCE_BROWSER is set to YES.␊ 979 ␊ 980 USE_HTAGS = NO␊ 981 ␊ 982 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a␊ 983 # verbatim copy of the header file for each class for which an include is␊ 984 # specified. Set to NO to disable this.␊ 985 # See also: Section \class.␊ 986 # The default value is: YES.␊ 987 ␊ 988 VERBATIM_HEADERS = YES␊ 989 ␊ 990 #---------------------------------------------------------------------------␊ 991 # Configuration options related to the alphabetical class index␊ 992 #---------------------------------------------------------------------------␊ 993 ␊ 994 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all␊ 995 # compounds will be generated. Enable this if the project contains a lot of␊ 996 # classes, structs, unions or interfaces.␊ 997 # The default value is: YES.␊ 998 ␊ 999 ALPHABETICAL_INDEX = YES␊ 1000 ␊ 1001 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in␊ 1002 # which the alphabetical index list will be split.␊ 1003 # Minimum value: 1, maximum value: 20, default value: 5.␊ 1004 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.␊ 1005 ␊ 1006 COLS_IN_ALPHA_INDEX = 5␊ 1007 ␊ 1008 # In case all classes in a project start with a common prefix, all classes will␊ 1009 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag␊ 1010 # can be used to specify a prefix (or a list of prefixes) that should be ignored␊ 1011 # while generating the index headers.␊ 1012 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.␊ 1013 ␊ 1014 IGNORE_PREFIX =␊ 1015 ␊ 1016 #---------------------------------------------------------------------------␊ 1017 # Configuration options related to the HTML output␊ 1018 #---------------------------------------------------------------------------␊ 1019 ␊ 1020 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output␊ 1021 # The default value is: YES.␊ 1022 ␊ 1023 GENERATE_HTML = YES␊ 1024 ␊ 1025 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a␊ 1026 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of␊ 1027 # it.␊ 1028 # The default directory is: html.␊ 1029 # This tag requires that the tag GENERATE_HTML is set to YES.␊ 1030 ␊ 1031 HTML_OUTPUT = html␊ 1032 ␊ 1033 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each␊ 1034 # generated HTML page (for example: .htm, .php, .asp).␊ 1035 # The default value is: .html.␊ 1036 # This tag requires that the tag GENERATE_HTML is set to YES.␊ 1037 ␊ 1038 HTML_FILE_EXTENSION = .html␊ 1039 ␊ 1040 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for␊ 1041 # each generated HTML page. If the tag is left blank doxygen will generate a␊ 1042 # standard header.␊ 1043 #␊ 1044 # To get valid HTML the header file that includes any scripts and style sheets␊ 1045 # that doxygen needs, which is dependent on the configuration options used (e.g.␊ 1046 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a␊ 1047 # default header using␊ 1048 # doxygen -w html new_header.html new_footer.html new_stylesheet.css␊ 1049 # YourConfigFile␊ 1050 # and then modify the file new_header.html. See also section "Doxygen usage"␊ 1051 # for information on how to generate the default header that doxygen normally␊ 1052 # uses.␊ 1053 # Note: The header is subject to change so you typically have to regenerate the␊ 1054 # default header when upgrading to a newer version of doxygen. For a description␊ 1055 # of the possible markers and block names see the documentation.␊ 1056 # This tag requires that the tag GENERATE_HTML is set to YES.␊ 1057 ␊ 1058 HTML_HEADER =␊ 1059 ␊ 1060 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each␊ 1061 # generated HTML page. If the tag is left blank doxygen will generate a standard␊ 1062 # footer. See HTML_HEADER for more information on how to generate a default␊ 1063 # footer and what special commands can be used inside the footer. See also␊ 1064 # section "Doxygen usage" for information on how to generate the default footer␊ 1065 # that doxygen normally uses.␊ 1066 # This tag requires that the tag GENERATE_HTML is set to YES.␊ 1067 ␊ 1068 HTML_FOOTER =␊ 1069 ␊ 1070 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style␊ 1071 # sheet that is used by each HTML page. It can be used to fine-tune the look of␊ 1072 # the HTML output. If left blank doxygen will generate a default style sheet.␊ 1073 # See also section "Doxygen usage" for information on how to generate the style␊ 1074 # sheet that doxygen normally uses.␊ 1075 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as␊ 1076 # it is more robust and this tag (HTML_STYLESHEET) will in the future become␊ 1077 # obsolete.␊ 1078 # This tag requires that the tag GENERATE_HTML is set to YES.␊ 1079 ␊ 1080 HTML_STYLESHEET =␊ 1081 ␊ 1082 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-␊ 1083 # defined cascading style sheet that is included after the standard style sheets␊ 1084 # created by doxygen. Using this option one can overrule certain style aspects.␊ 1085 # This is preferred over using HTML_STYLESHEET since it does not replace the␊ 1086 # standard style sheet and is therefor more robust against future updates.␊ 1087 # Doxygen will copy the style sheet file to the output directory. For an example␊ 1088 # see the documentation.␊ 1089 # This tag requires that the tag GENERATE_HTML is set to YES.␊ 1090 ␊ 1091 HTML_EXTRA_STYLESHEET =␊ 1092 ␊ 1093 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or␊ 1094 # other source files which should be copied to the HTML output directory. Note␊ 1095 # that these files will be copied to the base HTML output directory. Use the␊ 1096 # \$relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these␊ 1097 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the␊ 1098 # files will be copied as-is; there are no commands or markers available.␊ 1099 # This tag requires that the tag GENERATE_HTML is set to YES.␊ 1100 ␊ 1101 HTML_EXTRA_FILES =␊ 1102 ␊ 1103 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen␊ 1104 # will adjust the colors in the stylesheet and background images according to␊ 1105 # this color. Hue is specified as an angle on a colorwheel, see␊ 1106 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value␊ 1107 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300␊ 1108 # purple, and 360 is red again.␊ 1109 # Minimum value: 0, maximum value: 359, default value: 220.␊ 1110 # This tag requires that the tag GENERATE_HTML is set to YES.␊ 1111 ␊ 1112 HTML_COLORSTYLE_HUE = 220␊ 1113 ␊ 1114 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors␊ 1115 # in the HTML output. For a value of 0 the output will use grayscales only. A␊ 1116 # value of 255 will produce the most vivid colors.␊ 1117 # Minimum value: 0, maximum value: 255, default value: 100.␊ 1118 # This tag requires that the tag GENERATE_HTML is set to YES.␊ 1119 ␊ 1120 HTML_COLORSTYLE_SAT = 100␊ 1121 ␊ 1122 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the␊ 1123 # luminance component of the colors in the HTML output. Values below 100␊ 1124 # gradually make the output lighter, whereas values above 100 make the output␊ 1125 # darker. The value divided by 100 is the actual gamma applied, so 80 represents␊ 1126 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not␊ 1127 # change the gamma.␊ 1128 # Minimum value: 40, maximum value: 240, default value: 80.␊ 1129 # This tag requires that the tag GENERATE_HTML is set to YES.␊ 1130 ␊ 1131 HTML_COLORSTYLE_GAMMA = 80␊ 1132 ␊ 1133 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML␊ 1134 # page will contain the date and time when the page was generated. Setting this␊ 1135 # to NO can help when comparing the output of multiple runs.␊ 1136 # The default value is: YES.␊ 1137 # This tag requires that the tag GENERATE_HTML is set to YES.␊ 1138 ␊ 1139 HTML_TIMESTAMP = YES␊ 1140 ␊ 1141 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML␊ 1142 # documentation will contain sections that can be hidden and shown after the␊ 1143 # page has loaded.␊ 1144 # The default value is: NO.␊ 1145 # This tag requires that the tag GENERATE_HTML is set to YES.␊ 1146 ␊ 1147 HTML_DYNAMIC_SECTIONS = YES␊ 1148 ␊ 1149 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries␊ 1150 # shown in the various tree structured indices initially; the user can expand␊ 1151 # and collapse entries dynamically later on. Doxygen will expand the tree to␊ 1152 # such a level that at most the specified number of entries are visible (unless␊ 1153 # a fully collapsed tree already exceeds this amount). So setting the number of␊ 1154 # entries 1 will produce a full collapsed tree by default. 0 is a special value␊ 1155 # representing an infinite number of entries and will result in a full expanded␊ 1156 # tree by default.␊ 1157 # Minimum value: 0, maximum value: 9999, default value: 100.␊ 1158 # This tag requires that the tag GENERATE_HTML is set to YES.␊ 1159 ␊ 1160 HTML_INDEX_NUM_ENTRIES = 100␊ 1161 ␊ 1162 # If the GENERATE_DOCSET tag is set to YES, additional index files will be␊ 1163 # generated that can be used as input for Apple's Xcode 3 integrated development␊ 1164 # environment (see: http://developer.apple.com/tools/xcode/), introduced with␊ 1165 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a␊ 1166 # Makefile in the HTML output directory. Running make will produce the docset in␊ 1167 # that directory and running make install will install the docset in␊ 1168 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at␊ 1169 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html␊ 1170 # for more information.␊ 1171 # The default value is: NO.␊ 1172 # This tag requires that the tag GENERATE_HTML is set to YES.␊ 1173 ␊ 1174 GENERATE_DOCSET = NO␊ 1175 ␊ 1176 # This tag determines the name of the docset feed. A documentation feed provides␊ 1177 # an umbrella under which multiple documentation sets from a single provider␊ 1178 # (such as a company or product suite) can be grouped.␊ 1179 # The default value is: Doxygen generated docs.␊ 1180 # This tag requires that the tag GENERATE_DOCSET is set to YES.␊ 1181 ␊ 1182 DOCSET_FEEDNAME = "Doxygen generated docs"␊ 1183 ␊ 1184 # This tag specifies a string that should uniquely identify the documentation␊ 1185 # set bundle. This should be a reverse domain-name style string, e.g.␊ 1186 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.␊ 1187 # The default value is: org.doxygen.Project.␊ 1188 # This tag requires that the tag GENERATE_DOCSET is set to YES.␊ 1189 ␊ 1190 DOCSET_BUNDLE_ID = org.doxygen.Project␊ 1191 ␊ 1192 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify␊ 1193 # the documentation publisher. This should be a reverse domain-name style␊ 1194 # string, e.g. com.mycompany.MyDocSet.documentation.␊ 1195 # The default value is: org.doxygen.Publisher.␊ 1196 # This tag requires that the tag GENERATE_DOCSET is set to YES.␊ 1197 ␊ 1198 DOCSET_PUBLISHER_ID = org.doxygen.Publisher␊ 1199 ␊ 1200 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.␊ 1201 # The default value is: Publisher.␊ 1202 # This tag requires that the tag GENERATE_DOCSET is set to YES.␊ 1203 ␊ 1204 DOCSET_PUBLISHER_NAME = Publisher␊ 1205 ␊ 1206 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three␊ 1207 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The␊ 1208 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop␊ 1209 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on␊ 1210 # Windows.␊ 1211 #␊ 1212 # The HTML Help Workshop contains a compiler that can convert all HTML output␊ 1213 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML␊ 1214 # files are now used as the Windows 98 help format, and will replace the old␊ 1215 # Windows help format (.hlp) on all Windows platforms in the future. Compressed␊ 1216 # HTML files also contain an index, a table of contents, and you can search for␊ 1217 # words in the documentation. The HTML workshop also contains a viewer for␊ 1218 # compressed HTML files.␊ 1219 # The default value is: NO.␊ 1220 # This tag requires that the tag GENERATE_HTML is set to YES.␊ 1221 ␊ 1222 GENERATE_HTMLHELP = NO␊ 1223 ␊ 1224 # The CHM_FILE tag can be used to specify the file name of the resulting .chm␊ 1225 # file. You can add a path in front of the file if the result should not be␊ 1226 # written to the html output directory.␊ 1227 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.␊ 1228 ␊ 1229 CHM_FILE =␊ 1230 ␊ 1231 # The HHC_LOCATION tag can be used to specify the location (absolute path␊ 1232 # including file name) of the HTML help compiler ( hhc.exe). If non-empty␊ 1233 # doxygen will try to run the HTML help compiler on the generated index.hhp.␊ 1234 # The file has to be specified with full path.␊ 1235 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.␊ 1236 ␊ 1237 HHC_LOCATION =␊ 1238 ␊ 1239 # The GENERATE_CHI flag controls if a separate .chi index file is generated (␊ 1240 # YES) or that it should be included in the master .chm file ( NO).␊ 1241 # The default value is: NO.␊ 1242 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.␊ 1243 ␊ 1244 GENERATE_CHI = NO␊ 1245 ␊ 1246 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)␊ 1247 # and project file content.␊ 1248 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.␊ 1249 ␊ 1250 CHM_INDEX_ENCODING =␊ 1251 ␊ 1252 # The BINARY_TOC flag controls whether a binary table of contents is generated (␊ 1253 # YES) or a normal table of contents ( NO) in the .chm file. Furthermore it␊ 1254 # enables the Previous and Next buttons.␊ 1255 # The default value is: NO.␊ 1256 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.␊ 1257 ␊ 1258 BINARY_TOC = NO␊ 1259 ␊ 1260 # The TOC_EXPAND flag can be set to YES to add extra items for group members to␊ 1261 # the table of contents of the HTML help documentation and to the tree view.␊ 1262 # The default value is: NO.␊ 1263 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.␊ 1264 ␊ 1265 TOC_EXPAND = NO␊ 1266 ␊ 1267 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and␊ 1268 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that␊ 1269 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help␊ 1270 # (.qch) of the generated HTML documentation.␊ 1271 # The default value is: NO.␊ 1272 # This tag requires that the tag GENERATE_HTML is set to YES.␊ 1273 ␊ 1274 GENERATE_QHP = NO␊ 1275 ␊ 1276 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify␊ 1277 # the file name of the resulting .qch file. The path specified is relative to␊ 1278 # the HTML output folder.␊ 1279 # This tag requires that the tag GENERATE_QHP is set to YES.␊ 1280 ␊ 1281 QCH_FILE =␊ 1282 ␊ 1283 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help␊ 1284 # Project output. For more information please see Qt Help Project / Namespace␊ 1285 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).␊ 1286 # The default value is: org.doxygen.Project.␊ 1287 # This tag requires that the tag GENERATE_QHP is set to YES.␊ 1288 ␊ 1289 QHP_NAMESPACE = org.doxygen.Project␊ 1290 ␊ 1291 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt␊ 1292 # Help Project output. For more information please see Qt Help Project / Virtual␊ 1293 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-␊ 1294 # folders).␊ 1295 # The default value is: doc.␊ 1296 # This tag requires that the tag GENERATE_QHP is set to YES.␊ 1297 ␊ 1298 QHP_VIRTUAL_FOLDER = doc␊ 1299 ␊ 1300 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom␊ 1301 # filter to add. For more information please see Qt Help Project / Custom␊ 1302 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-␊ 1303 # filters).␊ 1304 # This tag requires that the tag GENERATE_QHP is set to YES.␊ 1305 ␊ 1306 QHP_CUST_FILTER_NAME =␊ 1307 ␊ 1308 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the␊ 1309 # custom filter to add. For more information please see Qt Help Project / Custom␊ 1310 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-␊ 1311 # filters).␊ 1312 # This tag requires that the tag GENERATE_QHP is set to YES.␊ 1313 ␊ 1314 QHP_CUST_FILTER_ATTRS =␊ 1315 ␊ 1316 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this␊ 1317 # project's filter section matches. Qt Help Project / Filter Attributes (see:␊ 1318 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).␊ 1319 # This tag requires that the tag GENERATE_QHP is set to YES.␊ 1320 ␊ 1321 QHP_SECT_FILTER_ATTRS =␊ 1322 ␊ 1323 # The QHG_LOCATION tag can be used to specify the location of Qt's␊ 1324 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the␊ 1325 # generated .qhp file.␊ 1326 # This tag requires that the tag GENERATE_QHP is set to YES.␊ 1327 ␊ 1328 QHG_LOCATION =␊ 1329 ␊ 1330 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be␊ 1331 # generated, together with the HTML files, they form an Eclipse help plugin. To␊ 1332 # install this plugin and make it available under the help contents menu in␊ 1333 # Eclipse, the contents of the directory containing the HTML and XML files needs␊ 1334 # to be copied into the plugins directory of eclipse. The name of the directory␊ 1335 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.␊ 1336 # After copying Eclipse needs to be restarted before the help appears.␊ 1337 # The default value is: NO.␊ 1338 # This tag requires that the tag GENERATE_HTML is set to YES.␊ 1339 ␊ 1340 GENERATE_ECLIPSEHELP = NO␊ 1341 ␊ 1342 # A unique identifier for the Eclipse help plugin. When installing the plugin␊ 1343 # the directory name containing the HTML and XML files should also have this␊ 1344 # name. Each documentation set should have its own identifier.␊ 1345 # The default value is: org.doxygen.Project.␊ 1346 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.␊ 1347 ␊ 1348 ECLIPSE_DOC_ID = org.doxygen.Project␊ 1349 ␊ 1350 # If you want full control over the layout of the generated HTML pages it might␊ 1351 # be necessary to disable the index and replace it with your own. The␊ 1352 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top␊ 1353 # of each HTML page. A value of NO enables the index and the value YES disables␊ 1354 # it. Since the tabs in the index contain the same information as the navigation␊ 1355 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.␊ 1356 # The default value is: NO.␊ 1357 # This tag requires that the tag GENERATE_HTML is set to YES.␊ 1358 ␊ 1359 DISABLE_INDEX = YES␊ 1360 ␊ 1361 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index␊ 1362 # structure should be generated to display hierarchical information. If the tag␊ 1363 # value is set to YES, a side panel will be generated containing a tree-like␊ 1364 # index structure (just like the one that is generated for HTML Help). For this␊ 1365 # to work a browser that supports JavaScript, DHTML, CSS and frames is required␊ 1366 # (i.e. any modern browser). Windows users are probably better off using the␊ 1367 # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can␊ 1368 # further fine-tune the look of the index. As an example, the default style␊ 1369 # sheet generated by doxygen has an example that shows how to put an image at␊ 1370 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has␊ 1371 # the same information as the tab index, you could consider setting␊ 1372 # DISABLE_INDEX to YES when enabling this option.␊ 1373 # The default value is: NO.␊ 1374 # This tag requires that the tag GENERATE_HTML is set to YES.␊ 1375 ␊ 1376 GENERATE_TREEVIEW = YES␊ 1377 ␊ 1378 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that␊ 1379 # doxygen will group on one line in the generated HTML documentation.␊ 1380 #␊ 1381 # Note that a value of 0 will completely suppress the enum values from appearing␊ 1382 # in the overview section.␊ 1383 # Minimum value: 0, maximum value: 20, default value: 4.␊ 1384 # This tag requires that the tag GENERATE_HTML is set to YES.␊ 1385 ␊ 1386 ENUM_VALUES_PER_LINE = 4␊ 1387 ␊ 1388 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used␊ 1389 # to set the initial width (in pixels) of the frame in which the tree is shown.␊ 1390 # Minimum value: 0, maximum value: 1500, default value: 250.␊ 1391 # This tag requires that the tag GENERATE_HTML is set to YES.␊ 1392 ␊ 1393 TREEVIEW_WIDTH = 250␊ 1394 ␊ 1395 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to␊ 1396 # external symbols imported via tag files in a separate window.␊ 1397 # The default value is: NO.␊ 1398 # This tag requires that the tag GENERATE_HTML is set to YES.␊ 1399 ␊ 1400 EXT_LINKS_IN_WINDOW = NO␊ 1401 ␊ 1402 # Use this tag to change the font size of LaTeX formulas included as images in␊ 1403 # the HTML documentation. When you change the font size after a successful␊ 1404 # doxygen run you need to manually remove any form_*.png images from the HTML␊ 1405 # output directory to force them to be regenerated.␊ 1406 # Minimum value: 8, maximum value: 50, default value: 10.␊ 1407 # This tag requires that the tag GENERATE_HTML is set to YES.␊ 1408 ␊ 1409 FORMULA_FONTSIZE = 12␊ 1410 ␊ 1411 # Use the FORMULA_TRANPARENT tag to determine whether or not the images␊ 1412 # generated for formulas are transparent PNGs. Transparent PNGs are not␊ 1413 # supported properly for IE 6.0, but are supported on all modern browsers.␊ 1414 #␊ 1415 # Note that when changing this option you need to delete any form_*.png files in␊ 1416 # the HTML output directory before the changes have effect.␊ 1417 # The default value is: YES.␊ 1418 # This tag requires that the tag GENERATE_HTML is set to YES.␊ 1419 ␊ 1420 FORMULA_TRANSPARENT = YES␊ 1421 ␊ 1422 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see␊ 1423 # http://www.mathjax.org) which uses client side Javascript for the rendering␊ 1424 # instead of using prerendered bitmaps. Use this if you do not have LaTeX␊ 1425 # installed or if you want to formulas look prettier in the HTML output. When␊ 1426 # enabled you may also need to install MathJax separately and configure the path␊ 1427 # to it using the MATHJAX_RELPATH option.␊ 1428 # The default value is: NO.␊ 1429 # This tag requires that the tag GENERATE_HTML is set to YES.␊ 1430 ␊ 1431 USE_MATHJAX = NO␊ 1432 ␊ 1433 # When MathJax is enabled you can set the default output format to be used for␊ 1434 # the MathJax output. See the MathJax site (see:␊ 1435 # http://docs.mathjax.org/en/latest/output.html) for more details.␊ 1436 # Possible values are: HTML-CSS (which is slower, but has the best␊ 1437 # compatibility), NativeMML (i.e. MathML) and SVG.␊ 1438 # The default value is: HTML-CSS.␊ 1439 # This tag requires that the tag USE_MATHJAX is set to YES.␊ 1440 ␊ 1441 MATHJAX_FORMAT = HTML-CSS␊ 1442 ␊ 1443 # When MathJax is enabled you need to specify the location relative to the HTML␊ 1444 # output directory using the MATHJAX_RELPATH option. The destination directory␊ 1445 # should contain the MathJax.js script. For instance, if the mathjax directory␊ 1446 # is located at the same level as the HTML output directory, then␊ 1447 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax␊ 1448 # Content Delivery Network so you can quickly see the result without installing␊ 1449 # MathJax. However, it is strongly recommended to install a local copy of␊ 1450 # MathJax from http://www.mathjax.org before deployment.␊ 1451 # The default value is: http://cdn.mathjax.org/mathjax/latest.␊ 1452 # This tag requires that the tag USE_MATHJAX is set to YES.␊ 1453 ␊ 1454 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest␊ 1455 ␊ 1456 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax␊ 1457 # extension names that should be enabled during MathJax rendering. For example␊ 1458 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols␊ 1459 # This tag requires that the tag USE_MATHJAX is set to YES.␊ 1460 ␊ 1461 MATHJAX_EXTENSIONS =␊ 1462 ␊ 1463 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces␊ 1464 # of code that will be used on startup of the MathJax code. See the MathJax site␊ 1465 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an␊ 1466 # example see the documentation.␊ 1467 # This tag requires that the tag USE_MATHJAX is set to YES.␊ 1468 ␊ 1469 MATHJAX_CODEFILE =␊ 1470 ␊ 1471 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for␊ 1472 # the HTML output. The underlying search engine uses javascript and DHTML and␊ 1473 # should work on any modern browser. Note that when using HTML help␊ 1474 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)␊ 1475 # there is already a search function so this one should typically be disabled.␊ 1476 # For large projects the javascript based search engine can be slow, then␊ 1477 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to␊ 1478 # search using the keyboard; to jump to the search box use + S␊ 1479 # (what the is depends on the OS and browser, but it is typically␊ 1480 # , /