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