Changeset 99728 in vbox
- Timestamp:
- May 10, 2023 2:44:12 PM (23 months ago)
- svn:sync-xref-src-repo-rev:
- 157300
- File:
-
- 1 edited
-
trunk/src/VBox/Main/Doxyfile.Main (modified) (81 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/VBox/Main/Doxyfile.Main
r99726 r99728 1 # Doxyfile 1. 8.111 # Doxyfile 1.9.6 2 2 3 3 # This file describes the settings to be used by the documentation system … … 13 13 # TAG += value [value, ...] 14 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 #--------------------------------------------------------------------------- … … 18 28 #--------------------------------------------------------------------------- 19 29 20 # This tag specifies the encoding used for all characters in the config file21 # that follow. The default is UTF-8 which is also the encoding used for all text22 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv23 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv24 # for the list of possible encodings.30 # This tag specifies the encoding used for all characters in the configuration 31 # file that follow. The default is UTF-8 which is also the encoding used for all 32 # text before the first occurrence of this tag. Doxygen uses libiconv (or the 33 # iconv built into libc) for the transcoding. See 34 # https://www.gnu.org/software/libiconv/ for the list of possible encodings. 25 35 # The default value is: UTF-8. 26 36 … … 61 71 OUTPUT_DIRECTORY = $(DOCDIR) 62 72 63 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-64 # directories (in 2 levels) under the output directory of each output format and65 # will distribute the generated files over these directories. Enabling this73 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 74 # sub-directories (in 2 levels) under the output directory of each output format 75 # and will distribute the generated files over these directories. Enabling this 66 76 # option can be useful when feeding doxygen a huge amount of source files, where 67 77 # putting all generated files in the same directory would otherwise causes 68 # performance problems for the file system. 78 # performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to 79 # control the number of sub-directories. 69 80 # The default value is: NO. 70 81 71 82 CREATE_SUBDIRS = NO 83 84 # Controls the number of sub-directories that will be created when 85 # CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every 86 # level increment doubles the number of directories, resulting in 4096 87 # directories at level 8 which is the default and also the maximum value. The 88 # sub-directories are organized in 2 levels, the first level always has a fixed 89 # number of 16 directories. 90 # Minimum value: 0, maximum value: 8, default value: 8. 91 # This tag requires that the tag CREATE_SUBDIRS is set to YES. 92 93 CREATE_SUBDIRS_LEVEL = 8 72 94 73 95 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII … … 82 104 # documentation generated by doxygen is written. Doxygen will use this 83 105 # information to generate all constant output in the proper language. 84 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,85 # C hinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),86 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,87 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),88 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,89 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,90 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,91 # Ukrainian and Vietnamese.106 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, 107 # Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English 108 # (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, 109 # Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with 110 # English messages), Korean, Korean-en (Korean with English messages), Latvian, 111 # Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, 112 # Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, 113 # Swedish, Turkish, Ukrainian and Vietnamese. 92 114 # The default value is: English. 93 115 … … 187 209 JAVADOC_AUTOBRIEF = YES 188 210 211 # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line 212 # such as 213 # /*************** 214 # as being the beginning of a Javadoc-style comment "banner". If set to NO, the 215 # Javadoc-style will behave just like regular comments and it will not be 216 # interpreted by doxygen. 217 # The default value is: NO. 218 219 JAVADOC_BANNER = NO 220 189 221 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 190 222 # line (until the first dot) of a Qt-style comment as the brief description. If … … 207 239 MULTILINE_CPP_IS_BRIEF = NO 208 240 241 # By default Python docstrings are displayed as preformatted text and doxygen's 242 # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the 243 # doxygen's special commands can be used and the contents of the docstring 244 # documentation blocks is shown as doxygen documentation. 245 # The default value is: YES. 246 247 PYTHON_DOCSTRING = YES 248 209 249 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 210 250 # documentation from any documented member that it re-implements. … … 230 270 # name=value 231 271 # For example adding 232 # "sideeffect=@par Side Effects: \n"272 # "sideeffect=@par Side Effects:^^" 233 273 # will allow you to put the command \sideeffect (or @sideeffect) in the 234 274 # documentation, which will result in a user-defined paragraph with heading 235 # "Side Effects:". You can put \n's in the value part of an alias to insert 236 # newlines. 275 # "Side Effects:". Note that you cannot put \n's in the value part of an alias 276 # to insert newlines (in the resulting output). You can put ^^ in the value part 277 # of an alias to insert a newline as if a physical newline was in the original 278 # file. When you need a literal { or } or , in the value part of an alias you 279 # have to escape them by means of a backslash (\), this can lead to conflicts 280 # with the commands \{ and \} for these it is advised to use the version @{ and 281 # @} or use a double escape (\\{ and \\}) 237 282 238 283 ALIASES = 239 240 # This tag can be used to specify a number of word-keyword mappings (TCL only).241 # A mapping has the form "name=value". For example adding "class=itcl::class"242 # will allow you to use the command class in the itcl::class meaning.243 244 TCL_SUBST =245 284 246 285 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources … … 272 311 OPTIMIZE_OUTPUT_VHDL = NO 273 312 313 # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice 314 # sources only. Doxygen will then generate output that is more tailored for that 315 # language. For instance, namespaces will be presented as modules, types will be 316 # separated into more groups, etc. 317 # The default value is: NO. 318 319 OPTIMIZE_OUTPUT_SLICE = NO 320 274 321 # Doxygen selects the parser to use depending on the extension of the files it 275 322 # parses. With this tag you can assign which parser to use for a given 276 323 # extension. Doxygen has a built-in mapping, but you can override or extend it 277 324 # using this tag. The format is ext=language, where ext is a file extension, and 278 # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 279 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 280 # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 281 # Fortran. In the later case the parser tries to guess whether the code is fixed 282 # or free formatted code, this is the default for Fortran type files), VHDL. For 283 # instance to make doxygen treat .inc files as Fortran files (default is PHP), 284 # and .f files as C (default is Fortran), use: inc=Fortran f=C. 325 # language is one of the parsers supported by doxygen: IDL, Java, JavaScript, 326 # Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, 327 # VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: 328 # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser 329 # tries to guess whether the code is fixed or free formatted code, this is the 330 # default for Fortran type files). For instance to make doxygen treat .inc files 331 # as Fortran files (default is PHP), and .f files as C (default is Fortran), 332 # use: inc=Fortran f=C. 285 333 # 286 334 # Note: For files without extension you can use no_extension as a placeholder. 287 335 # 288 336 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 289 # the files are not read by doxygen. 337 # the files are not read by doxygen. When specifying no_extension you should add 338 # * to the FILE_PATTERNS. 339 # 340 # Note see also the list of default file extension mappings. 290 341 291 342 EXTENSION_MAPPING = … … 293 344 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 294 345 # according to the Markdown format, which allows for more readable 295 # documentation. See http ://daringfireball.net/projects/markdown/ for details.346 # documentation. See https://daringfireball.net/projects/markdown/ for details. 296 347 # The output of markdown processing is further processed by doxygen, so you can 297 348 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in … … 299 350 # The default value is: YES. 300 351 301 MARKDOWN_SUPPORT = YES 352 MARKDOWN_SUPPORT = NO 353 354 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 355 # to that level are automatically included in the table of contents, even if 356 # they do not have an id attribute. 357 # Note: This feature currently applies only to Markdown headings. 358 # Minimum value: 0, maximum value: 99, default value: 5. 359 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 360 361 TOC_INCLUDE_HEADINGS = 5 302 362 303 363 # When enabled doxygen tries to link words that correspond to documented … … 326 386 327 387 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 328 # http ://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen388 # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen 329 389 # will parse them like normal C++ but will assume all classes use public instead 330 390 # of private inheritance when no explicit protection keyword is present. … … 412 472 LOOKUP_CACHE_SIZE = 0 413 473 474 # The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use 475 # during processing. When set to 0 doxygen will based this on the number of 476 # cores available in the system. You can set it explicitly to a value larger 477 # than 0 to get more control over the balance between CPU load and processing 478 # speed. At this moment only the input processing can be done using multiple 479 # threads. Since this is still an experimental feature the default is set to 1, 480 # which effectively disables parallel processing. Please report any issues you 481 # encounter. Generating dot graphs in parallel is controlled by the 482 # DOT_NUM_THREADS setting. 483 # Minimum value: 0, maximum value: 32, default value: 1. 484 485 NUM_PROC_THREADS = 0 486 414 487 #--------------------------------------------------------------------------- 415 488 # Build related configuration options … … 432 505 EXTRACT_PRIVATE = YES 433 506 507 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual 508 # methods of a class will be included in the documentation. 509 # The default value is: NO. 510 511 EXTRACT_PRIV_VIRTUAL = NO 512 434 513 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 435 514 # scope will be included in the documentation. … … 469 548 EXTRACT_ANON_NSPACES = NO 470 549 550 # If this flag is set to YES, the name of an unnamed parameter in a declaration 551 # will be determined by the corresponding definition. By default unnamed 552 # parameters remain unnamed in the output. 553 # The default value is: YES. 554 555 RESOLVE_UNNAMED_PARAMS = YES 556 471 557 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 472 558 # undocumented members inside documented classes or files. If set to NO these … … 480 566 # undocumented classes that are normally visible in the class hierarchy. If set 481 567 # to NO, these classes will be included in the various overviews. This option 482 # has no effect if EXTRACT_ALL is enabled. 568 # will also hide undocumented C++ concepts if enabled. This option has no effect 569 # if EXTRACT_ALL is enabled. 483 570 # The default value is: NO. 484 571 … … 486 573 487 574 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 488 # (class|struct|union) declarations. If set to NO, these declarations will be489 # included in thedocumentation.575 # declarations. If set to NO, these declarations will be included in the 576 # documentation. 490 577 # The default value is: NO. 491 578 … … 506 593 INTERNAL_DOCS = YES 507 594 508 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 509 # names in lower-case letters. If set to YES, upper-case letters are also 510 # allowed. This is useful if you have classes or files whose names only differ 511 # in case and if your file system supports case sensitive file names. Windows 512 # and Mac users are advised to set this option to NO. 513 # The default value is: system dependent. 595 # With the correct setting of option CASE_SENSE_NAMES doxygen will better be 596 # able to match the capabilities of the underlying filesystem. In case the 597 # filesystem is case sensitive (i.e. it supports files in the same directory 598 # whose names only differ in casing), the option must be set to YES to properly 599 # deal with such files in case they appear in the input. For filesystems that 600 # are not case sensitive the option should be set to NO to properly deal with 601 # output files written for symbols that only differ in casing, such as for two 602 # classes, one named CLASS and the other named Class, and to also support 603 # references to files without having to specify the exact matching casing. On 604 # Windows (including Cygwin) and MacOS, users should typically set this option 605 # to NO, whereas on Linux or other Unix flavors it should typically be set to 606 # YES. 607 # Possible values are: SYSTEM, NO and YES. 608 # The default value is: SYSTEM. 514 609 515 610 CASE_SENSE_NAMES = NO … … 528 623 529 624 HIDE_COMPOUND_REFERENCE= NO 625 626 # If the SHOW_HEADERFILE tag is set to YES then the documentation for a class 627 # will show which file needs to be included to use the class. 628 # The default value is: YES. 629 630 SHOW_HEADERFILE = YES 530 631 531 632 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of … … 686 787 # that represents doxygen's defaults, run doxygen with the -l option. You can 687 788 # optionally specify a file name after the option, if omitted DoxygenLayout.xml 688 # will be used as the name of the layout file. 789 # will be used as the name of the layout file. See also section "Changing the 790 # layout of pages" for information. 689 791 # 690 792 # Note that if you run doxygen from a directory containing a file called … … 697 799 # the reference definitions. This must be a list of .bib files. The .bib 698 800 # extension is automatically appended if omitted. This requires the bibtex tool 699 # to be installed. See also http ://en.wikipedia.org/wiki/BibTeX for more info.801 # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. 700 802 # For LaTeX the style of the bibliography can be controlled using 701 803 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the … … 732 834 733 835 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 734 # potential errors in the documentation, such as not documenting some parameters735 # in a documented function, or documenting parameters that don't exist or using736 # markup commands wrongly.836 # potential errors in the documentation, such as documenting some parameters in 837 # a documented function twice, or documenting parameters that don't exist or 838 # using markup commands wrongly. 737 839 # The default value is: YES. 738 840 739 841 WARN_IF_DOC_ERROR = YES 842 843 # If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete 844 # function parameter documentation. If set to NO, doxygen will accept that some 845 # parameters have no documentation without warning. 846 # The default value is: YES. 847 848 WARN_IF_INCOMPLETE_DOC = YES 740 849 741 850 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 742 851 # are documented, but have no documentation for their parameters or return 743 # value. If set to NO, doxygen will only warn about wrong or incomplete 744 # parameter documentation, but not about the absence of documentation. 852 # value. If set to NO, doxygen will only warn about wrong parameter 853 # documentation, but not about the absence of documentation. If EXTRACT_ALL is 854 # set to YES then this flag will automatically be disabled. See also 855 # WARN_IF_INCOMPLETE_DOC 745 856 # The default value is: NO. 746 857 747 858 WARN_NO_PARAMDOC = NO 748 859 860 # If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about 861 # undocumented enumeration values. If set to NO, doxygen will accept 862 # undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag 863 # will automatically be disabled. 864 # The default value is: NO. 865 866 WARN_IF_UNDOC_ENUM_VAL = NO 867 749 868 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 750 # a warning is encountered. 869 # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS 870 # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but 871 # at the end of the doxygen process doxygen will return with a non-zero status. 872 # Possible values are: NO, YES and FAIL_ON_WARNINGS. 751 873 # The default value is: NO. 752 874 … … 759 881 # be replaced by the version of the file (if it could be obtained via 760 882 # FILE_VERSION_FILTER) 883 # See also: WARN_LINE_FORMAT 761 884 # The default value is: $file:$line: $text. 762 885 763 886 WARN_FORMAT = "$file:$line: $text" 887 888 # In the $text part of the WARN_FORMAT command it is possible that a reference 889 # to a more specific place is given. To make it easier to jump to this place 890 # (outside of doxygen) the user can define a custom "cut" / "paste" string. 891 # Example: 892 # WARN_LINE_FORMAT = "'vi $file +$line'" 893 # See also: WARN_FORMAT 894 # The default value is: at line $line of file $file. 895 896 WARN_LINE_FORMAT = "at line $line of file $file" 764 897 765 898 # The WARN_LOGFILE tag can be used to specify a file to which warning and error 766 899 # messages should be written. If left blank the output is written to standard 767 # error (stderr). 900 # error (stderr). In case the file specified cannot be opened for writing the 901 # warning and error messages are written to standard error. When as file - is 902 # specified the warning and error messages are written to standard output 903 # (stdout). 768 904 769 905 WARN_LOGFILE = $(PATH_TARGET)/Main.err … … 784 920 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 785 921 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 786 # documentation (see: http://www.gnu.org/software/libiconv) for the list of 787 # possible encodings. 922 # documentation (see: 923 # https://www.gnu.org/software/libiconv/) for the list of possible encodings. 924 # See also: INPUT_FILE_ENCODING 788 925 # The default value is: UTF-8. 789 926 790 927 INPUT_ENCODING = UTF-8 928 929 # This tag can be used to specify the character encoding of the source files 930 # that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify 931 # character encoding on a per file pattern basis. Doxygen will compare the file 932 # name with each pattern and apply the encoding instead of the default 933 # INPUT_ENCODING) if there is a match. The character encodings are a list of the 934 # form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding 935 # "INPUT_ENCODING" for further information on supported encodings. 936 937 INPUT_FILE_ENCODING = 791 938 792 939 # If the value of the INPUT tag contains directories, you can use the … … 798 945 # read by doxygen. 799 946 # 947 # Note the list of default checked file patterns might differ from the list of 948 # default file extension mappings. 949 # 800 950 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 801 951 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 802 # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 803 # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, 804 # *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. 952 # *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, 953 # *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C 954 # comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, 955 # *.vhdl, *.ucf, *.qsf and *.ice. 805 956 806 957 FILE_PATTERNS = … … 841 992 # output. The symbol name can be a fully qualified name, a word, or if the 842 993 # wildcard * is used, a substring. Examples: ANamespace, AClass, 843 # A Class::ANamespace, ANamespace::*Test994 # ANamespace::AClass, ANamespace::*Test 844 995 # 845 996 # Note that the wildcards are matched against the file with absolute path, so to … … 888 1039 # code is scanned, but not when the output code is generated. If lines are added 889 1040 # or removed, the anchors will not be placed correctly. 1041 # 1042 # Note that doxygen will use the data processed and written to standard output 1043 # for further processing, therefore nothing else, like debug statements or used 1044 # commands (so in case of a Windows batch file always use @echo OFF), should be 1045 # written to standard output. 890 1046 # 891 1047 # Note that for custom extensions or not directly supported extensions you also … … 930 1086 USE_MDFILE_AS_MAINPAGE = 931 1087 1088 # The Fortran standard specifies that for fixed formatted Fortran code all 1089 # characters from position 72 are to be considered as comment. A common 1090 # extension is to allow longer lines before the automatic comment starts. The 1091 # setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can 1092 # be processed before the automatic comment starts. 1093 # Minimum value: 7, maximum value: 10000, default value: 72. 1094 1095 FORTRAN_COMMENT_AFTER = 72 1096 932 1097 #--------------------------------------------------------------------------- 933 1098 # Configuration options related to source browsing … … 957 1122 958 1123 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 959 # functionall documented functions referencing it will be listed.1124 # entity all documented functions referencing it will be listed. 960 1125 # The default value is: NO. 961 1126 … … 989 1154 # point to the HTML generated by the htags(1) tool instead of doxygen built-in 990 1155 # source browser. The htags tool is part of GNU's global source tagging system 991 # (see http ://www.gnu.org/software/global/global.html). You will need version1156 # (see https://www.gnu.org/software/global/global.html). You will need version 992 1157 # 4.8.6 or higher. 993 1158 # 994 1159 # To use it do the following: 995 1160 # - Install the latest version of global 996 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file1161 # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file 997 1162 # - Make sure the INPUT points to the root of the source tree 998 1163 # - Run doxygen as normal … … 1016 1181 VERBATIM_HEADERS = YES 1017 1182 1018 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the1019 # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the1020 # cost of reduced performance. This can be particularly helpful with template1021 # rich C++ code for which doxygen's built-in parser lacks the necessary type1022 # information.1023 # Note: The availability of this option depends on whether or not doxygen was1024 # generated with the -Duse-libclang=ON option for CMake.1025 # The default value is: NO.1026 1027 CLANG_ASSISTED_PARSING = NO1028 1029 # If clang assisted parsing is enabled you can provide the compiler with command1030 # line options that you would normally use when invoking the compiler. Note that1031 # the include paths will already be set by doxygen for the files and directories1032 # specified with INPUT and INCLUDE_PATH.1033 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.1034 1035 CLANG_OPTIONS =1036 1037 1183 #--------------------------------------------------------------------------- 1038 1184 # Configuration options related to the alphabetical class index … … 1046 1192 ALPHABETICAL_INDEX = NO 1047 1193 1048 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1049 # which the alphabetical index list will be split. 1050 # Minimum value: 1, maximum value: 20, default value: 5. 1051 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1052 1053 COLS_IN_ALPHA_INDEX = 5 1054 1055 # In case all classes in a project start with a common prefix, all classes will 1056 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1057 # can be used to specify a prefix (or a list of prefixes) that should be ignored 1058 # while generating the index headers. 1194 # The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) 1195 # that should be ignored while generating the index headers. The IGNORE_PREFIX 1196 # tag works for classes, function and member names. The entity will be placed in 1197 # the alphabetical list under the first letter of the entity name that remains 1198 # after removing the prefix. 1059 1199 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1060 1200 … … 1135 1275 # Note: The order of the extra style sheet files is of importance (e.g. the last 1136 1276 # style sheet in the list overrules the setting of the previous ones in the 1137 # list). For an example see the documentation. 1277 # list). 1278 # Note: Since the styling of scrollbars can currently not be overruled in 1279 # Webkit/Chromium, the styling will be left out of the default doxygen.css if 1280 # one or more extra stylesheets have been specified. So if scrollbar 1281 # customization is desired it has to be added explicitly. For an example see the 1282 # documentation. 1138 1283 # This tag requires that the tag GENERATE_HTML is set to YES. 1139 1284 … … 1150 1295 HTML_EXTRA_FILES = 1151 1296 1297 # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output 1298 # should be rendered with a dark or light theme. 1299 # Possible values are: LIGHT always generate light mode output, DARK always 1300 # generate dark mode output, AUTO_LIGHT automatically set the mode according to 1301 # the user preference, use light mode if no preference is set (the default), 1302 # AUTO_DARK automatically set the mode according to the user preference, use 1303 # dark mode if no preference is set and TOGGLE allow to user to switch between 1304 # light and dark mode via a button. 1305 # The default value is: AUTO_LIGHT. 1306 # This tag requires that the tag GENERATE_HTML is set to YES. 1307 1308 HTML_COLORSTYLE = AUTO_LIGHT 1309 1152 1310 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1153 1311 # will adjust the colors in the style sheet and background images according to 1154 # this color. Hue is specified as an angle on a color wheel, see1155 # http ://en.wikipedia.org/wiki/Hue for more information. For instance the value1312 # this color. Hue is specified as an angle on a color-wheel, see 1313 # https://en.wikipedia.org/wiki/Hue for more information. For instance the value 1156 1314 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1157 1315 # purple, and 360 is red again. … … 1162 1320 1163 1321 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1164 # in the HTML output. For a value of 0 the output will use gray scales only. A1322 # in the HTML output. For a value of 0 the output will use gray-scales only. A 1165 1323 # value of 255 will produce the most vivid colors. 1166 1324 # Minimum value: 0, maximum value: 255, default value: 100. … … 1188 1346 1189 1347 HTML_TIMESTAMP = NO 1348 1349 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML 1350 # documentation will contain a main index with vertical navigation menus that 1351 # are dynamically created via JavaScript. If disabled, the navigation index will 1352 # consists of multiple levels of tabs that are statically embedded in every HTML 1353 # page. Disable this option to support browsers that do not have JavaScript, 1354 # like the Qt help browser. 1355 # The default value is: YES. 1356 # This tag requires that the tag GENERATE_HTML is set to YES. 1357 1358 HTML_DYNAMIC_MENUS = YES 1190 1359 1191 1360 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML … … 1212 1381 # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1213 1382 # generated that can be used as input for Apple's Xcode 3 integrated development 1214 # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1215 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1216 # Makefile in the HTML output directory. Running make will produce the docset in 1217 # that directory and running make install will install the docset in 1383 # environment (see: 1384 # https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To 1385 # create a documentation set, doxygen will generate a Makefile in the HTML 1386 # output directory. Running make will produce the docset in that directory and 1387 # running make install will install the docset in 1218 1388 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1219 # startup. See http ://developer.apple.com/tools/creatingdocsetswithdoxygen.html1220 # for more information.1389 # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy 1390 # genXcode/_index.html for more information. 1221 1391 # The default value is: NO. 1222 1392 # This tag requires that the tag GENERATE_HTML is set to YES. … … 1232 1402 DOCSET_FEEDNAME = "Doxygen generated docs" 1233 1403 1404 # This tag determines the URL of the docset feed. A documentation feed provides 1405 # an umbrella under which multiple documentation sets from a single provider 1406 # (such as a company or product suite) can be grouped. 1407 # This tag requires that the tag GENERATE_DOCSET is set to YES. 1408 1409 DOCSET_FEEDURL = 1410 1234 1411 # This tag specifies a string that should uniquely identify the documentation 1235 1412 # set bundle. This should be a reverse domain-name style string, e.g. … … 1257 1434 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1258 1435 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1259 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1260 # Windows. 1436 # on Windows. In the beginning of 2021 Microsoft took the original page, with 1437 # a.o. the download links, offline the HTML help workshop was already many years 1438 # in maintenance mode). You can download the HTML help workshop from the web 1439 # archives at Installation executable (see: 1440 # http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo 1441 # ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). 1261 1442 # 1262 1443 # The HTML Help Workshop contains a compiler that can convert all HTML output … … 1288 1469 1289 1470 # The GENERATE_CHI flag controls if a separate .chi index file is generated 1290 # (YES) or that it should be included in the ma ster.chm file (NO).1471 # (YES) or that it should be included in the main .chm file (NO). 1291 1472 # The default value is: NO. 1292 1473 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. … … 1333 1514 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1334 1515 # Project output. For more information please see Qt Help Project / Namespace 1335 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1516 # (see: 1517 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). 1336 1518 # The default value is: org.doxygen.Project. 1337 1519 # This tag requires that the tag GENERATE_QHP is set to YES. … … 1341 1523 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1342 1524 # Help Project output. For more information please see Qt Help Project / Virtual 1343 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-1344 # folders).1525 # Folders (see: 1526 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). 1345 1527 # The default value is: doc. 1346 1528 # This tag requires that the tag GENERATE_QHP is set to YES. … … 1350 1532 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1351 1533 # filter to add. For more information please see Qt Help Project / Custom 1352 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-1353 # filters).1534 # Filters (see: 1535 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). 1354 1536 # This tag requires that the tag GENERATE_QHP is set to YES. 1355 1537 … … 1358 1540 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1359 1541 # custom filter to add. For more information please see Qt Help Project / Custom 1360 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-1361 # filters).1542 # Filters (see: 1543 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). 1362 1544 # This tag requires that the tag GENERATE_QHP is set to YES. 1363 1545 … … 1366 1548 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1367 1549 # project's filter section matches. Qt Help Project / Filter Attributes (see: 1368 # http ://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).1550 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). 1369 1551 # This tag requires that the tag GENERATE_QHP is set to YES. 1370 1552 1371 1553 QHP_SECT_FILTER_ATTRS = 1372 1554 1373 # The QHG_LOCATION tag can be used to specify the location of Qt's1374 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the1375 # generated .qhp file.1555 # The QHG_LOCATION tag can be used to specify the location (absolute path 1556 # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to 1557 # run qhelpgenerator on the generated .qhp file. 1376 1558 # This tag requires that the tag GENERATE_QHP is set to YES. 1377 1559 … … 1416 1598 # (i.e. any modern browser). Windows users are probably better off using the 1417 1599 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1418 # further fine -tune the look of the index. As an example, the default style1419 # sheet generated by doxygen has an example that shows how to put an imageat1420 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has1421 # the same information as the tab index, you could consider setting1422 # DISABLE_INDEX to YES when enabling this option.1600 # further fine tune the look of the index (see "Fine-tuning the output"). As an 1601 # example, the default style sheet generated by doxygen has an example that 1602 # shows how to put an image at the root of the tree instead of the PROJECT_NAME. 1603 # Since the tree basically has the same information as the tab index, you could 1604 # consider setting DISABLE_INDEX to YES when enabling this option. 1423 1605 # The default value is: NO. 1424 1606 # This tag requires that the tag GENERATE_HTML is set to YES. 1425 1607 1426 1608 GENERATE_TREEVIEW = NO 1609 1610 # When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the 1611 # FULL_SIDEBAR option determines if the side bar is limited to only the treeview 1612 # area (value NO) or if it should extend to the full height of the window (value 1613 # YES). Setting this to YES gives a layout similar to 1614 # https://docs.readthedocs.io with more room for contents, but less room for the 1615 # project logo, title, and description. If either GENERATE_TREEVIEW or 1616 # DISABLE_INDEX is set to NO, this option has no effect. 1617 # The default value is: NO. 1618 # This tag requires that the tag GENERATE_HTML is set to YES. 1619 1620 FULL_SIDEBAR = NO 1427 1621 1428 1622 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that … … 1449 1643 1450 1644 EXT_LINKS_IN_WINDOW = NO 1645 1646 # If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email 1647 # addresses. 1648 # The default value is: YES. 1649 # This tag requires that the tag GENERATE_HTML is set to YES. 1650 1651 OBFUSCATE_EMAILS = YES 1652 1653 # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg 1654 # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see 1655 # https://inkscape.org) to generate formulas as SVG images instead of PNGs for 1656 # the HTML output. These images will generally look nicer at scaled resolutions. 1657 # Possible values are: png (the default) and svg (looks nicer but requires the 1658 # pdf2svg or inkscape tool). 1659 # The default value is: png. 1660 # This tag requires that the tag GENERATE_HTML is set to YES. 1661 1662 HTML_FORMULA_FORMAT = png 1451 1663 1452 1664 # Use this tag to change the font size of LaTeX formulas included as images in … … 1459 1671 FORMULA_FONTSIZE = 10 1460 1672 1461 # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1462 # generated for formulas are transparent PNGs. Transparent PNGs are not 1463 # supported properly for IE 6.0, but are supported on all modern browsers. 1464 # 1465 # Note that when changing this option you need to delete any form_*.png files in 1466 # the HTML output directory before the changes have effect. 1467 # The default value is: YES. 1468 # This tag requires that the tag GENERATE_HTML is set to YES. 1469 1470 FORMULA_TRANSPARENT = YES 1673 # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands 1674 # to create new LaTeX commands to be used in formulas as building blocks. See 1675 # the section "Including formulas" for details. 1676 1677 FORMULA_MACROFILE = 1471 1678 1472 1679 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1473 # http ://www.mathjax.org) which uses client side Javascript for the rendering1680 # https://www.mathjax.org) which uses client side JavaScript for the rendering 1474 1681 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1475 1682 # installed or if you want to formulas look prettier in the HTML output. When … … 1481 1688 USE_MATHJAX = NO 1482 1689 1690 # With MATHJAX_VERSION it is possible to specify the MathJax version to be used. 1691 # Note that the different versions of MathJax have different requirements with 1692 # regards to the different settings, so it is possible that also other MathJax 1693 # settings have to be changed when switching between the different MathJax 1694 # versions. 1695 # Possible values are: MathJax_2 and MathJax_3. 1696 # The default value is: MathJax_2. 1697 # This tag requires that the tag USE_MATHJAX is set to YES. 1698 1699 MATHJAX_VERSION = MathJax_2 1700 1483 1701 # When MathJax is enabled you can set the default output format to be used for 1484 # the MathJax output. See the MathJax site (see: 1485 # http://docs.mathjax.org/en/latest/output.html) for more details. 1702 # the MathJax output. For more details about the output format see MathJax 1703 # version 2 (see: 1704 # http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 1705 # (see: 1706 # http://docs.mathjax.org/en/latest/web/components/output.html). 1486 1707 # Possible values are: HTML-CSS (which is slower, but has the best 1487 # compatibility), NativeMML (i.e. MathML) and SVG. 1708 # compatibility. This is the name for Mathjax version 2, for MathJax version 3 1709 # this will be translated into chtml), NativeMML (i.e. MathML. Only supported 1710 # for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This 1711 # is the name for Mathjax version 3, for MathJax version 2 this will be 1712 # translated into HTML-CSS) and SVG. 1488 1713 # The default value is: HTML-CSS. 1489 1714 # This tag requires that the tag USE_MATHJAX is set to YES. … … 1498 1723 # Content Delivery Network so you can quickly see the result without installing 1499 1724 # MathJax. However, it is strongly recommended to install a local copy of 1500 # MathJax from http://www.mathjax.org before deployment. 1501 # The default value is: http://cdn.mathjax.org/mathjax/latest. 1725 # MathJax from https://www.mathjax.org before deployment. The default value is: 1726 # - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 1727 # - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 1502 1728 # This tag requires that the tag USE_MATHJAX is set to YES. 1503 1729 … … 1506 1732 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1507 1733 # extension names that should be enabled during MathJax rendering. For example 1734 # for MathJax version 2 (see 1735 # https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): 1508 1736 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1737 # For example for MathJax version 3 (see 1738 # http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): 1739 # MATHJAX_EXTENSIONS = ams 1509 1740 # This tag requires that the tag USE_MATHJAX is set to YES. 1510 1741 … … 1513 1744 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1514 1745 # of code that will be used on startup of the MathJax code. See the MathJax site 1515 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1746 # (see: 1747 # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an 1516 1748 # example see the documentation. 1517 1749 # This tag requires that the tag USE_MATHJAX is set to YES. … … 1541 1773 1542 1774 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1543 # implemented using a web server instead of a web client using Java script. There1775 # implemented using a web server instead of a web client using JavaScript. There 1544 1776 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH 1545 1777 # setting. When disabled, doxygen will generate a PHP script for searching and … … 1560 1792 # Doxygen ships with an example indexer (doxyindexer) and search engine 1561 1793 # (doxysearch.cgi) which are based on the open source search engine library 1562 # Xapian (see: http://xapian.org/). 1794 # Xapian (see: 1795 # https://xapian.org/). 1563 1796 # 1564 1797 # See the section "External Indexing and Searching" for details. … … 1573 1806 # Doxygen ships with an example indexer (doxyindexer) and search engine 1574 1807 # (doxysearch.cgi) which are based on the open source search engine library 1575 # Xapian (see: http://xapian.org/). See the section "External Indexing and 1576 # Searching" for details. 1808 # Xapian (see: 1809 # https://xapian.org/). See the section "External Indexing and Searching" for 1810 # details. 1577 1811 # This tag requires that the tag SEARCHENGINE is set to YES. 1578 1812 … … 1625 1859 # invoked. 1626 1860 # 1627 # Note that when enabling USE_PDFLATEX this option is only used for generating 1628 # bitmaps for formulas in the HTML output, but not in the Makefile that is 1629 # written to the output directory. 1630 # The default file is: latex. 1861 # Note that when not enabling USE_PDFLATEX the default is latex when enabling 1862 # USE_PDFLATEX the default is pdflatex and when in the later case latex is 1863 # chosen this is overwritten by pdflatex. For specific output languages the 1864 # default can have been set differently, this depends on the implementation of 1865 # the output language. 1631 1866 # This tag requires that the tag GENERATE_LATEX is set to YES. 1632 1867 … … 1635 1870 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate 1636 1871 # index for LaTeX. 1872 # Note: This tag is used in the Makefile / make.bat. 1873 # See also: LATEX_MAKEINDEX_CMD for the part in the generated output file 1874 # (.tex). 1637 1875 # The default file is: makeindex. 1638 1876 # This tag requires that the tag GENERATE_LATEX is set to YES. 1639 1877 1640 1878 MAKEINDEX_CMD_NAME = makeindex 1879 1880 # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to 1881 # generate index for LaTeX. In case there is no backslash (\) as first character 1882 # it will be automatically added in the LaTeX code. 1883 # Note: This tag is used in the generated output file (.tex). 1884 # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat. 1885 # The default value is: makeindex. 1886 # This tag requires that the tag GENERATE_LATEX is set to YES. 1887 1888 LATEX_MAKEINDEX_CMD = makeindex 1641 1889 1642 1890 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX … … 1655 1903 # This tag requires that the tag GENERATE_LATEX is set to YES. 1656 1904 1657 PAPER_TYPE = a4 wide1905 PAPER_TYPE = a4 1658 1906 1659 1907 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names … … 1669 1917 EXTRA_PACKAGES = 1670 1918 1671 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the 1672 # generated LaTeX document. The header should contain everything until the first 1673 # chapter. If it is left blank doxygen will generate a standard header. See 1674 # section "Doxygen usage" for information on how to let doxygen write the 1675 # default header to a separate file. 1676 # 1677 # Note: Only use a user-defined header if you know what you are doing! The 1678 # following commands have a special meaning inside the header: $title, 1679 # $datetime, $date, $doxygenversion, $projectname, $projectnumber, 1680 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty 1681 # string, for the replacement values of the other commands the user is referred 1682 # to HTML_HEADER. 1919 # The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for 1920 # the generated LaTeX document. The header should contain everything until the 1921 # first chapter. If it is left blank doxygen will generate a standard header. It 1922 # is highly recommended to start with a default header using 1923 # doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty 1924 # and then modify the file new_header.tex. See also section "Doxygen usage" for 1925 # information on how to generate the default header that doxygen normally uses. 1926 # 1927 # Note: Only use a user-defined header if you know what you are doing! 1928 # Note: The header is subject to change so you typically have to regenerate the 1929 # default header when upgrading to a newer version of doxygen. The following 1930 # commands have a special meaning inside the header (and footer): For a 1931 # description of the possible markers and block names see the documentation. 1683 1932 # This tag requires that the tag GENERATE_LATEX is set to YES. 1684 1933 1685 1934 LATEX_HEADER = 1686 1935 1687 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the1688 # generated LaTeX document. The footer should contain everything after the last1689 # chapter. If it is left blank doxygen will generate a standard footer. See1936 # The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for 1937 # the generated LaTeX document. The footer should contain everything after the 1938 # last chapter. If it is left blank doxygen will generate a standard footer. See 1690 1939 # LATEX_HEADER for more information on how to generate a default footer and what 1691 # special commands can be used inside the footer. 1692 # 1693 # Note: Only use a user-defined footer if you know what you are doing! 1940 # special commands can be used inside the footer. See also section "Doxygen 1941 # usage" for information on how to generate the default footer that doxygen 1942 # normally uses. Note: Only use a user-defined footer if you know what you are 1943 # doing! 1694 1944 # This tag requires that the tag GENERATE_LATEX is set to YES. 1695 1945 … … 1724 1974 PDF_HYPERLINKS = NO 1725 1975 1726 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate 1727 # the PDF file directly from the LaTeX files. Set this option to YES, to get a 1728 # higher quality PDF documentation. 1976 # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as 1977 # specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX 1978 # files. Set this option to YES, to get a higher quality PDF documentation. 1979 # 1980 # See also section LATEX_CMD_NAME for selecting the engine. 1729 1981 # The default value is: YES. 1730 1982 # This tag requires that the tag GENERATE_LATEX is set to YES. … … 1734 1986 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode 1735 1987 # command to the generated LaTeX files. This will instruct LaTeX to keep running 1736 # if errors occur, instead of asking the user for help. This option is also used 1737 # when generating formulas in HTML. 1988 # if errors occur, instead of asking the user for help. 1738 1989 # The default value is: NO. 1739 1990 # This tag requires that the tag GENERATE_LATEX is set to YES. … … 1748 1999 LATEX_HIDE_INDICES = NO 1749 2000 1750 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source1751 # code with syntax highlighting in the LaTeX output.1752 #1753 # Note that which sources are shown also depends on other settings such as1754 # SOURCE_BROWSER.1755 # The default value is: NO.1756 # This tag requires that the tag GENERATE_LATEX is set to YES.1757 1758 LATEX_SOURCE_CODE = NO1759 1760 2001 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1761 2002 # bibliography, e.g. plainnat, or ieeetr. See 1762 # http ://en.wikipedia.org/wiki/BibTeX and \cite for more info.2003 # https://en.wikipedia.org/wiki/BibTeX and \cite for more info. 1763 2004 # The default value is: plain. 1764 2005 # This tag requires that the tag GENERATE_LATEX is set to YES. … … 1773 2014 1774 2015 LATEX_TIMESTAMP = NO 2016 2017 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) 2018 # path from which the emoji images will be read. If a relative path is entered, 2019 # it will be relative to the LATEX_OUTPUT directory. If left blank the 2020 # LATEX_OUTPUT directory will be used. 2021 # This tag requires that the tag GENERATE_LATEX is set to YES. 2022 2023 LATEX_EMOJI_DIRECTORY = 1775 2024 1776 2025 #--------------------------------------------------------------------------- … … 1813 2062 RTF_HYPERLINKS = NO 1814 2063 1815 # Load stylesheet definitions from file. Syntax is similar to doxygen's config1816 # file, i.e. a series of assignments. You only have to provide replacements,1817 # missing definitions are set to their default value.2064 # Load stylesheet definitions from file. Syntax is similar to doxygen's 2065 # configuration file, i.e. a series of assignments. You only have to provide 2066 # replacements, missing definitions are set to their default value. 1818 2067 # 1819 2068 # See also section "Doxygen usage" for information on how to generate the … … 1824 2073 1825 2074 # Set optional variables used in the generation of an RTF document. Syntax is 1826 # similar to doxygen's config file. A template extensions file can be generated1827 # using doxygen -e rtf extensionFile.2075 # similar to doxygen's configuration file. A template extensions file can be 2076 # generated using doxygen -e rtf extensionFile. 1828 2077 # This tag requires that the tag GENERATE_RTF is set to YES. 1829 2078 1830 2079 RTF_EXTENSIONS_FILE = 1831 1832 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code1833 # with syntax highlighting in the RTF output.1834 #1835 # Note that which sources are shown also depends on other settings such as1836 # SOURCE_BROWSER.1837 # The default value is: NO.1838 # This tag requires that the tag GENERATE_RTF is set to YES.1839 1840 RTF_SOURCE_CODE = NO1841 2080 1842 2081 #--------------------------------------------------------------------------- … … 1911 2150 XML_PROGRAMLISTING = YES 1912 2151 2152 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include 2153 # namespace members in file scope as well, matching the HTML output. 2154 # The default value is: NO. 2155 # This tag requires that the tag GENERATE_XML is set to YES. 2156 2157 XML_NS_MEMB_FILE_SCOPE = NO 2158 1913 2159 #--------------------------------------------------------------------------- 1914 2160 # Configuration options related to the DOCBOOK output … … 1929 2175 DOCBOOK_OUTPUT = docbook 1930 2176 1931 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the1932 # program listings (including syntax highlighting and cross-referencing1933 # information) to the DOCBOOK output. Note that enabling this will significantly1934 # increase the size of the DOCBOOK output.1935 # The default value is: NO.1936 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.1937 1938 DOCBOOK_PROGRAMLISTING = NO1939 1940 2177 #--------------------------------------------------------------------------- 1941 2178 # Configuration options for the AutoGen Definitions output … … 1943 2180 1944 2181 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an 1945 # AutoGen Definitions (see http://autogen.s f.net) file that captures the1946 # structure of the code including all documentation. Note that this feature is1947 # still experimental and incomplete at the moment.2182 # AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures 2183 # the structure of the code including all documentation. Note that this feature 2184 # is still experimental and incomplete at the moment. 1948 2185 # The default value is: NO. 1949 2186 … … 2024 2261 # The INCLUDE_PATH tag can be used to specify one or more directories that 2025 2262 # contain include files that are not input files but should be processed by the 2026 # preprocessor. 2263 # preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of 2264 # RECURSIVE has no effect here. 2027 2265 # This tag requires that the tag SEARCH_INCLUDES is set to YES. 2028 2266 … … 2051 2289 # Compile assertion hacks. 2052 2290 PREDEFINED += \ 2053 "AssertCompileNS(expr)=static_assert(expr)" \2054 "AssertCompile(expr)=static_assert(expr)" \2055 "AssertCompileSize(type, size)=static_assert(true)" \2056 "AssertCompileSizeAlignment(type, align)=static_assert(true)" \2057 "AssertCompileMemberAlignment(type, member, align)=static_assert(true)" \2058 "AssertCompileMemberOffset(type, member, off)=static_assert(true)" \2059 "AssertCompile2MemberOffsets(type, member1, member2)=static_assert(true)" \2060 "AssertCompileAdjacentMembers(type, member1, member2)=static_assert(true)" \2061 "AssertCompileMembersAtSameOffset(type1, member1, type2, member2)=static_assert(true)" \2062 "AssertCompileMemberSize(type, member, size)=static_assert(true)" \2063 "AssertCompileMemberSizeAlignment(type, member, align)=static_assert(true)" \2064 "AssertCompileMembersSameSize(type1, member1, type2, member2)=static_assert(true)" \2065 "AssertCompileMembersSameSizeAndOffset(type1, member1, type2, member2)=static_assert(true)"2291 "AssertCompileNS(expr)=static_assert(expr)" \ 2292 "AssertCompile(expr)=static_assert(expr)" \ 2293 "AssertCompileSize(type, size)=static_assert(true)" \ 2294 "AssertCompileSizeAlignment(type, align)=static_assert(true)" \ 2295 "AssertCompileMemberAlignment(type, member, align)=static_assert(true)" \ 2296 "AssertCompileMemberOffset(type, member, off)=static_assert(true)" \ 2297 "AssertCompile2MemberOffsets(type, member1, member2)=static_assert(true)" \ 2298 "AssertCompileAdjacentMembers(type, member1, member2)=static_assert(true)" \ 2299 "AssertCompileMembersAtSameOffset(type1, member1, type2, member2)=static_assert(true)" \ 2300 "AssertCompileMemberSize(type, member, size)=static_assert(true)" \ 2301 "AssertCompileMemberSizeAlignment(type, member, align)=static_assert(true)" \ 2302 "AssertCompileMembersSameSize(type1, member1, type2, member2)=static_assert(true)" \ 2303 "AssertCompileMembersSameSizeAndOffset(type1, member1, type2, member2)=static_assert(true)" 2066 2304 2067 2305 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this … … 2147 2385 EXTERNAL_PAGES = YES 2148 2386 2149 # The PERL_PATH should be the absolute path and name of the perl script2150 # interpreter (i.e. the result of 'which perl').2151 # The default file (with absolute path) is: /usr/bin/perl.2152 2153 PERL_PATH = /usr/bin/perl2154 2155 2387 #--------------------------------------------------------------------------- 2156 2388 # Configuration options related to the dot tool 2157 2389 #--------------------------------------------------------------------------- 2158 2159 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram2160 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to2161 # NO turns the diagrams off. Note that this option also works with HAVE_DOT2162 # disabled, but it is recommended to install and use dot, since it yields more2163 # powerful graphs.2164 # The default value is: YES.2165 2166 CLASS_DIAGRAMS = YES2167 2168 # You can define message sequence charts within doxygen comments using the \msc2169 # command. Doxygen will then run the mscgen tool (see:2170 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the2171 # documentation. The MSCGEN_PATH tag allows you to specify the directory where2172 # the mscgen tool resides. If left empty the tool is assumed to be found in the2173 # default search path.2174 2175 MSCGEN_PATH =2176 2390 2177 2391 # You can include diagrams made with dia in doxygen documentation. Doxygen will … … 2193 2407 # Bell Labs. The other options in this section have no effect if this option is 2194 2408 # set to NO 2195 # The default value is: YES.2409 # The default value is: NO. 2196 2410 2197 2411 HAVE_DOT = NO … … 2207 2421 DOT_NUM_THREADS = 0 2208 2422 2209 # When you want a differently looking font in the dot files that doxygen 2210 # generates you can specify the font name using DOT_FONTNAME. You need to make 2211 # sure dot is able to find the font, which can be done by putting it in a 2212 # standard location or by setting the DOTFONTPATH environment variable or by 2213 # setting DOT_FONTPATH to the directory containing the font. 2214 # The default value is: Helvetica. 2423 # DOT_COMMON_ATTR is common attributes for nodes, edges and labels of 2424 # subgraphs. When you want a differently looking font in the dot files that 2425 # doxygen generates you can specify fontname, fontcolor and fontsize attributes. 2426 # For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node, 2427 # Edge and Graph Attributes specification</a> You need to make sure dot is able 2428 # to find the font, which can be done by putting it in a standard location or by 2429 # setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the 2430 # directory containing the font. Default graphviz fontsize is 14. 2431 # The default value is: fontname=Helvetica,fontsize=10. 2215 2432 # This tag requires that the tag HAVE_DOT is set to YES. 2216 2433 2217 #DOT_FONTNAME = FreeSans 2218 2219 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of 2220 # dot graphs. 2221 # Minimum value: 4, maximum value: 24, default value: 10. 2434 DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10" 2435 2436 # DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can 2437 # add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a 2438 # href=https://graphviz.org/doc/info/arrows.html>Complete documentation about 2439 # arrows shapes.</a> 2440 # The default value is: labelfontname=Helvetica,labelfontsize=10. 2222 2441 # This tag requires that the tag HAVE_DOT is set to YES. 2223 2442 2224 DOT_FONTSIZE = 10 2225 2226 # By default doxygen will tell dot to use the default font as specified with 2227 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set 2228 # the path where dot can find it using this tag. 2443 DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10" 2444 2445 # DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes 2446 # around nodes set 'shape=plain' or 'shape=plaintext' <a 2447 # href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a> 2448 # The default value is: shape=box,height=0.2,width=0.4. 2229 2449 # This tag requires that the tag HAVE_DOT is set to YES. 2230 2450 2451 DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4" 2452 2453 # You can set the path where dot can find font specified with fontname in 2454 # DOT_COMMON_ATTR and others dot attributes. 2455 # This tag requires that the tag HAVE_DOT is set to YES. 2456 2231 2457 DOT_FONTPATH = 2232 2458 2233 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for 2234 # each documented class showing the direct and indirect inheritance relations. 2235 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. 2236 # The default value is: YES. 2237 # This tag requires that the tag HAVE_DOT is set to YES. 2459 # If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a 2460 # graph for each documented class showing the direct and indirect inheritance 2461 # relations. In case HAVE_DOT is set as well dot will be used to draw the graph, 2462 # otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set 2463 # to TEXT the direct and indirect inheritance relations will be shown as texts / 2464 # links. 2465 # Possible values are: NO, YES, TEXT and GRAPH. 2466 # The default value is: YES. 2238 2467 2239 2468 CLASS_GRAPH = YES … … 2249 2478 2250 2479 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for 2251 # groups, showing the direct groups dependencies. 2480 # groups, showing the direct groups dependencies. See also the chapter Grouping 2481 # in the manual. 2252 2482 # The default value is: YES. 2253 2483 # This tag requires that the tag HAVE_DOT is set to YES. … … 2272 2502 # 10. 2273 2503 # Minimum value: 0, maximum value: 100, default value: 10. 2504 # This tag requires that the tag UML_LOOK is set to YES. 2505 2506 UML_LIMIT_NUM_FIELDS = 10 2507 2508 # If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and 2509 # methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS 2510 # tag is set to YES, doxygen will add type and arguments for attributes and 2511 # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen 2512 # will not generate fields with class member information in the UML graphs. The 2513 # class diagrams will look similar to the default class diagrams but using UML 2514 # notation for the relationships. 2515 # Possible values are: NO, YES and NONE. 2516 # The default value is: NO. 2517 # This tag requires that the tag UML_LOOK is set to YES. 2518 2519 DOT_UML_DETAILS = NO 2520 2521 # The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters 2522 # to display on a single line. If the actual line length exceeds this threshold 2523 # significantly it will wrapped across multiple lines. Some heuristics are apply 2524 # to avoid ugly line breaks. 2525 # Minimum value: 0, maximum value: 1000, default value: 17. 2274 2526 # This tag requires that the tag HAVE_DOT is set to YES. 2275 2527 2276 UML_LIMIT_NUM_FIELDS = 10 2528 DOT_WRAP_THRESHOLD = 17 2277 2529 2278 2530 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and … … 2341 2593 2342 2594 DIRECTORY_GRAPH = YES 2595 2596 # The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels 2597 # of child directories generated in directory dependency graphs by dot. 2598 # Minimum value: 1, maximum value: 25, default value: 1. 2599 # This tag requires that the tag DIRECTORY_GRAPH is set to YES. 2600 2601 DIR_GRAPH_MAX_DEPTH = 1 2343 2602 2344 2603 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images … … 2349 2608 # to make the SVG files visible in IE 9+ (other browsers do not have this 2350 2609 # requirement). 2351 # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd, 2352 # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo, 2353 # gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo, 2610 # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, 2354 2611 # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and 2355 2612 # png:gdiplus:gdiplus. … … 2397 2654 2398 2655 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the 2399 # path where java can find the plantuml.jar file . If left blank, it is assumed2400 # PlantUML is not used or called during a preprocessing step. Doxygen will2401 # generate a warning when it encounters a \startuml command in this case and2402 # will not generate output for the diagram.2656 # path where java can find the plantuml.jar file or to the filename of jar file 2657 # to be used. If left blank, it is assumed PlantUML is not used or called during 2658 # a preprocessing step. Doxygen will generate a warning when it encounters a 2659 # \startuml command in this case and will not generate output for the diagram. 2403 2660 2404 2661 PLANTUML_JAR_PATH = 2662 2663 # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a 2664 # configuration file for plantuml. 2665 2666 PLANTUML_CFG_FILE = 2405 2667 2406 2668 # When using plantuml, the specified paths are searched for files specified by … … 2433 2695 MAX_DOT_GRAPH_DEPTH = 0 2434 2696 2435 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent2436 # background. This is disabled by default, because dot on Windows does not seem2437 # to support this out of the box.2438 #2439 # Warning: Depending on the platform used, enabling this option may lead to2440 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to2441 # read).2442 # The default value is: NO.2443 # This tag requires that the tag HAVE_DOT is set to YES.2444 2445 DOT_TRANSPARENT = YES2446 2447 2697 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output 2448 2698 # files in one run (i.e. multiple -o and -T options on the command line). This … … 2457 2707 # explaining the meaning of the various boxes and arrows in the dot generated 2458 2708 # graphs. 2709 # Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal 2710 # graphical representation for inheritance and collaboration diagrams is used. 2459 2711 # The default value is: YES. 2460 2712 # This tag requires that the tag HAVE_DOT is set to YES. … … 2462 2714 GENERATE_LEGEND = YES 2463 2715 2464 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot2716 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate 2465 2717 # files that are used to generate the various graphs. 2466 # The default value is: YES. 2467 # This tag requires that the tag HAVE_DOT is set to YES. 2718 # 2719 # Note: This setting is not only used for dot files but also for msc temporary 2720 # files. 2721 # The default value is: YES. 2468 2722 2469 2723 DOT_CLEANUP = YES 2470 2471 MARKDOWN_SUPPORT=NO
Note:
See TracChangeset
for help on using the changeset viewer.
