diff options
| -rw-r--r-- | doxygen.cfg.in | 841 |
1 files changed, 603 insertions, 238 deletions
diff --git a/doxygen.cfg.in b/doxygen.cfg.in index 4cbbb2d..7bc1160 100644 --- a/doxygen.cfg.in +++ b/doxygen.cfg.in | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | # Doxyfile 1.8.16 | 1 | # Doxyfile 1.11.0 |
| 2 | 2 | ||
| 3 | # This file describes the settings to be used by the documentation system | 3 | # This file describes the settings to be used by the documentation system |
| 4 | # doxygen (www.doxygen.org) for a project. | 4 | # doxygen (www.doxygen.org) for a project. |
| @@ -12,6 +12,16 @@ | |||
| 12 | # For lists, items can also be appended using: | 12 | # For lists, items can also be appended using: |
| 13 | # TAG += value [value, ...] | 13 | # TAG += value [value, ...] |
| 14 | # Values that contain spaces should be placed between quotes (\" \"). | 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] | ||
| 15 | 25 | ||
| 16 | #--------------------------------------------------------------------------- | 26 | #--------------------------------------------------------------------------- |
| 17 | # Project related configuration options | 27 | # Project related configuration options |
| @@ -53,6 +63,12 @@ PROJECT_BRIEF = "API Documentation" | |||
| 53 | 63 | ||
| 54 | PROJECT_LOGO = docs/doxygen/logo-vector-clean.svg | 64 | PROJECT_LOGO = docs/doxygen/logo-vector-clean.svg |
| 55 | 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 | |||
| 56 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path | 72 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path |
| 57 | # into which the generated documentation will be written. If a relative path is | 73 | # into which the generated documentation will be written. If a relative path is |
| 58 | # entered, it will be relative to the location where doxygen was started. If | 74 | # entered, it will be relative to the location where doxygen was started. If |
| @@ -60,16 +76,28 @@ PROJECT_LOGO = docs/doxygen/logo-vector-clean.svg | |||
| 60 | 76 | ||
| 61 | OUTPUT_DIRECTORY = docs | 77 | OUTPUT_DIRECTORY = docs |
| 62 | 78 | ||
| 63 | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- | 79 | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 |
| 64 | # directories (in 2 levels) under the output directory of each output format and | 80 | # sub-directories (in 2 levels) under the output directory of each output format |
| 65 | # will distribute the generated files over these directories. Enabling this | 81 | # and will distribute the generated files over these directories. Enabling this |
| 66 | # option can be useful when feeding doxygen a huge amount of source files, where | 82 | # option can be useful when feeding doxygen a huge amount of source files, where |
| 67 | # putting all generated files in the same directory would otherwise causes | 83 | # putting all generated files in the same directory would otherwise causes |
| 68 | # performance problems for the file system. | 84 | # performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to |
| 85 | # control the number of sub-directories. | ||
| 69 | # The default value is: NO. | 86 | # The default value is: NO. |
| 70 | 87 | ||
| 71 | CREATE_SUBDIRS = NO | 88 | CREATE_SUBDIRS = NO |
| 72 | 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 | |||
| 73 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII | 101 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII |
| 74 | # characters to appear in the names of generated files. If set to NO, non-ASCII | 102 | # characters to appear in the names of generated files. If set to NO, non-ASCII |
| 75 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode | 103 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode |
| @@ -81,14 +109,14 @@ ALLOW_UNICODE_NAMES = NO | |||
| 81 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all | 109 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all |
| 82 | # documentation generated by doxygen is written. Doxygen will use this | 110 | # documentation generated by doxygen is written. Doxygen will use this |
| 83 | # information to generate all constant output in the proper language. | 111 | # information to generate all constant output in the proper language. |
| 84 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, | 112 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, |
| 85 | # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), | 113 | # Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English |
| 86 | # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, | 114 | # (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, |
| 87 | # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), | 115 | # Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with |
| 88 | # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, | 116 | # English messages), Korean, Korean-en (Korean with English messages), Latvian, |
| 89 | # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, | 117 | # Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, |
| 90 | # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, | 118 | # Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, |
| 91 | # Ukrainian and Vietnamese. | 119 | # Swedish, Turkish, Ukrainian and Vietnamese. |
| 92 | # The default value is: English. | 120 | # The default value is: English. |
| 93 | 121 | ||
| 94 | OUTPUT_LANGUAGE = English | 122 | OUTPUT_LANGUAGE = English |
| @@ -209,6 +237,14 @@ QT_AUTOBRIEF = NO | |||
| 209 | 237 | ||
| 210 | MULTILINE_CPP_IS_BRIEF = NO | 238 | MULTILINE_CPP_IS_BRIEF = NO |
| 211 | 239 | ||
| 240 | # By default Python docstrings are displayed as preformatted text and doxygen's | ||
| 241 | # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the | ||
| 242 | # doxygen's special commands can be used and the contents of the docstring | ||
| 243 | # documentation blocks is shown as doxygen documentation. | ||
| 244 | # The default value is: YES. | ||
| 245 | |||
| 246 | PYTHON_DOCSTRING = YES | ||
| 247 | |||
| 212 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the | 248 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the |
| 213 | # documentation from any documented member that it re-implements. | 249 | # documentation from any documented member that it re-implements. |
| 214 | # The default value is: YES. | 250 | # The default value is: YES. |
| @@ -232,16 +268,16 @@ TAB_SIZE = 8 | |||
| 232 | # the documentation. An alias has the form: | 268 | # the documentation. An alias has the form: |
| 233 | # name=value | 269 | # name=value |
| 234 | # For example adding | 270 | # For example adding |
| 235 | # "sideeffect=@par Side Effects:\n" | 271 | # "sideeffect=@par Side Effects:^^" |
| 236 | # will allow you to put the command \sideeffect (or @sideeffect) in the | 272 | # will allow you to put the command \sideeffect (or @sideeffect) in the |
| 237 | # documentation, which will result in a user-defined paragraph with heading | 273 | # documentation, which will result in a user-defined paragraph with heading |
| 238 | # "Side Effects:". You can put \n's in the value part of an alias to insert | 274 | # "Side Effects:". Note that you cannot put \n's in the value part of an alias |
| 239 | # newlines (in the resulting output). You can put ^^ in the value part of an | 275 | # to insert newlines (in the resulting output). You can put ^^ in the value part |
| 240 | # alias to insert a newline as if a physical newline was in the original file. | 276 | # of an alias to insert a newline as if a physical newline was in the original |
| 241 | # When you need a literal { or } or , in the value part of an alias you have to | 277 | # file. When you need a literal { or } or , in the value part of an alias you |
| 242 | # escape them by means of a backslash (\), this can lead to conflicts with the | 278 | # have to escape them by means of a backslash (\), this can lead to conflicts |
| 243 | # commands \{ and \} for these it is advised to use the version @{ and @} or use | 279 | # with the commands \{ and \} for these it is advised to use the version @{ and |
| 244 | # a double escape (\\{ and \\}) | 280 | # @} or use a double escape (\\{ and \\}) |
| 245 | 281 | ||
| 246 | ALIASES = | 282 | ALIASES = |
| 247 | 283 | ||
| @@ -285,19 +321,22 @@ OPTIMIZE_OUTPUT_SLICE = YES | |||
| 285 | # parses. With this tag you can assign which parser to use for a given | 321 | # parses. With this tag you can assign which parser to use for a given |
| 286 | # extension. Doxygen has a built-in mapping, but you can override or extend it | 322 | # extension. Doxygen has a built-in mapping, but you can override or extend it |
| 287 | # using this tag. The format is ext=language, where ext is a file extension, and | 323 | # using this tag. The format is ext=language, where ext is a file extension, and |
| 288 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, | 324 | # language is one of the parsers supported by doxygen: IDL, Java, JavaScript, |
| 289 | # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, | 325 | # Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, |
| 290 | # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: | 326 | # VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: |
| 291 | # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser | 327 | # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser |
| 292 | # tries to guess whether the code is fixed or free formatted code, this is the | 328 | # tries to guess whether the code is fixed or free formatted code, this is the |
| 293 | # default for Fortran type files), VHDL, tcl. For instance to make doxygen treat | 329 | # default for Fortran type files). For instance to make doxygen treat .inc files |
| 294 | # .inc files as Fortran files (default is PHP), and .f files as C (default is | 330 | # as Fortran files (default is PHP), and .f files as C (default is Fortran), |
| 295 | # Fortran), use: inc=Fortran f=C. | 331 | # use: inc=Fortran f=C. |
| 296 | # | 332 | # |
| 297 | # Note: For files without extension you can use no_extension as a placeholder. | 333 | # Note: For files without extension you can use no_extension as a placeholder. |
| 298 | # | 334 | # |
| 299 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise | 335 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise |
| 300 | # the files are not read by doxygen. | 336 | # the files are not read by doxygen. When specifying no_extension you should add |
| 337 | # * to the FILE_PATTERNS. | ||
| 338 | # | ||
| 339 | # Note see also the list of default file extension mappings. | ||
| 301 | 340 | ||
| 302 | EXTENSION_MAPPING = | 341 | EXTENSION_MAPPING = |
| 303 | 342 | ||
| @@ -315,11 +354,22 @@ MARKDOWN_SUPPORT = YES | |||
| 315 | # to that level are automatically included in the table of contents, even if | 354 | # to that level are automatically included in the table of contents, even if |
| 316 | # they do not have an id attribute. | 355 | # they do not have an id attribute. |
| 317 | # Note: This feature currently applies only to Markdown headings. | 356 | # Note: This feature currently applies only to Markdown headings. |
| 318 | # Minimum value: 0, maximum value: 99, default value: 5. | 357 | # Minimum value: 0, maximum value: 99, default value: 6. |
| 319 | # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. | 358 | # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. |
| 320 | 359 | ||
| 321 | TOC_INCLUDE_HEADINGS = 5 | 360 | TOC_INCLUDE_HEADINGS = 5 |
| 322 | 361 | ||
| 362 | # The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to | ||
| 363 | # generate identifiers for the Markdown headings. Note: Every identifier is | ||
| 364 | # unique. | ||
| 365 | # Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a | ||
| 366 | # sequence number starting at 0 and GITHUB use the lower case version of title | ||
| 367 | # with any whitespace replaced by '-' and punctuation characters removed. | ||
| 368 | # The default value is: DOXYGEN. | ||
| 369 | # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. | ||
| 370 | |||
| 371 | MARKDOWN_ID_STYLE = DOXYGEN | ||
| 372 | |||
| 323 | # When enabled doxygen tries to link words that correspond to documented | 373 | # When enabled doxygen tries to link words that correspond to documented |
| 324 | # classes, or namespaces to their corresponding documentation. Such a link can | 374 | # classes, or namespaces to their corresponding documentation. Such a link can |
| 325 | # be prevented in individual cases by putting a % sign in front of the word or | 375 | # be prevented in individual cases by putting a % sign in front of the word or |
| @@ -332,8 +382,8 @@ AUTOLINK_SUPPORT = YES | |||
| 332 | # to include (a tag file for) the STL sources as input, then you should set this | 382 | # to include (a tag file for) the STL sources as input, then you should set this |
| 333 | # tag to YES in order to let doxygen match functions declarations and | 383 | # tag to YES in order to let doxygen match functions declarations and |
| 334 | # definitions whose arguments contain STL classes (e.g. func(std::string); | 384 | # definitions whose arguments contain STL classes (e.g. func(std::string); |
| 335 | # versus func(std::string) {}). This also make the inheritance and collaboration | 385 | # versus func(std::string) {}). This also makes the inheritance and |
| 336 | # diagrams that involve STL classes more complete and accurate. | 386 | # collaboration diagrams that involve STL classes more complete and accurate. |
| 337 | # The default value is: NO. | 387 | # The default value is: NO. |
| 338 | 388 | ||
| 339 | BUILTIN_STL_SUPPORT = NO | 389 | BUILTIN_STL_SUPPORT = NO |
| @@ -345,9 +395,9 @@ BUILTIN_STL_SUPPORT = NO | |||
| 345 | CPP_CLI_SUPPORT = NO | 395 | CPP_CLI_SUPPORT = NO |
| 346 | 396 | ||
| 347 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: | 397 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: |
| 348 | # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen | 398 | # https://www.riverbankcomputing.com/software) sources only. Doxygen will parse |
| 349 | # will parse them like normal C++ but will assume all classes use public instead | 399 | # them like normal C++ but will assume all classes use public instead of private |
| 350 | # of private inheritance when no explicit protection keyword is present. | 400 | # inheritance when no explicit protection keyword is present. |
| 351 | # The default value is: NO. | 401 | # The default value is: NO. |
| 352 | 402 | ||
| 353 | SIP_SUPPORT = NO | 403 | SIP_SUPPORT = NO |
| @@ -431,6 +481,27 @@ TYPEDEF_HIDES_STRUCT = YES | |||
| 431 | 481 | ||
| 432 | LOOKUP_CACHE_SIZE = 0 | 482 | LOOKUP_CACHE_SIZE = 0 |
| 433 | 483 | ||
| 484 | # The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use | ||
| 485 | # during processing. When set to 0 doxygen will based this on the number of | ||
| 486 | # cores available in the system. You can set it explicitly to a value larger | ||
| 487 | # than 0 to get more control over the balance between CPU load and processing | ||
| 488 | # speed. At this moment only the input processing can be done using multiple | ||
| 489 | # threads. Since this is still an experimental feature the default is set to 1, | ||
| 490 | # which effectively disables parallel processing. Please report any issues you | ||
| 491 | # encounter. Generating dot graphs in parallel is controlled by the | ||
| 492 | # DOT_NUM_THREADS setting. | ||
| 493 | # Minimum value: 0, maximum value: 32, default value: 1. | ||
| 494 | |||
| 495 | NUM_PROC_THREADS = 1 | ||
| 496 | |||
| 497 | # If the TIMESTAMP tag is set different from NO then each generated page will | ||
| 498 | # contain the date or date and time when the page was generated. Setting this to | ||
| 499 | # NO can help when comparing the output of multiple runs. | ||
| 500 | # Possible values are: YES, NO, DATETIME and DATE. | ||
| 501 | # The default value is: NO. | ||
| 502 | |||
| 503 | TIMESTAMP = YES | ||
| 504 | |||
| 434 | #--------------------------------------------------------------------------- | 505 | #--------------------------------------------------------------------------- |
| 435 | # Build related configuration options | 506 | # Build related configuration options |
| 436 | #--------------------------------------------------------------------------- | 507 | #--------------------------------------------------------------------------- |
| @@ -494,6 +565,13 @@ EXTRACT_LOCAL_METHODS = NO | |||
| 494 | 565 | ||
| 495 | EXTRACT_ANON_NSPACES = NO | 566 | EXTRACT_ANON_NSPACES = NO |
| 496 | 567 | ||
| 568 | # If this flag is set to YES, the name of an unnamed parameter in a declaration | ||
| 569 | # will be determined by the corresponding definition. By default unnamed | ||
| 570 | # parameters remain unnamed in the output. | ||
| 571 | # The default value is: YES. | ||
| 572 | |||
| 573 | RESOLVE_UNNAMED_PARAMS = YES | ||
| 574 | |||
| 497 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all | 575 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all |
| 498 | # undocumented members inside documented classes or files. If set to NO these | 576 | # undocumented members inside documented classes or files. If set to NO these |
| 499 | # members will be included in the various overviews, but no documentation | 577 | # members will be included in the various overviews, but no documentation |
| @@ -505,14 +583,15 @@ HIDE_UNDOC_MEMBERS = NO | |||
| 505 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all | 583 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all |
| 506 | # undocumented classes that are normally visible in the class hierarchy. If set | 584 | # undocumented classes that are normally visible in the class hierarchy. If set |
| 507 | # to NO, these classes will be included in the various overviews. This option | 585 | # to NO, these classes will be included in the various overviews. This option |
| 508 | # has no effect if EXTRACT_ALL is enabled. | 586 | # will also hide undocumented C++ concepts if enabled. This option has no effect |
| 587 | # if EXTRACT_ALL is enabled. | ||
| 509 | # The default value is: NO. | 588 | # The default value is: NO. |
| 510 | 589 | ||
| 511 | HIDE_UNDOC_CLASSES = NO | 590 | HIDE_UNDOC_CLASSES = NO |
| 512 | 591 | ||
| 513 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend | 592 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend |
| 514 | # (class|struct|union) declarations. If set to NO, these declarations will be | 593 | # declarations. If set to NO, these declarations will be included in the |
| 515 | # included in the documentation. | 594 | # documentation. |
| 516 | # The default value is: NO. | 595 | # The default value is: NO. |
| 517 | 596 | ||
| 518 | HIDE_FRIEND_COMPOUNDS = NO | 597 | HIDE_FRIEND_COMPOUNDS = NO |
| @@ -531,12 +610,20 @@ HIDE_IN_BODY_DOCS = NO | |||
| 531 | 610 | ||
| 532 | INTERNAL_DOCS = NO | 611 | INTERNAL_DOCS = NO |
| 533 | 612 | ||
| 534 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file | 613 | # With the correct setting of option CASE_SENSE_NAMES doxygen will better be |
| 535 | # names in lower-case letters. If set to YES, upper-case letters are also | 614 | # able to match the capabilities of the underlying filesystem. In case the |
| 536 | # allowed. This is useful if you have classes or files whose names only differ | 615 | # filesystem is case sensitive (i.e. it supports files in the same directory |
| 537 | # in case and if your file system supports case sensitive file names. Windows | 616 | # whose names only differ in casing), the option must be set to YES to properly |
| 538 | # (including Cygwin) ands Mac users are advised to set this option to NO. | 617 | # deal with such files in case they appear in the input. For filesystems that |
| 539 | # The default value is: system dependent. | 618 | # are not case sensitive the option should be set to NO to properly deal with |
| 619 | # output files written for symbols that only differ in casing, such as for two | ||
| 620 | # classes, one named CLASS and the other named Class, and to also support | ||
| 621 | # references to files without having to specify the exact matching casing. On | ||
| 622 | # Windows (including Cygwin) and MacOS, users should typically set this option | ||
| 623 | # to NO, whereas on Linux or other Unix flavors it should typically be set to | ||
| 624 | # YES. | ||
| 625 | # Possible values are: SYSTEM, NO and YES. | ||
| 626 | # The default value is: SYSTEM. | ||
| 540 | 627 | ||
| 541 | CASE_SENSE_NAMES = NO | 628 | CASE_SENSE_NAMES = NO |
| 542 | 629 | ||
| @@ -554,6 +641,12 @@ HIDE_SCOPE_NAMES = NO | |||
| 554 | 641 | ||
| 555 | HIDE_COMPOUND_REFERENCE= NO | 642 | HIDE_COMPOUND_REFERENCE= NO |
| 556 | 643 | ||
| 644 | # If the SHOW_HEADERFILE tag is set to YES then the documentation for a class | ||
| 645 | # will show which file needs to be included to use the class. | ||
| 646 | # The default value is: YES. | ||
| 647 | |||
| 648 | SHOW_HEADERFILE = YES | ||
| 649 | |||
| 557 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of | 650 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of |
| 558 | # the files that are included by a file in the documentation of that file. | 651 | # the files that are included by a file in the documentation of that file. |
| 559 | # The default value is: YES. | 652 | # The default value is: YES. |
| @@ -711,7 +804,8 @@ FILE_VERSION_FILTER = | |||
| 711 | # output files in an output format independent way. To create the layout file | 804 | # output files in an output format independent way. To create the layout file |
| 712 | # that represents doxygen's defaults, run doxygen with the -l option. You can | 805 | # that represents doxygen's defaults, run doxygen with the -l option. You can |
| 713 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml | 806 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml |
| 714 | # will be used as the name of the layout file. | 807 | # will be used as the name of the layout file. See also section "Changing the |
| 808 | # layout of pages" for information. | ||
| 715 | # | 809 | # |
| 716 | # Note that if you run doxygen from a directory containing a file called | 810 | # Note that if you run doxygen from a directory containing a file called |
| 717 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE | 811 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE |
| @@ -757,24 +851,50 @@ WARNINGS = YES | |||
| 757 | WARN_IF_UNDOCUMENTED = YES | 851 | WARN_IF_UNDOCUMENTED = YES |
| 758 | 852 | ||
| 759 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for | 853 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for |
| 760 | # potential errors in the documentation, such as not documenting some parameters | 854 | # potential errors in the documentation, such as documenting some parameters in |
| 761 | # in a documented function, or documenting parameters that don't exist or using | 855 | # a documented function twice, or documenting parameters that don't exist or |
| 762 | # markup commands wrongly. | 856 | # using markup commands wrongly. |
| 763 | # The default value is: YES. | 857 | # The default value is: YES. |
| 764 | 858 | ||
| 765 | WARN_IF_DOC_ERROR = YES | 859 | WARN_IF_DOC_ERROR = YES |
| 766 | 860 | ||
| 861 | # If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete | ||
| 862 | # function parameter documentation. If set to NO, doxygen will accept that some | ||
| 863 | # parameters have no documentation without warning. | ||
| 864 | # The default value is: YES. | ||
| 865 | |||
| 866 | WARN_IF_INCOMPLETE_DOC = YES | ||
| 867 | |||
| 767 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that | 868 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that |
| 768 | # are documented, but have no documentation for their parameters or return | 869 | # are documented, but have no documentation for their parameters or return |
| 769 | # value. If set to NO, doxygen will only warn about wrong or incomplete | 870 | # value. If set to NO, doxygen will only warn about wrong parameter |
| 770 | # parameter documentation, but not about the absence of documentation. If | 871 | # documentation, but not about the absence of documentation. If EXTRACT_ALL is |
| 771 | # EXTRACT_ALL is set to YES then this flag will automatically be disabled. | 872 | # set to YES then this flag will automatically be disabled. See also |
| 873 | # WARN_IF_INCOMPLETE_DOC | ||
| 772 | # The default value is: NO. | 874 | # The default value is: NO. |
| 773 | 875 | ||
| 774 | WARN_NO_PARAMDOC = NO | 876 | WARN_NO_PARAMDOC = NO |
| 775 | 877 | ||
| 878 | # If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about | ||
| 879 | # undocumented enumeration values. If set to NO, doxygen will accept | ||
| 880 | # undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag | ||
| 881 | # will automatically be disabled. | ||
| 882 | # The default value is: NO. | ||
| 883 | |||
| 884 | WARN_IF_UNDOC_ENUM_VAL = NO | ||
| 885 | |||
| 776 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when | 886 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when |
| 777 | # a warning is encountered. | 887 | # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS |
| 888 | # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but | ||
| 889 | # at the end of the doxygen process doxygen will return with a non-zero status. | ||
| 890 | # If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves | ||
| 891 | # like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not | ||
| 892 | # write the warning messages in between other messages but write them at the end | ||
| 893 | # of a run, in case a WARN_LOGFILE is defined the warning messages will be | ||
| 894 | # besides being in the defined file also be shown at the end of a run, unless | ||
| 895 | # the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case | ||
| 896 | # the behavior will remain as with the setting FAIL_ON_WARNINGS. | ||
| 897 | # Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. | ||
| 778 | # The default value is: NO. | 898 | # The default value is: NO. |
| 779 | 899 | ||
| 780 | WARN_AS_ERROR = NO | 900 | WARN_AS_ERROR = NO |
| @@ -785,13 +905,27 @@ WARN_AS_ERROR = NO | |||
| 785 | # and the warning text. Optionally the format may contain $version, which will | 905 | # and the warning text. Optionally the format may contain $version, which will |
| 786 | # be replaced by the version of the file (if it could be obtained via | 906 | # be replaced by the version of the file (if it could be obtained via |
| 787 | # FILE_VERSION_FILTER) | 907 | # FILE_VERSION_FILTER) |
| 908 | # See also: WARN_LINE_FORMAT | ||
| 788 | # The default value is: $file:$line: $text. | 909 | # The default value is: $file:$line: $text. |
| 789 | 910 | ||
| 790 | WARN_FORMAT = "$file:$line: $text" | 911 | WARN_FORMAT = "$file:$line: $text" |
| 791 | 912 | ||
| 913 | # In the $text part of the WARN_FORMAT command it is possible that a reference | ||
| 914 | # to a more specific place is given. To make it easier to jump to this place | ||
| 915 | # (outside of doxygen) the user can define a custom "cut" / "paste" string. | ||
| 916 | # Example: | ||
| 917 | # WARN_LINE_FORMAT = "'vi $file +$line'" | ||
| 918 | # See also: WARN_FORMAT | ||
| 919 | # The default value is: at line $line of file $file. | ||
| 920 | |||
| 921 | WARN_LINE_FORMAT = "at line $line of file $file" | ||
| 922 | |||
| 792 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error | 923 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error |
| 793 | # messages should be written. If left blank the output is written to standard | 924 | # messages should be written. If left blank the output is written to standard |
| 794 | # error (stderr). | 925 | # error (stderr). In case the file specified cannot be opened for writing the |
| 926 | # warning and error messages are written to standard error. When as file - is | ||
| 927 | # specified the warning and error messages are written to standard output | ||
| 928 | # (stdout). | ||
| 795 | 929 | ||
| 796 | WARN_LOGFILE = | 930 | WARN_LOGFILE = |
| 797 | 931 | ||
| @@ -805,19 +939,29 @@ WARN_LOGFILE = | |||
| 805 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING | 939 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING |
| 806 | # Note: If this tag is empty the current directory is searched. | 940 | # Note: If this tag is empty the current directory is searched. |
| 807 | 941 | ||
| 808 | INPUT = \ | 942 | INPUT = include/@PACKAGE@ \ |
| 809 | include/@PACKAGE@ \ | 943 | README.md |
| 810 | README.md | ||
| 811 | 944 | ||
| 812 | # This tag can be used to specify the character encoding of the source files | 945 | # This tag can be used to specify the character encoding of the source files |
| 813 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses | 946 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses |
| 814 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv | 947 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv |
| 815 | # documentation (see: https://www.gnu.org/software/libiconv/) for the list of | 948 | # documentation (see: |
| 816 | # possible encodings. | 949 | # https://www.gnu.org/software/libiconv/) for the list of possible encodings. |
| 950 | # See also: INPUT_FILE_ENCODING | ||
| 817 | # The default value is: UTF-8. | 951 | # The default value is: UTF-8. |
| 818 | 952 | ||
| 819 | INPUT_ENCODING = UTF-8 | 953 | INPUT_ENCODING = UTF-8 |
| 820 | 954 | ||
| 955 | # This tag can be used to specify the character encoding of the source files | ||
| 956 | # that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify | ||
| 957 | # character encoding on a per file pattern basis. Doxygen will compare the file | ||
| 958 | # name with each pattern and apply the encoding instead of the default | ||
| 959 | # INPUT_ENCODING) if there is a match. The character encodings are a list of the | ||
| 960 | # form: pattern=encoding (like *.php=ISO-8859-1). | ||
| 961 | # See also: INPUT_ENCODING for further information on supported encodings. | ||
| 962 | |||
| 963 | INPUT_FILE_ENCODING = | ||
| 964 | |||
| 821 | # If the value of the INPUT tag contains directories, you can use the | 965 | # If the value of the INPUT tag contains directories, you can use the |
| 822 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and | 966 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and |
| 823 | # *.h) to filter out the source-files in the directories. | 967 | # *.h) to filter out the source-files in the directories. |
| @@ -826,11 +970,15 @@ INPUT_ENCODING = UTF-8 | |||
| 826 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not | 970 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not |
| 827 | # read by doxygen. | 971 | # read by doxygen. |
| 828 | # | 972 | # |
| 829 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, | 973 | # Note the list of default checked file patterns might differ from the list of |
| 830 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, | 974 | # default file extension mappings. |
| 831 | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, | 975 | # |
| 832 | # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, | 976 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm, |
| 833 | # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. | 977 | # *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, |
| 978 | # *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, | ||
| 979 | # *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to | ||
| 980 | # be provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, | ||
| 981 | # *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. | ||
| 834 | 982 | ||
| 835 | FILE_PATTERNS = | 983 | FILE_PATTERNS = |
| 836 | 984 | ||
| @@ -869,10 +1017,7 @@ EXCLUDE_PATTERNS = | |||
| 869 | # (namespaces, classes, functions, etc.) that should be excluded from the | 1017 | # (namespaces, classes, functions, etc.) that should be excluded from the |
| 870 | # output. The symbol name can be a fully qualified name, a word, or if the | 1018 | # output. The symbol name can be a fully qualified name, a word, or if the |
| 871 | # wildcard * is used, a substring. Examples: ANamespace, AClass, | 1019 | # wildcard * is used, a substring. Examples: ANamespace, AClass, |
| 872 | # AClass::ANamespace, ANamespace::*Test | 1020 | # ANamespace::AClass, ANamespace::*Test |
| 873 | # | ||
| 874 | # Note that the wildcards are matched against the file with absolute path, so to | ||
| 875 | # exclude all test directories use the pattern */test/* | ||
| 876 | 1021 | ||
| 877 | EXCLUDE_SYMBOLS = LIBIMOBILEDEVICE_API | 1022 | EXCLUDE_SYMBOLS = LIBIMOBILEDEVICE_API |
| 878 | 1023 | ||
| @@ -917,6 +1062,11 @@ IMAGE_PATH = | |||
| 917 | # code is scanned, but not when the output code is generated. If lines are added | 1062 | # code is scanned, but not when the output code is generated. If lines are added |
| 918 | # or removed, the anchors will not be placed correctly. | 1063 | # or removed, the anchors will not be placed correctly. |
| 919 | # | 1064 | # |
| 1065 | # Note that doxygen will use the data processed and written to standard output | ||
| 1066 | # for further processing, therefore nothing else, like debug statements or used | ||
| 1067 | # commands (so in case of a Windows batch file always use @echo OFF), should be | ||
| 1068 | # written to standard output. | ||
| 1069 | # | ||
| 920 | # Note that for custom extensions or not directly supported extensions you also | 1070 | # Note that for custom extensions or not directly supported extensions you also |
| 921 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not | 1071 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not |
| 922 | # properly processed by doxygen. | 1072 | # properly processed by doxygen. |
| @@ -958,6 +1108,15 @@ FILTER_SOURCE_PATTERNS = | |||
| 958 | 1108 | ||
| 959 | USE_MDFILE_AS_MAINPAGE = README.md | 1109 | USE_MDFILE_AS_MAINPAGE = README.md |
| 960 | 1110 | ||
| 1111 | # The Fortran standard specifies that for fixed formatted Fortran code all | ||
| 1112 | # characters from position 72 are to be considered as comment. A common | ||
| 1113 | # extension is to allow longer lines before the automatic comment starts. The | ||
| 1114 | # setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can | ||
| 1115 | # be processed before the automatic comment starts. | ||
| 1116 | # Minimum value: 7, maximum value: 10000, default value: 72. | ||
| 1117 | |||
| 1118 | FORTRAN_COMMENT_AFTER = 72 | ||
| 1119 | |||
| 961 | #--------------------------------------------------------------------------- | 1120 | #--------------------------------------------------------------------------- |
| 962 | # Configuration options related to source browsing | 1121 | # Configuration options related to source browsing |
| 963 | #--------------------------------------------------------------------------- | 1122 | #--------------------------------------------------------------------------- |
| @@ -972,7 +1131,8 @@ USE_MDFILE_AS_MAINPAGE = README.md | |||
| 972 | SOURCE_BROWSER = NO | 1131 | SOURCE_BROWSER = NO |
| 973 | 1132 | ||
| 974 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, | 1133 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, |
| 975 | # classes and enums directly into the documentation. | 1134 | # multi-line macros, enums or list initialized variables directly into the |
| 1135 | # documentation. | ||
| 976 | # The default value is: NO. | 1136 | # The default value is: NO. |
| 977 | 1137 | ||
| 978 | INLINE_SOURCES = NO | 1138 | INLINE_SOURCES = NO |
| @@ -1055,10 +1215,11 @@ VERBATIM_HEADERS = NO | |||
| 1055 | 1215 | ||
| 1056 | ALPHABETICAL_INDEX = NO | 1216 | ALPHABETICAL_INDEX = NO |
| 1057 | 1217 | ||
| 1058 | # In case all classes in a project start with a common prefix, all classes will | 1218 | # The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) |
| 1059 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag | 1219 | # that should be ignored while generating the index headers. The IGNORE_PREFIX |
| 1060 | # can be used to specify a prefix (or a list of prefixes) that should be ignored | 1220 | # tag works for classes, function and member names. The entity will be placed in |
| 1061 | # while generating the index headers. | 1221 | # the alphabetical list under the first letter of the entity name that remains |
| 1222 | # after removing the prefix. | ||
| 1062 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. | 1223 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. |
| 1063 | 1224 | ||
| 1064 | IGNORE_PREFIX = | 1225 | IGNORE_PREFIX = |
| @@ -1137,11 +1298,15 @@ HTML_STYLESHEET = | |||
| 1137 | # Doxygen will copy the style sheet files to the output directory. | 1298 | # Doxygen will copy the style sheet files to the output directory. |
| 1138 | # Note: The order of the extra style sheet files is of importance (e.g. the last | 1299 | # Note: The order of the extra style sheet files is of importance (e.g. the last |
| 1139 | # style sheet in the list overrules the setting of the previous ones in the | 1300 | # style sheet in the list overrules the setting of the previous ones in the |
| 1140 | # list). For an example see the documentation. | 1301 | # list). |
| 1302 | # Note: Since the styling of scrollbars can currently not be overruled in | ||
| 1303 | # Webkit/Chromium, the styling will be left out of the default doxygen.css if | ||
| 1304 | # one or more extra stylesheets have been specified. So if scrollbar | ||
| 1305 | # customization is desired it has to be added explicitly. For an example see the | ||
| 1306 | # documentation. | ||
| 1141 | # This tag requires that the tag GENERATE_HTML is set to YES. | 1307 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| 1142 | 1308 | ||
| 1143 | HTML_EXTRA_STYLESHEET = \ | 1309 | HTML_EXTRA_STYLESHEET = docs/doxygen/custom.css |
| 1144 | docs/doxygen/custom.css | ||
| 1145 | 1310 | ||
| 1146 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or | 1311 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or |
| 1147 | # other source files which should be copied to the HTML output directory. Note | 1312 | # other source files which should be copied to the HTML output directory. Note |
| @@ -1151,15 +1316,27 @@ HTML_EXTRA_STYLESHEET = \ | |||
| 1151 | # files will be copied as-is; there are no commands or markers available. | 1316 | # files will be copied as-is; there are no commands or markers available. |
| 1152 | # This tag requires that the tag GENERATE_HTML is set to YES. | 1317 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| 1153 | 1318 | ||
| 1154 | HTML_EXTRA_FILES = \ | 1319 | HTML_EXTRA_FILES = docs/doxygen/favicon.ico \ |
| 1155 | docs/doxygen/favicon.ico \ | 1320 | docs/doxygen/folder.png \ |
| 1156 | docs/doxygen/folder.png \ | 1321 | docs/doxygen/folder-open.png \ |
| 1157 | docs/doxygen/folder-open.png \ | 1322 | docs/doxygen/text-x-generic.png |
| 1158 | docs/doxygen/text-x-generic.png | 1323 | |
| 1324 | # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output | ||
| 1325 | # should be rendered with a dark or light theme. | ||
| 1326 | # Possible values are: LIGHT always generates light mode output, DARK always | ||
| 1327 | # generates dark mode output, AUTO_LIGHT automatically sets the mode according | ||
| 1328 | # to the user preference, uses light mode if no preference is set (the default), | ||
| 1329 | # AUTO_DARK automatically sets the mode according to the user preference, uses | ||
| 1330 | # dark mode if no preference is set and TOGGLE allows a user to switch between | ||
| 1331 | # light and dark mode via a button. | ||
| 1332 | # The default value is: AUTO_LIGHT. | ||
| 1333 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1334 | |||
| 1335 | HTML_COLORSTYLE = AUTO_LIGHT | ||
| 1159 | 1336 | ||
| 1160 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen | 1337 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen |
| 1161 | # will adjust the colors in the style sheet and background images according to | 1338 | # will adjust the colors in the style sheet and background images according to |
| 1162 | # this color. Hue is specified as an angle on a colorwheel, see | 1339 | # this color. Hue is specified as an angle on a color-wheel, see |
| 1163 | # https://en.wikipedia.org/wiki/Hue for more information. For instance the value | 1340 | # https://en.wikipedia.org/wiki/Hue for more information. For instance the value |
| 1164 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 | 1341 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 |
| 1165 | # purple, and 360 is red again. | 1342 | # purple, and 360 is red again. |
| @@ -1169,7 +1346,7 @@ HTML_EXTRA_FILES = \ | |||
| 1169 | HTML_COLORSTYLE_HUE = 220 | 1346 | HTML_COLORSTYLE_HUE = 220 |
| 1170 | 1347 | ||
| 1171 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors | 1348 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors |
| 1172 | # in the HTML output. For a value of 0 the output will use grayscales only. A | 1349 | # in the HTML output. For a value of 0 the output will use gray-scales only. A |
| 1173 | # value of 255 will produce the most vivid colors. | 1350 | # value of 255 will produce the most vivid colors. |
| 1174 | # Minimum value: 0, maximum value: 255, default value: 100. | 1351 | # Minimum value: 0, maximum value: 255, default value: 100. |
| 1175 | # This tag requires that the tag GENERATE_HTML is set to YES. | 1352 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| @@ -1187,20 +1364,11 @@ HTML_COLORSTYLE_SAT = 100 | |||
| 1187 | 1364 | ||
| 1188 | HTML_COLORSTYLE_GAMMA = 80 | 1365 | HTML_COLORSTYLE_GAMMA = 80 |
| 1189 | 1366 | ||
| 1190 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML | ||
| 1191 | # page will contain the date and time when the page was generated. Setting this | ||
| 1192 | # to YES can help to show when doxygen was last run and thus if the | ||
| 1193 | # documentation is up to date. | ||
| 1194 | # The default value is: NO. | ||
| 1195 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1196 | |||
| 1197 | HTML_TIMESTAMP = YES | ||
| 1198 | |||
| 1199 | # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML | 1367 | # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML |
| 1200 | # documentation will contain a main index with vertical navigation menus that | 1368 | # documentation will contain a main index with vertical navigation menus that |
| 1201 | # are dynamically created via Javascript. If disabled, the navigation index will | 1369 | # are dynamically created via JavaScript. If disabled, the navigation index will |
| 1202 | # consists of multiple levels of tabs that are statically embedded in every HTML | 1370 | # consists of multiple levels of tabs that are statically embedded in every HTML |
| 1203 | # page. Disable this option to support browsers that do not have Javascript, | 1371 | # page. Disable this option to support browsers that do not have JavaScript, |
| 1204 | # like the Qt help browser. | 1372 | # like the Qt help browser. |
| 1205 | # The default value is: YES. | 1373 | # The default value is: YES. |
| 1206 | # This tag requires that the tag GENERATE_HTML is set to YES. | 1374 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| @@ -1215,6 +1383,33 @@ HTML_DYNAMIC_MENUS = NO | |||
| 1215 | 1383 | ||
| 1216 | HTML_DYNAMIC_SECTIONS = NO | 1384 | HTML_DYNAMIC_SECTIONS = NO |
| 1217 | 1385 | ||
| 1386 | # If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be | ||
| 1387 | # dynamically folded and expanded in the generated HTML source code. | ||
| 1388 | # The default value is: YES. | ||
| 1389 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1390 | |||
| 1391 | HTML_CODE_FOLDING = YES | ||
| 1392 | |||
| 1393 | # If the HTML_COPY_CLIPBOARD tag is set to YES then doxygen will show an icon in | ||
| 1394 | # the top right corner of code and text fragments that allows the user to copy | ||
| 1395 | # its content to the clipboard. Note this only works if supported by the browser | ||
| 1396 | # and the web page is served via a secure context (see: | ||
| 1397 | # https://www.w3.org/TR/secure-contexts/), i.e. using the https: or file: | ||
| 1398 | # protocol. | ||
| 1399 | # The default value is: YES. | ||
| 1400 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1401 | |||
| 1402 | HTML_COPY_CLIPBOARD = YES | ||
| 1403 | |||
| 1404 | # Doxygen stores a couple of settings persistently in the browser (via e.g. | ||
| 1405 | # cookies). By default these settings apply to all HTML pages generated by | ||
| 1406 | # doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store | ||
| 1407 | # the settings under a project specific key, such that the user preferences will | ||
| 1408 | # be stored separately. | ||
| 1409 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1410 | |||
| 1411 | HTML_PROJECT_COOKIE = | ||
| 1412 | |||
| 1218 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries | 1413 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries |
| 1219 | # shown in the various tree structured indices initially; the user can expand | 1414 | # shown in the various tree structured indices initially; the user can expand |
| 1220 | # and collapse entries dynamically later on. Doxygen will expand the tree to | 1415 | # and collapse entries dynamically later on. Doxygen will expand the tree to |
| @@ -1230,10 +1425,11 @@ HTML_INDEX_NUM_ENTRIES = 100 | |||
| 1230 | 1425 | ||
| 1231 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be | 1426 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be |
| 1232 | # generated that can be used as input for Apple's Xcode 3 integrated development | 1427 | # generated that can be used as input for Apple's Xcode 3 integrated development |
| 1233 | # environment (see: https://developer.apple.com/xcode/), introduced with OSX | 1428 | # environment (see: |
| 1234 | # 10.5 (Leopard). To create a documentation set, doxygen will generate a | 1429 | # https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To |
| 1235 | # Makefile in the HTML output directory. Running make will produce the docset in | 1430 | # create a documentation set, doxygen will generate a Makefile in the HTML |
| 1236 | # that directory and running make install will install the docset in | 1431 | # output directory. Running make will produce the docset in that directory and |
| 1432 | # running make install will install the docset in | ||
| 1237 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at | 1433 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at |
| 1238 | # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy | 1434 | # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy |
| 1239 | # genXcode/_index.html for more information. | 1435 | # genXcode/_index.html for more information. |
| @@ -1250,6 +1446,13 @@ GENERATE_DOCSET = NO | |||
| 1250 | 1446 | ||
| 1251 | DOCSET_FEEDNAME = "Doxygen generated docs" | 1447 | DOCSET_FEEDNAME = "Doxygen generated docs" |
| 1252 | 1448 | ||
| 1449 | # This tag determines the URL of the docset feed. A documentation feed provides | ||
| 1450 | # an umbrella under which multiple documentation sets from a single provider | ||
| 1451 | # (such as a company or product suite) can be grouped. | ||
| 1452 | # This tag requires that the tag GENERATE_DOCSET is set to YES. | ||
| 1453 | |||
| 1454 | DOCSET_FEEDURL = | ||
| 1455 | |||
| 1253 | # This tag specifies a string that should uniquely identify the documentation | 1456 | # This tag specifies a string that should uniquely identify the documentation |
| 1254 | # set bundle. This should be a reverse domain-name style string, e.g. | 1457 | # set bundle. This should be a reverse domain-name style string, e.g. |
| 1255 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. | 1458 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. |
| @@ -1275,8 +1478,12 @@ DOCSET_PUBLISHER_NAME = Publisher | |||
| 1275 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three | 1478 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three |
| 1276 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The | 1479 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The |
| 1277 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop | 1480 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop |
| 1278 | # (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on | 1481 | # on Windows. In the beginning of 2021 Microsoft took the original page, with |
| 1279 | # Windows. | 1482 | # a.o. the download links, offline the HTML help workshop was already many years |
| 1483 | # in maintenance mode). You can download the HTML help workshop from the web | ||
| 1484 | # archives at Installation executable (see: | ||
| 1485 | # http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo | ||
| 1486 | # ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). | ||
| 1280 | # | 1487 | # |
| 1281 | # The HTML Help Workshop contains a compiler that can convert all HTML output | 1488 | # The HTML Help Workshop contains a compiler that can convert all HTML output |
| 1282 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML | 1489 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML |
| @@ -1306,7 +1513,7 @@ CHM_FILE = | |||
| 1306 | HHC_LOCATION = | 1513 | HHC_LOCATION = |
| 1307 | 1514 | ||
| 1308 | # The GENERATE_CHI flag controls if a separate .chi index file is generated | 1515 | # The GENERATE_CHI flag controls if a separate .chi index file is generated |
| 1309 | # (YES) or that it should be included in the master .chm file (NO). | 1516 | # (YES) or that it should be included in the main .chm file (NO). |
| 1310 | # The default value is: NO. | 1517 | # The default value is: NO. |
| 1311 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. | 1518 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
| 1312 | 1519 | ||
| @@ -1333,6 +1540,16 @@ BINARY_TOC = NO | |||
| 1333 | 1540 | ||
| 1334 | TOC_EXPAND = NO | 1541 | TOC_EXPAND = NO |
| 1335 | 1542 | ||
| 1543 | # The SITEMAP_URL tag is used to specify the full URL of the place where the | ||
| 1544 | # generated documentation will be placed on the server by the user during the | ||
| 1545 | # deployment of the documentation. The generated sitemap is called sitemap.xml | ||
| 1546 | # and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL | ||
| 1547 | # is specified no sitemap is generated. For information about the sitemap | ||
| 1548 | # protocol see https://www.sitemaps.org | ||
| 1549 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1550 | |||
| 1551 | SITEMAP_URL = | ||
| 1552 | |||
| 1336 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and | 1553 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and |
| 1337 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that | 1554 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that |
| 1338 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help | 1555 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help |
| @@ -1351,7 +1568,8 @@ QCH_FILE = | |||
| 1351 | 1568 | ||
| 1352 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help | 1569 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help |
| 1353 | # Project output. For more information please see Qt Help Project / Namespace | 1570 | # Project output. For more information please see Qt Help Project / Namespace |
| 1354 | # (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). | 1571 | # (see: |
| 1572 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). | ||
| 1355 | # The default value is: org.doxygen.Project. | 1573 | # The default value is: org.doxygen.Project. |
| 1356 | # This tag requires that the tag GENERATE_QHP is set to YES. | 1574 | # This tag requires that the tag GENERATE_QHP is set to YES. |
| 1357 | 1575 | ||
| @@ -1359,8 +1577,8 @@ QHP_NAMESPACE = org.doxygen.Project | |||
| 1359 | 1577 | ||
| 1360 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt | 1578 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt |
| 1361 | # Help Project output. For more information please see Qt Help Project / Virtual | 1579 | # Help Project output. For more information please see Qt Help Project / Virtual |
| 1362 | # Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- | 1580 | # Folders (see: |
| 1363 | # folders). | 1581 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). |
| 1364 | # The default value is: doc. | 1582 | # The default value is: doc. |
| 1365 | # This tag requires that the tag GENERATE_QHP is set to YES. | 1583 | # This tag requires that the tag GENERATE_QHP is set to YES. |
| 1366 | 1584 | ||
| @@ -1368,16 +1586,16 @@ QHP_VIRTUAL_FOLDER = doc | |||
| 1368 | 1586 | ||
| 1369 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom | 1587 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom |
| 1370 | # filter to add. For more information please see Qt Help Project / Custom | 1588 | # filter to add. For more information please see Qt Help Project / Custom |
| 1371 | # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- | 1589 | # Filters (see: |
| 1372 | # filters). | 1590 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). |
| 1373 | # This tag requires that the tag GENERATE_QHP is set to YES. | 1591 | # This tag requires that the tag GENERATE_QHP is set to YES. |
| 1374 | 1592 | ||
| 1375 | QHP_CUST_FILTER_NAME = | 1593 | QHP_CUST_FILTER_NAME = |
| 1376 | 1594 | ||
| 1377 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the | 1595 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the |
| 1378 | # custom filter to add. For more information please see Qt Help Project / Custom | 1596 | # custom filter to add. For more information please see Qt Help Project / Custom |
| 1379 | # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- | 1597 | # Filters (see: |
| 1380 | # filters). | 1598 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). |
| 1381 | # This tag requires that the tag GENERATE_QHP is set to YES. | 1599 | # This tag requires that the tag GENERATE_QHP is set to YES. |
| 1382 | 1600 | ||
| 1383 | QHP_CUST_FILTER_ATTRS = | 1601 | QHP_CUST_FILTER_ATTRS = |
| @@ -1389,9 +1607,9 @@ QHP_CUST_FILTER_ATTRS = | |||
| 1389 | 1607 | ||
| 1390 | QHP_SECT_FILTER_ATTRS = | 1608 | QHP_SECT_FILTER_ATTRS = |
| 1391 | 1609 | ||
| 1392 | # The QHG_LOCATION tag can be used to specify the location of Qt's | 1610 | # The QHG_LOCATION tag can be used to specify the location (absolute path |
| 1393 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the | 1611 | # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to |
| 1394 | # generated .qhp file. | 1612 | # run qhelpgenerator on the generated .qhp file. |
| 1395 | # This tag requires that the tag GENERATE_QHP is set to YES. | 1613 | # This tag requires that the tag GENERATE_QHP is set to YES. |
| 1396 | 1614 | ||
| 1397 | QHG_LOCATION = | 1615 | QHG_LOCATION = |
| @@ -1434,16 +1652,28 @@ DISABLE_INDEX = NO | |||
| 1434 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required | 1652 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required |
| 1435 | # (i.e. any modern browser). Windows users are probably better off using the | 1653 | # (i.e. any modern browser). Windows users are probably better off using the |
| 1436 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can | 1654 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can |
| 1437 | # further fine-tune the look of the index. As an example, the default style | 1655 | # further fine tune the look of the index (see "Fine-tuning the output"). As an |
| 1438 | # sheet generated by doxygen has an example that shows how to put an image at | 1656 | # example, the default style sheet generated by doxygen has an example that |
| 1439 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has | 1657 | # shows how to put an image at the root of the tree instead of the PROJECT_NAME. |
| 1440 | # the same information as the tab index, you could consider setting | 1658 | # Since the tree basically has the same information as the tab index, you could |
| 1441 | # DISABLE_INDEX to YES when enabling this option. | 1659 | # consider setting DISABLE_INDEX to YES when enabling this option. |
| 1442 | # The default value is: NO. | 1660 | # The default value is: NO. |
| 1443 | # This tag requires that the tag GENERATE_HTML is set to YES. | 1661 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| 1444 | 1662 | ||
| 1445 | GENERATE_TREEVIEW = NONE | 1663 | GENERATE_TREEVIEW = NONE |
| 1446 | 1664 | ||
| 1665 | # When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the | ||
| 1666 | # FULL_SIDEBAR option determines if the side bar is limited to only the treeview | ||
| 1667 | # area (value NO) or if it should extend to the full height of the window (value | ||
| 1668 | # YES). Setting this to YES gives a layout similar to | ||
| 1669 | # https://docs.readthedocs.io with more room for contents, but less room for the | ||
| 1670 | # project logo, title, and description. If either GENERATE_TREEVIEW or | ||
| 1671 | # DISABLE_INDEX is set to NO, this option has no effect. | ||
| 1672 | # The default value is: NO. | ||
| 1673 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1674 | |||
| 1675 | FULL_SIDEBAR = NO | ||
| 1676 | |||
| 1447 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that | 1677 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that |
| 1448 | # doxygen will group on one line in the generated HTML documentation. | 1678 | # doxygen will group on one line in the generated HTML documentation. |
| 1449 | # | 1679 | # |
| @@ -1468,6 +1698,24 @@ TREEVIEW_WIDTH = 250 | |||
| 1468 | 1698 | ||
| 1469 | EXT_LINKS_IN_WINDOW = NO | 1699 | EXT_LINKS_IN_WINDOW = NO |
| 1470 | 1700 | ||
| 1701 | # If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email | ||
| 1702 | # addresses. | ||
| 1703 | # The default value is: YES. | ||
| 1704 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1705 | |||
| 1706 | OBFUSCATE_EMAILS = YES | ||
| 1707 | |||
| 1708 | # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg | ||
| 1709 | # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see | ||
| 1710 | # https://inkscape.org) to generate formulas as SVG images instead of PNGs for | ||
| 1711 | # the HTML output. These images will generally look nicer at scaled resolutions. | ||
| 1712 | # Possible values are: png (the default) and svg (looks nicer but requires the | ||
| 1713 | # pdf2svg or inkscape tool). | ||
| 1714 | # The default value is: png. | ||
| 1715 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1716 | |||
| 1717 | HTML_FORMULA_FORMAT = png | ||
| 1718 | |||
| 1471 | # Use this tag to change the font size of LaTeX formulas included as images in | 1719 | # Use this tag to change the font size of LaTeX formulas included as images in |
| 1472 | # the HTML documentation. When you change the font size after a successful | 1720 | # the HTML documentation. When you change the font size after a successful |
| 1473 | # doxygen run you need to manually remove any form_*.png images from the HTML | 1721 | # doxygen run you need to manually remove any form_*.png images from the HTML |
| @@ -1477,19 +1725,14 @@ EXT_LINKS_IN_WINDOW = NO | |||
| 1477 | 1725 | ||
| 1478 | FORMULA_FONTSIZE = 10 | 1726 | FORMULA_FONTSIZE = 10 |
| 1479 | 1727 | ||
| 1480 | # Use the FORMULA_TRANSPARENT tag to determine whether or not the images | 1728 | # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands |
| 1481 | # generated for formulas are transparent PNGs. Transparent PNGs are not | 1729 | # to create new LaTeX commands to be used in formulas as building blocks. See |
| 1482 | # supported properly for IE 6.0, but are supported on all modern browsers. | 1730 | # the section "Including formulas" for details. |
| 1483 | # | ||
| 1484 | # Note that when changing this option you need to delete any form_*.png files in | ||
| 1485 | # the HTML output directory before the changes have effect. | ||
| 1486 | # The default value is: YES. | ||
| 1487 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1488 | 1731 | ||
| 1489 | FORMULA_TRANSPARENT = YES | 1732 | FORMULA_MACROFILE = |
| 1490 | 1733 | ||
| 1491 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see | 1734 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see |
| 1492 | # https://www.mathjax.org) which uses client side Javascript for the rendering | 1735 | # https://www.mathjax.org) which uses client side JavaScript for the rendering |
| 1493 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX | 1736 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX |
| 1494 | # installed or if you want to formulas look prettier in the HTML output. When | 1737 | # installed or if you want to formulas look prettier in the HTML output. When |
| 1495 | # enabled you may also need to install MathJax separately and configure the path | 1738 | # enabled you may also need to install MathJax separately and configure the path |
| @@ -1499,11 +1742,29 @@ FORMULA_TRANSPARENT = YES | |||
| 1499 | 1742 | ||
| 1500 | USE_MATHJAX = NO | 1743 | USE_MATHJAX = NO |
| 1501 | 1744 | ||
| 1745 | # With MATHJAX_VERSION it is possible to specify the MathJax version to be used. | ||
| 1746 | # Note that the different versions of MathJax have different requirements with | ||
| 1747 | # regards to the different settings, so it is possible that also other MathJax | ||
| 1748 | # settings have to be changed when switching between the different MathJax | ||
| 1749 | # versions. | ||
| 1750 | # Possible values are: MathJax_2 and MathJax_3. | ||
| 1751 | # The default value is: MathJax_2. | ||
| 1752 | # This tag requires that the tag USE_MATHJAX is set to YES. | ||
| 1753 | |||
| 1754 | MATHJAX_VERSION = MathJax_2 | ||
| 1755 | |||
| 1502 | # When MathJax is enabled you can set the default output format to be used for | 1756 | # When MathJax is enabled you can set the default output format to be used for |
| 1503 | # the MathJax output. See the MathJax site (see: | 1757 | # the MathJax output. For more details about the output format see MathJax |
| 1504 | # http://docs.mathjax.org/en/latest/output.html) for more details. | 1758 | # version 2 (see: |
| 1759 | # http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 | ||
| 1760 | # (see: | ||
| 1761 | # http://docs.mathjax.org/en/latest/web/components/output.html). | ||
| 1505 | # Possible values are: HTML-CSS (which is slower, but has the best | 1762 | # Possible values are: HTML-CSS (which is slower, but has the best |
| 1506 | # compatibility), NativeMML (i.e. MathML) and SVG. | 1763 | # compatibility. This is the name for Mathjax version 2, for MathJax version 3 |
| 1764 | # this will be translated into chtml), NativeMML (i.e. MathML. Only supported | ||
| 1765 | # for MathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This | ||
| 1766 | # is the name for Mathjax version 3, for MathJax version 2 this will be | ||
| 1767 | # translated into HTML-CSS) and SVG. | ||
| 1507 | # The default value is: HTML-CSS. | 1768 | # The default value is: HTML-CSS. |
| 1508 | # This tag requires that the tag USE_MATHJAX is set to YES. | 1769 | # This tag requires that the tag USE_MATHJAX is set to YES. |
| 1509 | 1770 | ||
| @@ -1516,22 +1777,29 @@ MATHJAX_FORMAT = HTML-CSS | |||
| 1516 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax | 1777 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax |
| 1517 | # Content Delivery Network so you can quickly see the result without installing | 1778 | # Content Delivery Network so you can quickly see the result without installing |
| 1518 | # MathJax. However, it is strongly recommended to install a local copy of | 1779 | # MathJax. However, it is strongly recommended to install a local copy of |
| 1519 | # MathJax from https://www.mathjax.org before deployment. | 1780 | # MathJax from https://www.mathjax.org before deployment. The default value is: |
| 1520 | # The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. | 1781 | # - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 |
| 1782 | # - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 | ||
| 1521 | # This tag requires that the tag USE_MATHJAX is set to YES. | 1783 | # This tag requires that the tag USE_MATHJAX is set to YES. |
| 1522 | 1784 | ||
| 1523 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest | 1785 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest |
| 1524 | 1786 | ||
| 1525 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax | 1787 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax |
| 1526 | # extension names that should be enabled during MathJax rendering. For example | 1788 | # extension names that should be enabled during MathJax rendering. For example |
| 1789 | # for MathJax version 2 (see | ||
| 1790 | # https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): | ||
| 1527 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols | 1791 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols |
| 1792 | # For example for MathJax version 3 (see | ||
| 1793 | # http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): | ||
| 1794 | # MATHJAX_EXTENSIONS = ams | ||
| 1528 | # This tag requires that the tag USE_MATHJAX is set to YES. | 1795 | # This tag requires that the tag USE_MATHJAX is set to YES. |
| 1529 | 1796 | ||
| 1530 | MATHJAX_EXTENSIONS = | 1797 | MATHJAX_EXTENSIONS = |
| 1531 | 1798 | ||
| 1532 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces | 1799 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces |
| 1533 | # of code that will be used on startup of the MathJax code. See the MathJax site | 1800 | # of code that will be used on startup of the MathJax code. See the MathJax site |
| 1534 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an | 1801 | # (see: |
| 1802 | # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an | ||
| 1535 | # example see the documentation. | 1803 | # example see the documentation. |
| 1536 | # This tag requires that the tag USE_MATHJAX is set to YES. | 1804 | # This tag requires that the tag USE_MATHJAX is set to YES. |
| 1537 | 1805 | ||
| @@ -1559,7 +1827,7 @@ MATHJAX_CODEFILE = | |||
| 1559 | SEARCHENGINE = NO | 1827 | SEARCHENGINE = NO |
| 1560 | 1828 | ||
| 1561 | # When the SERVER_BASED_SEARCH tag is enabled the search engine will be | 1829 | # When the SERVER_BASED_SEARCH tag is enabled the search engine will be |
| 1562 | # implemented using a web server instead of a web client using Javascript. There | 1830 | # implemented using a web server instead of a web client using JavaScript. There |
| 1563 | # are two flavors of web server based searching depending on the EXTERNAL_SEARCH | 1831 | # are two flavors of web server based searching depending on the EXTERNAL_SEARCH |
| 1564 | # setting. When disabled, doxygen will generate a PHP script for searching and | 1832 | # setting. When disabled, doxygen will generate a PHP script for searching and |
| 1565 | # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing | 1833 | # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing |
| @@ -1578,7 +1846,8 @@ SERVER_BASED_SEARCH = NO | |||
| 1578 | # | 1846 | # |
| 1579 | # Doxygen ships with an example indexer (doxyindexer) and search engine | 1847 | # Doxygen ships with an example indexer (doxyindexer) and search engine |
| 1580 | # (doxysearch.cgi) which are based on the open source search engine library | 1848 | # (doxysearch.cgi) which are based on the open source search engine library |
| 1581 | # Xapian (see: https://xapian.org/). | 1849 | # Xapian (see: |
| 1850 | # https://xapian.org/). | ||
| 1582 | # | 1851 | # |
| 1583 | # See the section "External Indexing and Searching" for details. | 1852 | # See the section "External Indexing and Searching" for details. |
| 1584 | # The default value is: NO. | 1853 | # The default value is: NO. |
| @@ -1591,8 +1860,9 @@ EXTERNAL_SEARCH = NO | |||
| 1591 | # | 1860 | # |
| 1592 | # Doxygen ships with an example indexer (doxyindexer) and search engine | 1861 | # Doxygen ships with an example indexer (doxyindexer) and search engine |
| 1593 | # (doxysearch.cgi) which are based on the open source search engine library | 1862 | # (doxysearch.cgi) which are based on the open source search engine library |
| 1594 | # Xapian (see: https://xapian.org/). See the section "External Indexing and | 1863 | # Xapian (see: |
| 1595 | # Searching" for details. | 1864 | # https://xapian.org/). See the section "External Indexing and Searching" for |
| 1865 | # details. | ||
| 1596 | # This tag requires that the tag SEARCHENGINE is set to YES. | 1866 | # This tag requires that the tag SEARCHENGINE is set to YES. |
| 1597 | 1867 | ||
| 1598 | SEARCHENGINE_URL = | 1868 | SEARCHENGINE_URL = |
| @@ -1701,29 +1971,31 @@ PAPER_TYPE = a4 | |||
| 1701 | 1971 | ||
| 1702 | EXTRA_PACKAGES = | 1972 | EXTRA_PACKAGES = |
| 1703 | 1973 | ||
| 1704 | # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the | 1974 | # The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for |
| 1705 | # generated LaTeX document. The header should contain everything until the first | 1975 | # the generated LaTeX document. The header should contain everything until the |
| 1706 | # chapter. If it is left blank doxygen will generate a standard header. See | 1976 | # first chapter. If it is left blank doxygen will generate a standard header. It |
| 1707 | # section "Doxygen usage" for information on how to let doxygen write the | 1977 | # is highly recommended to start with a default header using |
| 1708 | # default header to a separate file. | 1978 | # doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty |
| 1979 | # and then modify the file new_header.tex. See also section "Doxygen usage" for | ||
| 1980 | # information on how to generate the default header that doxygen normally uses. | ||
| 1709 | # | 1981 | # |
| 1710 | # Note: Only use a user-defined header if you know what you are doing! The | 1982 | # Note: Only use a user-defined header if you know what you are doing! |
| 1711 | # following commands have a special meaning inside the header: $title, | 1983 | # Note: The header is subject to change so you typically have to regenerate the |
| 1712 | # $datetime, $date, $doxygenversion, $projectname, $projectnumber, | 1984 | # default header when upgrading to a newer version of doxygen. The following |
| 1713 | # $projectbrief, $projectlogo. Doxygen will replace $title with the empty | 1985 | # commands have a special meaning inside the header (and footer): For a |
| 1714 | # string, for the replacement values of the other commands the user is referred | 1986 | # description of the possible markers and block names see the documentation. |
| 1715 | # to HTML_HEADER. | ||
| 1716 | # This tag requires that the tag GENERATE_LATEX is set to YES. | 1987 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| 1717 | 1988 | ||
| 1718 | LATEX_HEADER = | 1989 | LATEX_HEADER = |
| 1719 | 1990 | ||
| 1720 | # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the | 1991 | # The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for |
| 1721 | # generated LaTeX document. The footer should contain everything after the last | 1992 | # the generated LaTeX document. The footer should contain everything after the |
| 1722 | # chapter. If it is left blank doxygen will generate a standard footer. See | 1993 | # last chapter. If it is left blank doxygen will generate a standard footer. See |
| 1723 | # LATEX_HEADER for more information on how to generate a default footer and what | 1994 | # LATEX_HEADER for more information on how to generate a default footer and what |
| 1724 | # special commands can be used inside the footer. | 1995 | # special commands can be used inside the footer. See also section "Doxygen |
| 1725 | # | 1996 | # usage" for information on how to generate the default footer that doxygen |
| 1726 | # Note: Only use a user-defined footer if you know what you are doing! | 1997 | # normally uses. Note: Only use a user-defined footer if you know what you are |
| 1998 | # doing! | ||
| 1727 | # This tag requires that the tag GENERATE_LATEX is set to YES. | 1999 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| 1728 | 2000 | ||
| 1729 | LATEX_FOOTER = | 2001 | LATEX_FOOTER = |
| @@ -1756,18 +2028,26 @@ LATEX_EXTRA_FILES = | |||
| 1756 | 2028 | ||
| 1757 | PDF_HYPERLINKS = NO | 2029 | PDF_HYPERLINKS = NO |
| 1758 | 2030 | ||
| 1759 | # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate | 2031 | # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as |
| 1760 | # the PDF file directly from the LaTeX files. Set this option to YES, to get a | 2032 | # specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX |
| 1761 | # higher quality PDF documentation. | 2033 | # files. Set this option to YES, to get a higher quality PDF documentation. |
| 2034 | # | ||
| 2035 | # See also section LATEX_CMD_NAME for selecting the engine. | ||
| 1762 | # The default value is: YES. | 2036 | # The default value is: YES. |
| 1763 | # This tag requires that the tag GENERATE_LATEX is set to YES. | 2037 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| 1764 | 2038 | ||
| 1765 | USE_PDFLATEX = NO | 2039 | USE_PDFLATEX = NO |
| 1766 | 2040 | ||
| 1767 | # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode | 2041 | # The LATEX_BATCHMODE tag signals the behavior of LaTeX in case of an error. |
| 1768 | # command to the generated LaTeX files. This will instruct LaTeX to keep running | 2042 | # Possible values are: NO same as ERROR_STOP, YES same as BATCH, BATCH In batch |
| 1769 | # if errors occur, instead of asking the user for help. This option is also used | 2043 | # mode nothing is printed on the terminal, errors are scrolled as if <return> is |
| 1770 | # when generating formulas in HTML. | 2044 | # hit at every error; missing files that TeX tries to input or request from |
| 2045 | # keyboard input (\read on a not open input stream) cause the job to abort, | ||
| 2046 | # NON_STOP In nonstop mode the diagnostic message will appear on the terminal, | ||
| 2047 | # but there is no possibility of user interaction just like in batch mode, | ||
| 2048 | # SCROLL In scroll mode, TeX will stop only for missing files to input or if | ||
| 2049 | # keyboard input is necessary and ERROR_STOP In errorstop mode, TeX will stop at | ||
| 2050 | # each error, asking for user intervention. | ||
| 1771 | # The default value is: NO. | 2051 | # The default value is: NO. |
| 1772 | # This tag requires that the tag GENERATE_LATEX is set to YES. | 2052 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| 1773 | 2053 | ||
| @@ -1788,14 +2068,6 @@ LATEX_HIDE_INDICES = NO | |||
| 1788 | 2068 | ||
| 1789 | LATEX_BIB_STYLE = plain | 2069 | LATEX_BIB_STYLE = plain |
| 1790 | 2070 | ||
| 1791 | # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated | ||
| 1792 | # page will contain the date and time when the page was generated. Setting this | ||
| 1793 | # to NO can help when comparing the output of multiple runs. | ||
| 1794 | # The default value is: NO. | ||
| 1795 | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||
| 1796 | |||
| 1797 | LATEX_TIMESTAMP = NO | ||
| 1798 | |||
| 1799 | # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) | 2071 | # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) |
| 1800 | # path from which the emoji images will be read. If a relative path is entered, | 2072 | # path from which the emoji images will be read. If a relative path is entered, |
| 1801 | # it will be relative to the LATEX_OUTPUT directory. If left blank the | 2073 | # it will be relative to the LATEX_OUTPUT directory. If left blank the |
| @@ -1860,6 +2132,14 @@ RTF_STYLESHEET_FILE = | |||
| 1860 | 2132 | ||
| 1861 | RTF_EXTENSIONS_FILE = | 2133 | RTF_EXTENSIONS_FILE = |
| 1862 | 2134 | ||
| 2135 | # The RTF_EXTRA_FILES tag can be used to specify one or more extra images or | ||
| 2136 | # other source files which should be copied to the RTF_OUTPUT output directory. | ||
| 2137 | # Note that the files will be copied as-is; there are no commands or markers | ||
| 2138 | # available. | ||
| 2139 | # This tag requires that the tag GENERATE_RTF is set to YES. | ||
| 2140 | |||
| 2141 | RTF_EXTRA_FILES = | ||
| 2142 | |||
| 1863 | #--------------------------------------------------------------------------- | 2143 | #--------------------------------------------------------------------------- |
| 1864 | # Configuration options related to the man page output | 2144 | # Configuration options related to the man page output |
| 1865 | #--------------------------------------------------------------------------- | 2145 | #--------------------------------------------------------------------------- |
| @@ -1961,7 +2241,7 @@ DOCBOOK_OUTPUT = docbook | |||
| 1961 | #--------------------------------------------------------------------------- | 2241 | #--------------------------------------------------------------------------- |
| 1962 | 2242 | ||
| 1963 | # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an | 2243 | # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an |
| 1964 | # AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures | 2244 | # AutoGen Definitions (see https://autogen.sourceforge.net/) file that captures |
| 1965 | # the structure of the code including all documentation. Note that this feature | 2245 | # the structure of the code including all documentation. Note that this feature |
| 1966 | # is still experimental and incomplete at the moment. | 2246 | # is still experimental and incomplete at the moment. |
| 1967 | # The default value is: NO. | 2247 | # The default value is: NO. |
| @@ -1969,6 +2249,32 @@ DOCBOOK_OUTPUT = docbook | |||
| 1969 | GENERATE_AUTOGEN_DEF = NO | 2249 | GENERATE_AUTOGEN_DEF = NO |
| 1970 | 2250 | ||
| 1971 | #--------------------------------------------------------------------------- | 2251 | #--------------------------------------------------------------------------- |
| 2252 | # Configuration options related to Sqlite3 output | ||
| 2253 | #--------------------------------------------------------------------------- | ||
| 2254 | |||
| 2255 | # If the GENERATE_SQLITE3 tag is set to YES doxygen will generate a Sqlite3 | ||
| 2256 | # database with symbols found by doxygen stored in tables. | ||
| 2257 | # The default value is: NO. | ||
| 2258 | |||
| 2259 | GENERATE_SQLITE3 = NO | ||
| 2260 | |||
| 2261 | # The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database will be | ||
| 2262 | # put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put | ||
| 2263 | # in front of it. | ||
| 2264 | # The default directory is: sqlite3. | ||
| 2265 | # This tag requires that the tag GENERATE_SQLITE3 is set to YES. | ||
| 2266 | |||
| 2267 | SQLITE3_OUTPUT = sqlite3 | ||
| 2268 | |||
| 2269 | # The SQLITE3_RECREATE_DB tag is set to YES, the existing doxygen_sqlite3.db | ||
| 2270 | # database file will be recreated with each doxygen run. If set to NO, doxygen | ||
| 2271 | # will warn if a database file is already found and not modify it. | ||
| 2272 | # The default value is: YES. | ||
| 2273 | # This tag requires that the tag GENERATE_SQLITE3 is set to YES. | ||
| 2274 | |||
| 2275 | SQLITE3_RECREATE_DB = YES | ||
| 2276 | |||
| 2277 | #--------------------------------------------------------------------------- | ||
| 1972 | # Configuration options related to the Perl module output | 2278 | # Configuration options related to the Perl module output |
| 1973 | #--------------------------------------------------------------------------- | 2279 | #--------------------------------------------------------------------------- |
| 1974 | 2280 | ||
| @@ -2042,7 +2348,8 @@ SEARCH_INCLUDES = NO | |||
| 2042 | 2348 | ||
| 2043 | # The INCLUDE_PATH tag can be used to specify one or more directories that | 2349 | # The INCLUDE_PATH tag can be used to specify one or more directories that |
| 2044 | # contain include files that are not input files but should be processed by the | 2350 | # contain include files that are not input files but should be processed by the |
| 2045 | # preprocessor. | 2351 | # preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of |
| 2352 | # RECURSIVE has no effect here. | ||
| 2046 | # This tag requires that the tag SEARCH_INCLUDES is set to YES. | 2353 | # This tag requires that the tag SEARCH_INCLUDES is set to YES. |
| 2047 | 2354 | ||
| 2048 | INCLUDE_PATH = | 2355 | INCLUDE_PATH = |
| @@ -2109,15 +2416,15 @@ TAGFILES = | |||
| 2109 | 2416 | ||
| 2110 | GENERATE_TAGFILE = | 2417 | GENERATE_TAGFILE = |
| 2111 | 2418 | ||
| 2112 | # If the ALLEXTERNALS tag is set to YES, all external class will be listed in | 2419 | # If the ALLEXTERNALS tag is set to YES, all external classes and namespaces |
| 2113 | # the class index. If set to NO, only the inherited external classes will be | 2420 | # will be listed in the class and namespace index. If set to NO, only the |
| 2114 | # listed. | 2421 | # inherited external classes will be listed. |
| 2115 | # The default value is: NO. | 2422 | # The default value is: NO. |
| 2116 | 2423 | ||
| 2117 | ALLEXTERNALS = NO | 2424 | ALLEXTERNALS = NO |
| 2118 | 2425 | ||
| 2119 | # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed | 2426 | # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed |
| 2120 | # in the modules index. If set to NO, only the current project's groups will be | 2427 | # in the topic index. If set to NO, only the current project's groups will be |
| 2121 | # listed. | 2428 | # listed. |
| 2122 | # The default value is: YES. | 2429 | # The default value is: YES. |
| 2123 | 2430 | ||
| @@ -2131,25 +2438,9 @@ EXTERNAL_GROUPS = YES | |||
| 2131 | EXTERNAL_PAGES = YES | 2438 | EXTERNAL_PAGES = YES |
| 2132 | 2439 | ||
| 2133 | #--------------------------------------------------------------------------- | 2440 | #--------------------------------------------------------------------------- |
| 2134 | # Configuration options related to the dot tool | 2441 | # Configuration options related to diagram generator tools |
| 2135 | #--------------------------------------------------------------------------- | 2442 | #--------------------------------------------------------------------------- |
| 2136 | 2443 | ||
| 2137 | # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram | ||
| 2138 | # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to | ||
| 2139 | # NO turns the diagrams off. Note that this option also works with HAVE_DOT | ||
| 2140 | # disabled, but it is recommended to install and use dot, since it yields more | ||
| 2141 | # powerful graphs. | ||
| 2142 | # The default value is: YES. | ||
| 2143 | |||
| 2144 | CLASS_DIAGRAMS = YES | ||
| 2145 | |||
| 2146 | # You can include diagrams made with dia in doxygen documentation. Doxygen will | ||
| 2147 | # then run dia to produce the diagram and insert it in the documentation. The | ||
| 2148 | # DIA_PATH tag allows you to specify the directory where the dia binary resides. | ||
| 2149 | # If left empty dia is assumed to be found in the default search path. | ||
| 2150 | |||
| 2151 | DIA_PATH = | ||
| 2152 | |||
| 2153 | # If set to YES the inheritance and collaboration graphs will hide inheritance | 2444 | # If set to YES the inheritance and collaboration graphs will hide inheritance |
| 2154 | # and usage relations if the target is undocumented or is not a class. | 2445 | # and usage relations if the target is undocumented or is not a class. |
| 2155 | # The default value is: YES. | 2446 | # The default value is: YES. |
| @@ -2158,7 +2449,7 @@ HIDE_UNDOC_RELATIONS = YES | |||
| 2158 | 2449 | ||
| 2159 | # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is | 2450 | # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is |
| 2160 | # available from the path. This tool is part of Graphviz (see: | 2451 | # available from the path. This tool is part of Graphviz (see: |
| 2161 | # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent | 2452 | # https://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent |
| 2162 | # Bell Labs. The other options in this section have no effect if this option is | 2453 | # Bell Labs. The other options in this section have no effect if this option is |
| 2163 | # set to NO | 2454 | # set to NO |
| 2164 | # The default value is: NO. | 2455 | # The default value is: NO. |
| @@ -2175,49 +2466,77 @@ HAVE_DOT = NO | |||
| 2175 | 2466 | ||
| 2176 | DOT_NUM_THREADS = 0 | 2467 | DOT_NUM_THREADS = 0 |
| 2177 | 2468 | ||
| 2178 | # When you want a differently looking font in the dot files that doxygen | 2469 | # DOT_COMMON_ATTR is common attributes for nodes, edges and labels of |
| 2179 | # generates you can specify the font name using DOT_FONTNAME. You need to make | 2470 | # subgraphs. When you want a differently looking font in the dot files that |
| 2180 | # sure dot is able to find the font, which can be done by putting it in a | 2471 | # doxygen generates you can specify fontname, fontcolor and fontsize attributes. |
| 2181 | # standard location or by setting the DOTFONTPATH environment variable or by | 2472 | # For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node, |
| 2182 | # setting DOT_FONTPATH to the directory containing the font. | 2473 | # Edge and Graph Attributes specification</a> You need to make sure dot is able |
| 2183 | # The default value is: Helvetica. | 2474 | # to find the font, which can be done by putting it in a standard location or by |
| 2475 | # setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the | ||
| 2476 | # directory containing the font. Default graphviz fontsize is 14. | ||
| 2477 | # The default value is: fontname=Helvetica,fontsize=10. | ||
| 2184 | # This tag requires that the tag HAVE_DOT is set to YES. | 2478 | # This tag requires that the tag HAVE_DOT is set to YES. |
| 2185 | 2479 | ||
| 2186 | DOT_FONTNAME = | 2480 | DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10" |
| 2187 | 2481 | ||
| 2188 | # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of | 2482 | # DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can |
| 2189 | # dot graphs. | 2483 | # add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a |
| 2190 | # Minimum value: 4, maximum value: 24, default value: 10. | 2484 | # href=https://graphviz.org/doc/info/arrows.html>Complete documentation about |
| 2485 | # arrows shapes.</a> | ||
| 2486 | # The default value is: labelfontname=Helvetica,labelfontsize=10. | ||
| 2191 | # This tag requires that the tag HAVE_DOT is set to YES. | 2487 | # This tag requires that the tag HAVE_DOT is set to YES. |
| 2192 | 2488 | ||
| 2193 | DOT_FONTSIZE = 10 | 2489 | DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10" |
| 2194 | 2490 | ||
| 2195 | # By default doxygen will tell dot to use the default font as specified with | 2491 | # DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes |
| 2196 | # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set | 2492 | # around nodes set 'shape=plain' or 'shape=plaintext' <a |
| 2197 | # the path where dot can find it using this tag. | 2493 | # href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a> |
| 2494 | # The default value is: shape=box,height=0.2,width=0.4. | ||
| 2495 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2496 | |||
| 2497 | DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4" | ||
| 2498 | |||
| 2499 | # You can set the path where dot can find font specified with fontname in | ||
| 2500 | # DOT_COMMON_ATTR and others dot attributes. | ||
| 2198 | # This tag requires that the tag HAVE_DOT is set to YES. | 2501 | # This tag requires that the tag HAVE_DOT is set to YES. |
| 2199 | 2502 | ||
| 2200 | DOT_FONTPATH = | 2503 | DOT_FONTPATH = |
| 2201 | 2504 | ||
| 2202 | # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for | 2505 | # If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then doxygen will |
| 2203 | # each documented class showing the direct and indirect inheritance relations. | 2506 | # generate a graph for each documented class showing the direct and indirect |
| 2204 | # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. | 2507 | # inheritance relations. In case the CLASS_GRAPH tag is set to YES or GRAPH and |
| 2508 | # HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case | ||
| 2509 | # the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the | ||
| 2510 | # CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used. | ||
| 2511 | # If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance | ||
| 2512 | # relations will be shown as texts / links. Explicit enabling an inheritance | ||
| 2513 | # graph or choosing a different representation for an inheritance graph of a | ||
| 2514 | # specific class, can be accomplished by means of the command \inheritancegraph. | ||
| 2515 | # Disabling an inheritance graph can be accomplished by means of the command | ||
| 2516 | # \hideinheritancegraph. | ||
| 2517 | # Possible values are: NO, YES, TEXT, GRAPH and BUILTIN. | ||
| 2205 | # The default value is: YES. | 2518 | # The default value is: YES. |
| 2206 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2207 | 2519 | ||
| 2208 | CLASS_GRAPH = YES | 2520 | CLASS_GRAPH = YES |
| 2209 | 2521 | ||
| 2210 | # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a | 2522 | # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a |
| 2211 | # graph for each documented class showing the direct and indirect implementation | 2523 | # graph for each documented class showing the direct and indirect implementation |
| 2212 | # dependencies (inheritance, containment, and class references variables) of the | 2524 | # dependencies (inheritance, containment, and class references variables) of the |
| 2213 | # class with other documented classes. | 2525 | # class with other documented classes. Explicit enabling a collaboration graph, |
| 2526 | # when COLLABORATION_GRAPH is set to NO, can be accomplished by means of the | ||
| 2527 | # command \collaborationgraph. Disabling a collaboration graph can be | ||
| 2528 | # accomplished by means of the command \hidecollaborationgraph. | ||
| 2214 | # The default value is: YES. | 2529 | # The default value is: YES. |
| 2215 | # This tag requires that the tag HAVE_DOT is set to YES. | 2530 | # This tag requires that the tag HAVE_DOT is set to YES. |
| 2216 | 2531 | ||
| 2217 | COLLABORATION_GRAPH = YES | 2532 | COLLABORATION_GRAPH = YES |
| 2218 | 2533 | ||
| 2219 | # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for | 2534 | # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for |
| 2220 | # groups, showing the direct groups dependencies. | 2535 | # groups, showing the direct groups dependencies. Explicit enabling a group |
| 2536 | # dependency graph, when GROUP_GRAPHS is set to NO, can be accomplished by means | ||
| 2537 | # of the command \groupgraph. Disabling a directory graph can be accomplished by | ||
| 2538 | # means of the command \hidegroupgraph. See also the chapter Grouping in the | ||
| 2539 | # manual. | ||
| 2221 | # The default value is: YES. | 2540 | # The default value is: YES. |
| 2222 | # This tag requires that the tag HAVE_DOT is set to YES. | 2541 | # This tag requires that the tag HAVE_DOT is set to YES. |
| 2223 | 2542 | ||
| @@ -2240,10 +2559,32 @@ UML_LOOK = NO | |||
| 2240 | # but if the number exceeds 15, the total amount of fields shown is limited to | 2559 | # but if the number exceeds 15, the total amount of fields shown is limited to |
| 2241 | # 10. | 2560 | # 10. |
| 2242 | # Minimum value: 0, maximum value: 100, default value: 10. | 2561 | # Minimum value: 0, maximum value: 100, default value: 10. |
| 2243 | # This tag requires that the tag HAVE_DOT is set to YES. | 2562 | # This tag requires that the tag UML_LOOK is set to YES. |
| 2244 | 2563 | ||
| 2245 | UML_LIMIT_NUM_FIELDS = 10 | 2564 | UML_LIMIT_NUM_FIELDS = 10 |
| 2246 | 2565 | ||
| 2566 | # If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and | ||
| 2567 | # methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS | ||
| 2568 | # tag is set to YES, doxygen will add type and arguments for attributes and | ||
| 2569 | # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen | ||
| 2570 | # will not generate fields with class member information in the UML graphs. The | ||
| 2571 | # class diagrams will look similar to the default class diagrams but using UML | ||
| 2572 | # notation for the relationships. | ||
| 2573 | # Possible values are: NO, YES and NONE. | ||
| 2574 | # The default value is: NO. | ||
| 2575 | # This tag requires that the tag UML_LOOK is set to YES. | ||
| 2576 | |||
| 2577 | DOT_UML_DETAILS = NO | ||
| 2578 | |||
| 2579 | # The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters | ||
| 2580 | # to display on a single line. If the actual line length exceeds this threshold | ||
| 2581 | # significantly it will be wrapped across multiple lines. Some heuristics are | ||
| 2582 | # applied to avoid ugly line breaks. | ||
| 2583 | # Minimum value: 0, maximum value: 1000, default value: 17. | ||
| 2584 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2585 | |||
| 2586 | DOT_WRAP_THRESHOLD = 17 | ||
| 2587 | |||
| 2247 | # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and | 2588 | # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and |
| 2248 | # collaboration graphs will show the relations between templates and their | 2589 | # collaboration graphs will show the relations between templates and their |
| 2249 | # instances. | 2590 | # instances. |
| @@ -2255,7 +2596,9 @@ TEMPLATE_RELATIONS = NO | |||
| 2255 | # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to | 2596 | # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to |
| 2256 | # YES then doxygen will generate a graph for each documented file showing the | 2597 | # YES then doxygen will generate a graph for each documented file showing the |
| 2257 | # direct and indirect include dependencies of the file with other documented | 2598 | # direct and indirect include dependencies of the file with other documented |
| 2258 | # files. | 2599 | # files. Explicit enabling an include graph, when INCLUDE_GRAPH is is set to NO, |
| 2600 | # can be accomplished by means of the command \includegraph. Disabling an | ||
| 2601 | # include graph can be accomplished by means of the command \hideincludegraph. | ||
| 2259 | # The default value is: YES. | 2602 | # The default value is: YES. |
| 2260 | # This tag requires that the tag HAVE_DOT is set to YES. | 2603 | # This tag requires that the tag HAVE_DOT is set to YES. |
| 2261 | 2604 | ||
| @@ -2264,7 +2607,10 @@ INCLUDE_GRAPH = YES | |||
| 2264 | # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are | 2607 | # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are |
| 2265 | # set to YES then doxygen will generate a graph for each documented file showing | 2608 | # set to YES then doxygen will generate a graph for each documented file showing |
| 2266 | # the direct and indirect include dependencies of the file with other documented | 2609 | # the direct and indirect include dependencies of the file with other documented |
| 2267 | # files. | 2610 | # files. Explicit enabling an included by graph, when INCLUDED_BY_GRAPH is set |
| 2611 | # to NO, can be accomplished by means of the command \includedbygraph. Disabling | ||
| 2612 | # an included by graph can be accomplished by means of the command | ||
| 2613 | # \hideincludedbygraph. | ||
| 2268 | # The default value is: YES. | 2614 | # The default value is: YES. |
| 2269 | # This tag requires that the tag HAVE_DOT is set to YES. | 2615 | # This tag requires that the tag HAVE_DOT is set to YES. |
| 2270 | 2616 | ||
| @@ -2304,16 +2650,26 @@ GRAPHICAL_HIERARCHY = YES | |||
| 2304 | # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the | 2650 | # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the |
| 2305 | # dependencies a directory has on other directories in a graphical way. The | 2651 | # dependencies a directory has on other directories in a graphical way. The |
| 2306 | # dependency relations are determined by the #include relations between the | 2652 | # dependency relations are determined by the #include relations between the |
| 2307 | # files in the directories. | 2653 | # files in the directories. Explicit enabling a directory graph, when |
| 2654 | # DIRECTORY_GRAPH is set to NO, can be accomplished by means of the command | ||
| 2655 | # \directorygraph. Disabling a directory graph can be accomplished by means of | ||
| 2656 | # the command \hidedirectorygraph. | ||
| 2308 | # The default value is: YES. | 2657 | # The default value is: YES. |
| 2309 | # This tag requires that the tag HAVE_DOT is set to YES. | 2658 | # This tag requires that the tag HAVE_DOT is set to YES. |
| 2310 | 2659 | ||
| 2311 | DIRECTORY_GRAPH = YES | 2660 | DIRECTORY_GRAPH = YES |
| 2312 | 2661 | ||
| 2662 | # The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels | ||
| 2663 | # of child directories generated in directory dependency graphs by dot. | ||
| 2664 | # Minimum value: 1, maximum value: 25, default value: 1. | ||
| 2665 | # This tag requires that the tag DIRECTORY_GRAPH is set to YES. | ||
| 2666 | |||
| 2667 | DIR_GRAPH_MAX_DEPTH = 1 | ||
| 2668 | |||
| 2313 | # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images | 2669 | # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images |
| 2314 | # generated by dot. For an explanation of the image formats see the section | 2670 | # generated by dot. For an explanation of the image formats see the section |
| 2315 | # output formats in the documentation of the dot tool (Graphviz (see: | 2671 | # output formats in the documentation of the dot tool (Graphviz (see: |
| 2316 | # http://www.graphviz.org/)). | 2672 | # https://www.graphviz.org/)). |
| 2317 | # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order | 2673 | # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order |
| 2318 | # to make the SVG files visible in IE 9+ (other browsers do not have this | 2674 | # to make the SVG files visible in IE 9+ (other browsers do not have this |
| 2319 | # requirement). | 2675 | # requirement). |
| @@ -2350,11 +2706,12 @@ DOT_PATH = | |||
| 2350 | 2706 | ||
| 2351 | DOTFILE_DIRS = | 2707 | DOTFILE_DIRS = |
| 2352 | 2708 | ||
| 2353 | # The MSCFILE_DIRS tag can be used to specify one or more directories that | 2709 | # You can include diagrams made with dia in doxygen documentation. Doxygen will |
| 2354 | # contain msc files that are included in the documentation (see the \mscfile | 2710 | # then run dia to produce the diagram and insert it in the documentation. The |
| 2355 | # command). | 2711 | # DIA_PATH tag allows you to specify the directory where the dia binary resides. |
| 2712 | # If left empty dia is assumed to be found in the default search path. | ||
| 2356 | 2713 | ||
| 2357 | MSCFILE_DIRS = | 2714 | DIA_PATH = |
| 2358 | 2715 | ||
| 2359 | # The DIAFILE_DIRS tag can be used to specify one or more directories that | 2716 | # The DIAFILE_DIRS tag can be used to specify one or more directories that |
| 2360 | # contain dia files that are included in the documentation (see the \diafile | 2717 | # contain dia files that are included in the documentation (see the \diafile |
| @@ -2363,10 +2720,10 @@ MSCFILE_DIRS = | |||
| 2363 | DIAFILE_DIRS = | 2720 | DIAFILE_DIRS = |
| 2364 | 2721 | ||
| 2365 | # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the | 2722 | # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the |
| 2366 | # path where java can find the plantuml.jar file. If left blank, it is assumed | 2723 | # path where java can find the plantuml.jar file or to the filename of jar file |
| 2367 | # PlantUML is not used or called during a preprocessing step. Doxygen will | 2724 | # to be used. If left blank, it is assumed PlantUML is not used or called during |
| 2368 | # generate a warning when it encounters a \startuml command in this case and | 2725 | # a preprocessing step. Doxygen will generate a warning when it encounters a |
| 2369 | # will not generate output for the diagram. | 2726 | # \startuml command in this case and will not generate output for the diagram. |
| 2370 | 2727 | ||
| 2371 | PLANTUML_JAR_PATH = | 2728 | PLANTUML_JAR_PATH = |
| 2372 | 2729 | ||
| @@ -2383,7 +2740,7 @@ PLANTUML_INCLUDE_PATH = | |||
| 2383 | # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes | 2740 | # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes |
| 2384 | # that will be shown in the graph. If the number of nodes in a graph becomes | 2741 | # that will be shown in the graph. If the number of nodes in a graph becomes |
| 2385 | # larger than this value, doxygen will truncate the graph, which is visualized | 2742 | # larger than this value, doxygen will truncate the graph, which is visualized |
| 2386 | # by representing a node as a red box. Note that doxygen if the number of direct | 2743 | # by representing a node as a red box. Note that if the number of direct |
| 2387 | # children of the root node in a graph is already larger than | 2744 | # children of the root node in a graph is already larger than |
| 2388 | # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that | 2745 | # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that |
| 2389 | # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. | 2746 | # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. |
| @@ -2404,18 +2761,6 @@ DOT_GRAPH_MAX_NODES = 50 | |||
| 2404 | 2761 | ||
| 2405 | MAX_DOT_GRAPH_DEPTH = 0 | 2762 | MAX_DOT_GRAPH_DEPTH = 0 |
| 2406 | 2763 | ||
| 2407 | # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent | ||
| 2408 | # background. This is disabled by default, because dot on Windows does not seem | ||
| 2409 | # to support this out of the box. | ||
| 2410 | # | ||
| 2411 | # Warning: Depending on the platform used, enabling this option may lead to | ||
| 2412 | # badly anti-aliased labels on the edges of a graph (i.e. they become hard to | ||
| 2413 | # read). | ||
| 2414 | # The default value is: NO. | ||
| 2415 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2416 | |||
| 2417 | DOT_TRANSPARENT = NO | ||
| 2418 | |||
| 2419 | # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output | 2764 | # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output |
| 2420 | # files in one run (i.e. multiple -o and -T options on the command line). This | 2765 | # files in one run (i.e. multiple -o and -T options on the command line). This |
| 2421 | # makes dot run faster, but since only newer versions of dot (>1.8.10) support | 2766 | # makes dot run faster, but since only newer versions of dot (>1.8.10) support |
| @@ -2428,14 +2773,34 @@ DOT_MULTI_TARGETS = NO | |||
| 2428 | # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page | 2773 | # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page |
| 2429 | # explaining the meaning of the various boxes and arrows in the dot generated | 2774 | # explaining the meaning of the various boxes and arrows in the dot generated |
| 2430 | # graphs. | 2775 | # graphs. |
| 2776 | # Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal | ||
| 2777 | # graphical representation for inheritance and collaboration diagrams is used. | ||
| 2431 | # The default value is: YES. | 2778 | # The default value is: YES. |
| 2432 | # This tag requires that the tag HAVE_DOT is set to YES. | 2779 | # This tag requires that the tag HAVE_DOT is set to YES. |
| 2433 | 2780 | ||
| 2434 | GENERATE_LEGEND = YES | 2781 | GENERATE_LEGEND = YES |
| 2435 | 2782 | ||
| 2436 | # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot | 2783 | # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate |
| 2437 | # files that are used to generate the various graphs. | 2784 | # files that are used to generate the various graphs. |
| 2785 | # | ||
| 2786 | # Note: This setting is not only used for dot files but also for msc temporary | ||
| 2787 | # files. | ||
| 2438 | # The default value is: YES. | 2788 | # The default value is: YES. |
| 2439 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2440 | 2789 | ||
| 2441 | DOT_CLEANUP = YES | 2790 | DOT_CLEANUP = YES |
| 2791 | |||
| 2792 | # You can define message sequence charts within doxygen comments using the \msc | ||
| 2793 | # command. If the MSCGEN_TOOL tag is left empty (the default), then doxygen will | ||
| 2794 | # use a built-in version of mscgen tool to produce the charts. Alternatively, | ||
| 2795 | # the MSCGEN_TOOL tag can also specify the name an external tool. For instance, | ||
| 2796 | # specifying prog as the value, doxygen will call the tool as prog -T | ||
| 2797 | # <outfile_format> -o <outputfile> <inputfile>. The external tool should support | ||
| 2798 | # output file formats "png", "eps", "svg", and "ismap". | ||
| 2799 | |||
| 2800 | MSCGEN_TOOL = | ||
| 2801 | |||
| 2802 | # The MSCFILE_DIRS tag can be used to specify one or more directories that | ||
| 2803 | # contain msc files that are included in the documentation (see the \mscfile | ||
| 2804 | # command). | ||
| 2805 | |||
| 2806 | MSCFILE_DIRS = | ||
