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