Changeset 99763 in vbox for trunk/src/VBox/Frontends/VirtualBox/Doxyfile
- Timestamp:
- May 11, 2023 11:07:31 PM (22 months ago)
- svn:sync-xref-src-repo-rev:
- 157354
- File:
-
- 1 edited
-
trunk/src/VBox/Frontends/VirtualBox/Doxyfile (modified) (81 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/VBox/Frontends/VirtualBox/Doxyfile
r99727 r99763 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 = 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 … … 180 202 JAVADOC_AUTOBRIEF = YES 181 203 204 # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line 205 # such as 206 # /*************** 207 # as being the beginning of a Javadoc-style comment "banner". If set to NO, the 208 # Javadoc-style will behave just like regular comments and it will not be 209 # interpreted by doxygen. 210 # The default value is: NO. 211 212 JAVADOC_BANNER = NO 213 182 214 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 183 215 # line (until the first dot) of a Qt-style comment as the brief description. If … … 200 232 MULTILINE_CPP_IS_BRIEF = NO 201 233 234 # By default Python docstrings are displayed as preformatted text and doxygen's 235 # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the 236 # doxygen's special commands can be used and the contents of the docstring 237 # documentation blocks is shown as doxygen documentation. 238 # The default value is: YES. 239 240 PYTHON_DOCSTRING = YES 241 202 242 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 203 243 # documentation from any documented member that it re-implements. … … 223 263 # name=value 224 264 # For example adding 225 # "sideeffect=@par Side Effects: \n"265 # "sideeffect=@par Side Effects:^^" 226 266 # will allow you to put the command \sideeffect (or @sideeffect) in the 227 267 # documentation, which will result in a user-defined paragraph with heading 228 # "Side Effects:". You can put \n's in the value part of an alias to insert 229 # newlines. 268 # "Side Effects:". Note that you cannot put \n's in the value part of an alias 269 # to insert newlines (in the resulting output). You can put ^^ in the value part 270 # of an alias to insert a newline as if a physical newline was in the original 271 # file. When you need a literal { or } or , in the value part of an alias you 272 # have to escape them by means of a backslash (\), this can lead to conflicts 273 # with the commands \{ and \} for these it is advised to use the version @{ and 274 # @} or use a double escape (\\{ and \\}) 230 275 231 276 ALIASES = "note=@remark" \ … … 235 280 "callback_method_impl{2}=\2. Implements the callback \link \1 \1 " 236 281 237 # This tag can be used to specify a number of word-keyword mappings (TCL only).238 # A mapping has the form "name=value". For example adding "class=itcl::class"239 # will allow you to use the command class in the itcl::class meaning.240 241 TCL_SUBST =242 243 282 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 244 283 # only. Doxygen will then generate output that is more tailored for C. For … … 269 308 OPTIMIZE_OUTPUT_VHDL = NO 270 309 310 # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice 311 # sources only. Doxygen will then generate output that is more tailored for that 312 # language. For instance, namespaces will be presented as modules, types will be 313 # separated into more groups, etc. 314 # The default value is: NO. 315 316 OPTIMIZE_OUTPUT_SLICE = NO 317 271 318 # Doxygen selects the parser to use depending on the extension of the files it 272 319 # parses. With this tag you can assign which parser to use for a given 273 320 # extension. Doxygen has a built-in mapping, but you can override or extend it 274 321 # using this tag. The format is ext=language, where ext is a file extension, and 275 # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 276 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 277 # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 278 # Fortran. In the later case the parser tries to guess whether the code is fixed 279 # or free formatted code, this is the default for Fortran type files), VHDL. For 280 # instance to make doxygen treat .inc files as Fortran files (default is PHP), 281 # and .f files as C (default is Fortran), use: inc=Fortran f=C. 322 # language is one of the parsers supported by doxygen: IDL, Java, JavaScript, 323 # Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, 324 # VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: 325 # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser 326 # tries to guess whether the code is fixed or free formatted code, this is the 327 # default for Fortran type files). For instance to make doxygen treat .inc files 328 # as Fortran files (default is PHP), and .f files as C (default is Fortran), 329 # use: inc=Fortran f=C. 282 330 # 283 331 # Note: For files without extension you can use no_extension as a placeholder. 284 332 # 285 333 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 286 # the files are not read by doxygen. 334 # the files are not read by doxygen. When specifying no_extension you should add 335 # * to the FILE_PATTERNS. 336 # 337 # Note see also the list of default file extension mappings. 287 338 288 339 EXTENSION_MAPPING = … … 290 341 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 291 342 # according to the Markdown format, which allows for more readable 292 # documentation. See http ://daringfireball.net/projects/markdown/ for details.343 # documentation. See https://daringfireball.net/projects/markdown/ for details. 293 344 # The output of markdown processing is further processed by doxygen, so you can 294 345 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in … … 297 348 298 349 MARKDOWN_SUPPORT = YES 350 351 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 352 # to that level are automatically included in the table of contents, even if 353 # they do not have an id attribute. 354 # Note: This feature currently applies only to Markdown headings. 355 # Minimum value: 0, maximum value: 99, default value: 5. 356 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 357 358 TOC_INCLUDE_HEADINGS = 5 299 359 300 360 # When enabled doxygen tries to link words that correspond to documented … … 323 383 324 384 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 325 # http ://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen385 # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen 326 386 # will parse them like normal C++ but will assume all classes use public instead 327 387 # of private inheritance when no explicit protection keyword is present. … … 409 469 LOOKUP_CACHE_SIZE = 0 410 470 471 # The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use 472 # during processing. When set to 0 doxygen will based this on the number of 473 # cores available in the system. You can set it explicitly to a value larger 474 # than 0 to get more control over the balance between CPU load and processing 475 # speed. At this moment only the input processing can be done using multiple 476 # threads. Since this is still an experimental feature the default is set to 1, 477 # which effectively disables parallel processing. Please report any issues you 478 # encounter. Generating dot graphs in parallel is controlled by the 479 # DOT_NUM_THREADS setting. 480 # Minimum value: 0, maximum value: 32, default value: 1. 481 482 NUM_PROC_THREADS = 0 483 411 484 #--------------------------------------------------------------------------- 412 485 # Build related configuration options … … 429 502 EXTRACT_PRIVATE = YES 430 503 504 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual 505 # methods of a class will be included in the documentation. 506 # The default value is: NO. 507 508 EXTRACT_PRIV_VIRTUAL = NO 509 431 510 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 432 511 # scope will be included in the documentation. … … 466 545 EXTRACT_ANON_NSPACES = NO 467 546 547 # If this flag is set to YES, the name of an unnamed parameter in a declaration 548 # will be determined by the corresponding definition. By default unnamed 549 # parameters remain unnamed in the output. 550 # The default value is: YES. 551 552 RESOLVE_UNNAMED_PARAMS = YES 553 468 554 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 469 555 # undocumented members inside documented classes or files. If set to NO these … … 477 563 # undocumented classes that are normally visible in the class hierarchy. If set 478 564 # to NO, these classes will be included in the various overviews. This option 479 # has no effect if EXTRACT_ALL is enabled. 565 # will also hide undocumented C++ concepts if enabled. This option has no effect 566 # if EXTRACT_ALL is enabled. 480 567 # The default value is: NO. 481 568 … … 483 570 484 571 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 485 # (class|struct|union) declarations. If set to NO, these declarations will be486 # included in thedocumentation.572 # declarations. If set to NO, these declarations will be included in the 573 # documentation. 487 574 # The default value is: NO. 488 575 … … 503 590 INTERNAL_DOCS = YES 504 591 505 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 506 # names in lower-case letters. If set to YES, upper-case letters are also 507 # allowed. This is useful if you have classes or files whose names only differ 508 # in case and if your file system supports case sensitive file names. Windows 509 # and Mac users are advised to set this option to NO. 510 # The default value is: system dependent. 592 # With the correct setting of option CASE_SENSE_NAMES doxygen will better be 593 # able to match the capabilities of the underlying filesystem. In case the 594 # filesystem is case sensitive (i.e. it supports files in the same directory 595 # whose names only differ in casing), the option must be set to YES to properly 596 # deal with such files in case they appear in the input. For filesystems that 597 # are not case sensitive the option should be set to NO to properly deal with 598 # output files written for symbols that only differ in casing, such as for two 599 # classes, one named CLASS and the other named Class, and to also support 600 # references to files without having to specify the exact matching casing. On 601 # Windows (including Cygwin) and MacOS, users should typically set this option 602 # to NO, whereas on Linux or other Unix flavors it should typically be set to 603 # YES. 604 # Possible values are: SYSTEM, NO and YES. 605 # The default value is: SYSTEM. 511 606 512 607 CASE_SENSE_NAMES = NO … … 525 620 526 621 HIDE_COMPOUND_REFERENCE= NO 622 623 # If the SHOW_HEADERFILE tag is set to YES then the documentation for a class 624 # will show which file needs to be included to use the class. 625 # The default value is: YES. 626 627 SHOW_HEADERFILE = YES 527 628 528 629 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of … … 683 784 # that represents doxygen's defaults, run doxygen with the -l option. You can 684 785 # optionally specify a file name after the option, if omitted DoxygenLayout.xml 685 # will be used as the name of the layout file. 786 # will be used as the name of the layout file. See also section "Changing the 787 # layout of pages" for information. 686 788 # 687 789 # Note that if you run doxygen from a directory containing a file called … … 694 796 # the reference definitions. This must be a list of .bib files. The .bib 695 797 # extension is automatically appended if omitted. This requires the bibtex tool 696 # to be installed. See also http ://en.wikipedia.org/wiki/BibTeX for more info.798 # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. 697 799 # For LaTeX the style of the bibliography can be controlled using 698 800 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the … … 729 831 730 832 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 731 # potential errors in the documentation, such as not documenting some parameters732 # in a documented function, or documenting parameters that don't exist or using733 # markup commands wrongly.833 # potential errors in the documentation, such as documenting some parameters in 834 # a documented function twice, or documenting parameters that don't exist or 835 # using markup commands wrongly. 734 836 # The default value is: YES. 735 837 736 838 WARN_IF_DOC_ERROR = YES 839 840 # If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete 841 # function parameter documentation. If set to NO, doxygen will accept that some 842 # parameters have no documentation without warning. 843 # The default value is: YES. 844 845 WARN_IF_INCOMPLETE_DOC = YES 737 846 738 847 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 739 848 # are documented, but have no documentation for their parameters or return 740 # value. If set to NO, doxygen will only warn about wrong or incomplete 741 # parameter documentation, but not about the absence of documentation. 849 # value. If set to NO, doxygen will only warn about wrong parameter 850 # documentation, but not about the absence of documentation. If EXTRACT_ALL is 851 # set to YES then this flag will automatically be disabled. See also 852 # WARN_IF_INCOMPLETE_DOC 742 853 # The default value is: NO. 743 854 744 855 WARN_NO_PARAMDOC = NO 745 856 857 # If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about 858 # undocumented enumeration values. If set to NO, doxygen will accept 859 # undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag 860 # will automatically be disabled. 861 # The default value is: NO. 862 863 WARN_IF_UNDOC_ENUM_VAL = NO 864 746 865 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 747 # a warning is encountered. 866 # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS 867 # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but 868 # at the end of the doxygen process doxygen will return with a non-zero status. 869 # Possible values are: NO, YES and FAIL_ON_WARNINGS. 748 870 # The default value is: NO. 749 871 … … 756 878 # be replaced by the version of the file (if it could be obtained via 757 879 # FILE_VERSION_FILTER) 880 # See also: WARN_LINE_FORMAT 758 881 # The default value is: $file:$line: $text. 759 882 760 883 WARN_FORMAT = "$file:$line: $text" 884 885 # In the $text part of the WARN_FORMAT command it is possible that a reference 886 # to a more specific place is given. To make it easier to jump to this place 887 # (outside of doxygen) the user can define a custom "cut" / "paste" string. 888 # Example: 889 # WARN_LINE_FORMAT = "'vi $file +$line'" 890 # See also: WARN_FORMAT 891 # The default value is: at line $line of file $file. 892 893 WARN_LINE_FORMAT = "at line $line of file $file" 761 894 762 895 # The WARN_LOGFILE tag can be used to specify a file to which warning and error 763 896 # messages should be written. If left blank the output is written to standard 764 # error (stderr). 897 # error (stderr). In case the file specified cannot be opened for writing the 898 # warning and error messages are written to standard error. When as file - is 899 # specified the warning and error messages are written to standard output 900 # (stdout). 765 901 766 902 WARN_LOGFILE = … … 781 917 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 782 918 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 783 # documentation (see: http://www.gnu.org/software/libiconv) for the list of 784 # possible encodings. 919 # documentation (see: 920 # https://www.gnu.org/software/libiconv/) for the list of possible encodings. 921 # See also: INPUT_FILE_ENCODING 785 922 # The default value is: UTF-8. 786 923 787 924 INPUT_ENCODING = UTF-8 925 926 # This tag can be used to specify the character encoding of the source files 927 # that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify 928 # character encoding on a per file pattern basis. Doxygen will compare the file 929 # name with each pattern and apply the encoding instead of the default 930 # INPUT_ENCODING) if there is a match. The character encodings are a list of the 931 # form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding 932 # "INPUT_ENCODING" for further information on supported encodings. 933 934 INPUT_FILE_ENCODING = 788 935 789 936 # If the value of the INPUT tag contains directories, you can use the … … 795 942 # read by doxygen. 796 943 # 944 # Note the list of default checked file patterns might differ from the list of 945 # default file extension mappings. 946 # 797 947 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 798 948 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 799 # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 800 # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, 801 # *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. 949 # *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, 950 # *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C 951 # comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, 952 # *.vhdl, *.ucf, *.qsf and *.ice. 802 953 803 954 FILE_PATTERNS = … … 838 989 # output. The symbol name can be a fully qualified name, a word, or if the 839 990 # wildcard * is used, a substring. Examples: ANamespace, AClass, 840 # A Class::ANamespace, ANamespace::*Test991 # ANamespace::AClass, ANamespace::*Test 841 992 # 842 993 # Note that the wildcards are matched against the file with absolute path, so to … … 885 1036 # code is scanned, but not when the output code is generated. If lines are added 886 1037 # or removed, the anchors will not be placed correctly. 1038 # 1039 # Note that doxygen will use the data processed and written to standard output 1040 # for further processing, therefore nothing else, like debug statements or used 1041 # commands (so in case of a Windows batch file always use @echo OFF), should be 1042 # written to standard output. 887 1043 # 888 1044 # Note that for custom extensions or not directly supported extensions you also … … 927 1083 USE_MDFILE_AS_MAINPAGE = 928 1084 1085 # The Fortran standard specifies that for fixed formatted Fortran code all 1086 # characters from position 72 are to be considered as comment. A common 1087 # extension is to allow longer lines before the automatic comment starts. The 1088 # setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can 1089 # be processed before the automatic comment starts. 1090 # Minimum value: 7, maximum value: 10000, default value: 72. 1091 1092 FORTRAN_COMMENT_AFTER = 72 1093 929 1094 #--------------------------------------------------------------------------- 930 1095 # Configuration options related to source browsing … … 954 1119 955 1120 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 956 # functionall documented functions referencing it will be listed.1121 # entity all documented functions referencing it will be listed. 957 1122 # The default value is: NO. 958 1123 … … 986 1151 # point to the HTML generated by the htags(1) tool instead of doxygen built-in 987 1152 # source browser. The htags tool is part of GNU's global source tagging system 988 # (see http ://www.gnu.org/software/global/global.html). You will need version1153 # (see https://www.gnu.org/software/global/global.html). You will need version 989 1154 # 4.8.6 or higher. 990 1155 # 991 1156 # To use it do the following: 992 1157 # - Install the latest version of global 993 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file1158 # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file 994 1159 # - Make sure the INPUT points to the root of the source tree 995 1160 # - Run doxygen as normal … … 1013 1178 VERBATIM_HEADERS = YES 1014 1179 1015 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the1016 # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the1017 # cost of reduced performance. This can be particularly helpful with template1018 # rich C++ code for which doxygen's built-in parser lacks the necessary type1019 # information.1020 # Note: The availability of this option depends on whether or not doxygen was1021 # generated with the -Duse-libclang=ON option for CMake.1022 # The default value is: NO.1023 1024 CLANG_ASSISTED_PARSING = NO1025 1026 # If clang assisted parsing is enabled you can provide the compiler with command1027 # line options that you would normally use when invoking the compiler. Note that1028 # the include paths will already be set by doxygen for the files and directories1029 # specified with INPUT and INCLUDE_PATH.1030 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.1031 1032 CLANG_OPTIONS =1033 1034 1180 #--------------------------------------------------------------------------- 1035 1181 # Configuration options related to the alphabetical class index … … 1043 1189 ALPHABETICAL_INDEX = NO 1044 1190 1045 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1046 # which the alphabetical index list will be split. 1047 # Minimum value: 1, maximum value: 20, default value: 5. 1048 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1049 1050 COLS_IN_ALPHA_INDEX = 5 1051 1052 # In case all classes in a project start with a common prefix, all classes will 1053 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1054 # can be used to specify a prefix (or a list of prefixes) that should be ignored 1055 # while generating the index headers. 1191 # The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) 1192 # that should be ignored while generating the index headers. The IGNORE_PREFIX 1193 # tag works for classes, function and member names. The entity will be placed in 1194 # the alphabetical list under the first letter of the entity name that remains 1195 # after removing the prefix. 1056 1196 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1057 1197 … … 1132 1272 # Note: The order of the extra style sheet files is of importance (e.g. the last 1133 1273 # style sheet in the list overrules the setting of the previous ones in the 1134 # list). For an example see the documentation. 1274 # list). 1275 # Note: Since the styling of scrollbars can currently not be overruled in 1276 # Webkit/Chromium, the styling will be left out of the default doxygen.css if 1277 # one or more extra stylesheets have been specified. So if scrollbar 1278 # customization is desired it has to be added explicitly. For an example see the 1279 # documentation. 1135 1280 # This tag requires that the tag GENERATE_HTML is set to YES. 1136 1281 … … 1147 1292 HTML_EXTRA_FILES = 1148 1293 1294 # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output 1295 # should be rendered with a dark or light theme. 1296 # Possible values are: LIGHT always generate light mode output, DARK always 1297 # generate dark mode output, AUTO_LIGHT automatically set the mode according to 1298 # the user preference, use light mode if no preference is set (the default), 1299 # AUTO_DARK automatically set the mode according to the user preference, use 1300 # dark mode if no preference is set and TOGGLE allow to user to switch between 1301 # light and dark mode via a button. 1302 # The default value is: AUTO_LIGHT. 1303 # This tag requires that the tag GENERATE_HTML is set to YES. 1304 1305 HTML_COLORSTYLE = AUTO_LIGHT 1306 1149 1307 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1150 1308 # will adjust the colors in the style sheet and background images according to 1151 # this color. Hue is specified as an angle on a color wheel, see1152 # http ://en.wikipedia.org/wiki/Hue for more information. For instance the value1309 # this color. Hue is specified as an angle on a color-wheel, see 1310 # https://en.wikipedia.org/wiki/Hue for more information. For instance the value 1153 1311 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1154 1312 # purple, and 360 is red again. … … 1159 1317 1160 1318 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1161 # in the HTML output. For a value of 0 the output will use gray scales only. A1319 # in the HTML output. For a value of 0 the output will use gray-scales only. A 1162 1320 # value of 255 will produce the most vivid colors. 1163 1321 # Minimum value: 0, maximum value: 255, default value: 100. … … 1185 1343 1186 1344 HTML_TIMESTAMP = NO 1345 1346 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML 1347 # documentation will contain a main index with vertical navigation menus that 1348 # are dynamically created via JavaScript. If disabled, the navigation index will 1349 # consists of multiple levels of tabs that are statically embedded in every HTML 1350 # page. Disable this option to support browsers that do not have JavaScript, 1351 # like the Qt help browser. 1352 # The default value is: YES. 1353 # This tag requires that the tag GENERATE_HTML is set to YES. 1354 1355 HTML_DYNAMIC_MENUS = YES 1187 1356 1188 1357 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML … … 1209 1378 # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1210 1379 # generated that can be used as input for Apple's Xcode 3 integrated development 1211 # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1212 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1213 # Makefile in the HTML output directory. Running make will produce the docset in 1214 # that directory and running make install will install the docset in 1380 # environment (see: 1381 # https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To 1382 # create a documentation set, doxygen will generate a Makefile in the HTML 1383 # output directory. Running make will produce the docset in that directory and 1384 # running make install will install the docset in 1215 1385 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1216 # startup. See http ://developer.apple.com/tools/creatingdocsetswithdoxygen.html1217 # for more information.1386 # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy 1387 # genXcode/_index.html for more information. 1218 1388 # The default value is: NO. 1219 1389 # This tag requires that the tag GENERATE_HTML is set to YES. … … 1229 1399 DOCSET_FEEDNAME = "Doxygen generated docs" 1230 1400 1401 # This tag determines the URL of the docset feed. A documentation feed provides 1402 # an umbrella under which multiple documentation sets from a single provider 1403 # (such as a company or product suite) can be grouped. 1404 # This tag requires that the tag GENERATE_DOCSET is set to YES. 1405 1406 DOCSET_FEEDURL = 1407 1231 1408 # This tag specifies a string that should uniquely identify the documentation 1232 1409 # set bundle. This should be a reverse domain-name style string, e.g. … … 1254 1431 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1255 1432 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1256 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1257 # Windows. 1433 # on Windows. In the beginning of 2021 Microsoft took the original page, with 1434 # a.o. the download links, offline the HTML help workshop was already many years 1435 # in maintenance mode). You can download the HTML help workshop from the web 1436 # archives at Installation executable (see: 1437 # http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo 1438 # ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). 1258 1439 # 1259 1440 # The HTML Help Workshop contains a compiler that can convert all HTML output … … 1285 1466 1286 1467 # The GENERATE_CHI flag controls if a separate .chi index file is generated 1287 # (YES) or that it should be included in the ma ster.chm file (NO).1468 # (YES) or that it should be included in the main .chm file (NO). 1288 1469 # The default value is: NO. 1289 1470 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. … … 1330 1511 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1331 1512 # Project output. For more information please see Qt Help Project / Namespace 1332 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1513 # (see: 1514 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). 1333 1515 # The default value is: org.doxygen.Project. 1334 1516 # This tag requires that the tag GENERATE_QHP is set to YES. … … 1338 1520 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1339 1521 # Help Project output. For more information please see Qt Help Project / Virtual 1340 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-1341 # folders).1522 # Folders (see: 1523 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). 1342 1524 # The default value is: doc. 1343 1525 # This tag requires that the tag GENERATE_QHP is set to YES. … … 1347 1529 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1348 1530 # filter to add. For more information please see Qt Help Project / Custom 1349 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-1350 # filters).1531 # Filters (see: 1532 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). 1351 1533 # This tag requires that the tag GENERATE_QHP is set to YES. 1352 1534 … … 1355 1537 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1356 1538 # custom filter to add. For more information please see Qt Help Project / Custom 1357 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-1358 # filters).1539 # Filters (see: 1540 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). 1359 1541 # This tag requires that the tag GENERATE_QHP is set to YES. 1360 1542 … … 1363 1545 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1364 1546 # project's filter section matches. Qt Help Project / Filter Attributes (see: 1365 # http ://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).1547 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). 1366 1548 # This tag requires that the tag GENERATE_QHP is set to YES. 1367 1549 1368 1550 QHP_SECT_FILTER_ATTRS = 1369 1551 1370 # The QHG_LOCATION tag can be used to specify the location of Qt's1371 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the1372 # generated .qhp file.1552 # The QHG_LOCATION tag can be used to specify the location (absolute path 1553 # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to 1554 # run qhelpgenerator on the generated .qhp file. 1373 1555 # This tag requires that the tag GENERATE_QHP is set to YES. 1374 1556 … … 1413 1595 # (i.e. any modern browser). Windows users are probably better off using the 1414 1596 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1415 # further fine -tune the look of the index. As an example, the default style1416 # sheet generated by doxygen has an example that shows how to put an imageat1417 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has1418 # the same information as the tab index, you could consider setting1419 # DISABLE_INDEX to YES when enabling this option.1597 # further fine tune the look of the index (see "Fine-tuning the output"). As an 1598 # example, the default style sheet generated by doxygen has an example that 1599 # shows how to put an image at the root of the tree instead of the PROJECT_NAME. 1600 # Since the tree basically has the same information as the tab index, you could 1601 # consider setting DISABLE_INDEX to YES when enabling this option. 1420 1602 # The default value is: NO. 1421 1603 # This tag requires that the tag GENERATE_HTML is set to YES. 1422 1604 1423 1605 GENERATE_TREEVIEW = YES 1606 1607 # When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the 1608 # FULL_SIDEBAR option determines if the side bar is limited to only the treeview 1609 # area (value NO) or if it should extend to the full height of the window (value 1610 # YES). Setting this to YES gives a layout similar to 1611 # https://docs.readthedocs.io with more room for contents, but less room for the 1612 # project logo, title, and description. If either GENERATE_TREEVIEW or 1613 # DISABLE_INDEX is set to NO, this option has no effect. 1614 # The default value is: NO. 1615 # This tag requires that the tag GENERATE_HTML is set to YES. 1616 1617 FULL_SIDEBAR = NO 1424 1618 1425 1619 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that … … 1446 1640 1447 1641 EXT_LINKS_IN_WINDOW = NO 1642 1643 # If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email 1644 # addresses. 1645 # The default value is: YES. 1646 # This tag requires that the tag GENERATE_HTML is set to YES. 1647 1648 OBFUSCATE_EMAILS = YES 1649 1650 # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg 1651 # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see 1652 # https://inkscape.org) to generate formulas as SVG images instead of PNGs for 1653 # the HTML output. These images will generally look nicer at scaled resolutions. 1654 # Possible values are: png (the default) and svg (looks nicer but requires the 1655 # pdf2svg or inkscape tool). 1656 # The default value is: png. 1657 # This tag requires that the tag GENERATE_HTML is set to YES. 1658 1659 HTML_FORMULA_FORMAT = png 1448 1660 1449 1661 # Use this tag to change the font size of LaTeX formulas included as images in … … 1456 1668 FORMULA_FONTSIZE = 10 1457 1669 1458 # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1459 # generated for formulas are transparent PNGs. Transparent PNGs are not 1460 # supported properly for IE 6.0, but are supported on all modern browsers. 1461 # 1462 # Note that when changing this option you need to delete any form_*.png files in 1463 # the HTML output directory before the changes have effect. 1464 # The default value is: YES. 1465 # This tag requires that the tag GENERATE_HTML is set to YES. 1466 1467 FORMULA_TRANSPARENT = YES 1670 # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands 1671 # to create new LaTeX commands to be used in formulas as building blocks. See 1672 # the section "Including formulas" for details. 1673 1674 FORMULA_MACROFILE = 1468 1675 1469 1676 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1470 # http ://www.mathjax.org) which uses client side Javascript for the rendering1677 # https://www.mathjax.org) which uses client side JavaScript for the rendering 1471 1678 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1472 1679 # installed or if you want to formulas look prettier in the HTML output. When … … 1478 1685 USE_MATHJAX = NO 1479 1686 1687 # With MATHJAX_VERSION it is possible to specify the MathJax version to be used. 1688 # Note that the different versions of MathJax have different requirements with 1689 # regards to the different settings, so it is possible that also other MathJax 1690 # settings have to be changed when switching between the different MathJax 1691 # versions. 1692 # Possible values are: MathJax_2 and MathJax_3. 1693 # The default value is: MathJax_2. 1694 # This tag requires that the tag USE_MATHJAX is set to YES. 1695 1696 MATHJAX_VERSION = MathJax_2 1697 1480 1698 # When MathJax is enabled you can set the default output format to be used for 1481 # the MathJax output. See the MathJax site (see: 1482 # http://docs.mathjax.org/en/latest/output.html) for more details. 1699 # the MathJax output. For more details about the output format see MathJax 1700 # version 2 (see: 1701 # http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 1702 # (see: 1703 # http://docs.mathjax.org/en/latest/web/components/output.html). 1483 1704 # Possible values are: HTML-CSS (which is slower, but has the best 1484 # compatibility), NativeMML (i.e. MathML) and SVG. 1705 # compatibility. This is the name for Mathjax version 2, for MathJax version 3 1706 # this will be translated into chtml), NativeMML (i.e. MathML. Only supported 1707 # for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This 1708 # is the name for Mathjax version 3, for MathJax version 2 this will be 1709 # translated into HTML-CSS) and SVG. 1485 1710 # The default value is: HTML-CSS. 1486 1711 # This tag requires that the tag USE_MATHJAX is set to YES. … … 1495 1720 # Content Delivery Network so you can quickly see the result without installing 1496 1721 # MathJax. However, it is strongly recommended to install a local copy of 1497 # MathJax from http://www.mathjax.org before deployment. 1498 # The default value is: http://cdn.mathjax.org/mathjax/latest. 1722 # MathJax from https://www.mathjax.org before deployment. The default value is: 1723 # - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 1724 # - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 1499 1725 # This tag requires that the tag USE_MATHJAX is set to YES. 1500 1726 … … 1503 1729 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1504 1730 # extension names that should be enabled during MathJax rendering. For example 1731 # for MathJax version 2 (see https://docs.mathjax.org/en/v2.7-latest/tex.html 1732 # #tex-and-latex-extensions): 1505 1733 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1734 # For example for MathJax version 3 (see 1735 # http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): 1736 # MATHJAX_EXTENSIONS = ams 1506 1737 # This tag requires that the tag USE_MATHJAX is set to YES. 1507 1738 … … 1510 1741 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1511 1742 # of code that will be used on startup of the MathJax code. See the MathJax site 1512 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1743 # (see: 1744 # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an 1513 1745 # example see the documentation. 1514 1746 # This tag requires that the tag USE_MATHJAX is set to YES. … … 1538 1770 1539 1771 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1540 # implemented using a web server instead of a web client using Java script. There1772 # implemented using a web server instead of a web client using JavaScript. There 1541 1773 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH 1542 1774 # setting. When disabled, doxygen will generate a PHP script for searching and … … 1557 1789 # Doxygen ships with an example indexer (doxyindexer) and search engine 1558 1790 # (doxysearch.cgi) which are based on the open source search engine library 1559 # Xapian (see: http://xapian.org/). 1791 # Xapian (see: 1792 # https://xapian.org/). 1560 1793 # 1561 1794 # See the section "External Indexing and Searching" for details. … … 1570 1803 # Doxygen ships with an example indexer (doxyindexer) and search engine 1571 1804 # (doxysearch.cgi) which are based on the open source search engine library 1572 # Xapian (see: http://xapian.org/). See the section "External Indexing and 1573 # Searching" for details. 1805 # Xapian (see: 1806 # https://xapian.org/). See the section "External Indexing and Searching" for 1807 # details. 1574 1808 # This tag requires that the tag SEARCHENGINE is set to YES. 1575 1809 … … 1622 1856 # invoked. 1623 1857 # 1624 # Note that when enabling USE_PDFLATEX this option is only used for generating 1625 # bitmaps for formulas in the HTML output, but not in the Makefile that is 1626 # written to the output directory. 1627 # The default file is: latex. 1858 # Note that when not enabling USE_PDFLATEX the default is latex when enabling 1859 # USE_PDFLATEX the default is pdflatex and when in the later case latex is 1860 # chosen this is overwritten by pdflatex. For specific output languages the 1861 # default can have been set differently, this depends on the implementation of 1862 # the output language. 1628 1863 # This tag requires that the tag GENERATE_LATEX is set to YES. 1629 1864 … … 1632 1867 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate 1633 1868 # index for LaTeX. 1869 # Note: This tag is used in the Makefile / make.bat. 1870 # See also: LATEX_MAKEINDEX_CMD for the part in the generated output file 1871 # (.tex). 1634 1872 # The default file is: makeindex. 1635 1873 # This tag requires that the tag GENERATE_LATEX is set to YES. 1636 1874 1637 1875 MAKEINDEX_CMD_NAME = makeindex 1876 1877 # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to 1878 # generate index for LaTeX. In case there is no backslash (\) as first character 1879 # it will be automatically added in the LaTeX code. 1880 # Note: This tag is used in the generated output file (.tex). 1881 # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat. 1882 # The default value is: makeindex. 1883 # This tag requires that the tag GENERATE_LATEX is set to YES. 1884 1885 LATEX_MAKEINDEX_CMD = makeindex 1638 1886 1639 1887 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX … … 1652 1900 # This tag requires that the tag GENERATE_LATEX is set to YES. 1653 1901 1654 PAPER_TYPE = a4 wide1902 PAPER_TYPE = a4 1655 1903 1656 1904 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names … … 1666 1914 EXTRA_PACKAGES = 1667 1915 1668 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the 1669 # generated LaTeX document. The header should contain everything until the first 1670 # chapter. If it is left blank doxygen will generate a standard header. See 1671 # section "Doxygen usage" for information on how to let doxygen write the 1672 # default header to a separate file. 1673 # 1674 # Note: Only use a user-defined header if you know what you are doing! The 1675 # following commands have a special meaning inside the header: $title, 1676 # $datetime, $date, $doxygenversion, $projectname, $projectnumber, 1677 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty 1678 # string, for the replacement values of the other commands the user is referred 1679 # to HTML_HEADER. 1916 # The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for 1917 # the generated LaTeX document. The header should contain everything until the 1918 # first chapter. If it is left blank doxygen will generate a standard header. It 1919 # is highly recommended to start with a default header using 1920 # doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty 1921 # and then modify the file new_header.tex. See also section "Doxygen usage" for 1922 # information on how to generate the default header that doxygen normally uses. 1923 # 1924 # Note: Only use a user-defined header if you know what you are doing! 1925 # Note: The header is subject to change so you typically have to regenerate the 1926 # default header when upgrading to a newer version of doxygen. The following 1927 # commands have a special meaning inside the header (and footer): For a 1928 # description of the possible markers and block names see the documentation. 1680 1929 # This tag requires that the tag GENERATE_LATEX is set to YES. 1681 1930 1682 1931 LATEX_HEADER = 1683 1932 1684 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the1685 # generated LaTeX document. The footer should contain everything after the last1686 # chapter. If it is left blank doxygen will generate a standard footer. See1933 # The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for 1934 # the generated LaTeX document. The footer should contain everything after the 1935 # last chapter. If it is left blank doxygen will generate a standard footer. See 1687 1936 # LATEX_HEADER for more information on how to generate a default footer and what 1688 # special commands can be used inside the footer. 1689 # 1690 # Note: Only use a user-defined footer if you know what you are doing! 1937 # special commands can be used inside the footer. See also section "Doxygen 1938 # usage" for information on how to generate the default footer that doxygen 1939 # normally uses. Note: Only use a user-defined footer if you know what you are 1940 # doing! 1691 1941 # This tag requires that the tag GENERATE_LATEX is set to YES. 1692 1942 … … 1721 1971 PDF_HYPERLINKS = NO 1722 1972 1723 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate 1724 # the PDF file directly from the LaTeX files. Set this option to YES, to get a 1725 # higher quality PDF documentation. 1973 # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as 1974 # specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX 1975 # files. Set this option to YES, to get a higher quality PDF documentation. 1976 # 1977 # See also section LATEX_CMD_NAME for selecting the engine. 1726 1978 # The default value is: YES. 1727 1979 # This tag requires that the tag GENERATE_LATEX is set to YES. … … 1731 1983 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode 1732 1984 # command to the generated LaTeX files. This will instruct LaTeX to keep running 1733 # if errors occur, instead of asking the user for help. This option is also used 1734 # when generating formulas in HTML. 1985 # if errors occur, instead of asking the user for help. 1735 1986 # The default value is: NO. 1736 1987 # This tag requires that the tag GENERATE_LATEX is set to YES. … … 1745 1996 LATEX_HIDE_INDICES = NO 1746 1997 1747 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source1748 # code with syntax highlighting in the LaTeX output.1749 #1750 # Note that which sources are shown also depends on other settings such as1751 # SOURCE_BROWSER.1752 # The default value is: NO.1753 # This tag requires that the tag GENERATE_LATEX is set to YES.1754 1755 LATEX_SOURCE_CODE = NO1756 1757 1998 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1758 1999 # bibliography, e.g. plainnat, or ieeetr. See 1759 # http ://en.wikipedia.org/wiki/BibTeX and \cite for more info.2000 # https://en.wikipedia.org/wiki/BibTeX and \cite for more info. 1760 2001 # The default value is: plain. 1761 2002 # This tag requires that the tag GENERATE_LATEX is set to YES. … … 1770 2011 1771 2012 LATEX_TIMESTAMP = NO 2013 2014 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) 2015 # path from which the emoji images will be read. If a relative path is entered, 2016 # it will be relative to the LATEX_OUTPUT directory. If left blank the 2017 # LATEX_OUTPUT directory will be used. 2018 # This tag requires that the tag GENERATE_LATEX is set to YES. 2019 2020 LATEX_EMOJI_DIRECTORY = 1772 2021 1773 2022 #--------------------------------------------------------------------------- … … 1810 2059 RTF_HYPERLINKS = NO 1811 2060 1812 # Load stylesheet definitions from file. Syntax is similar to doxygen's config1813 # file, i.e. a series of assignments. You only have to provide replacements,1814 # missing definitions are set to their default value.2061 # Load stylesheet definitions from file. Syntax is similar to doxygen's 2062 # configuration file, i.e. a series of assignments. You only have to provide 2063 # replacements, missing definitions are set to their default value. 1815 2064 # 1816 2065 # See also section "Doxygen usage" for information on how to generate the … … 1821 2070 1822 2071 # Set optional variables used in the generation of an RTF document. Syntax is 1823 # similar to doxygen's config file. A template extensions file can be generated1824 # using doxygen -e rtf extensionFile.2072 # similar to doxygen's configuration file. A template extensions file can be 2073 # generated using doxygen -e rtf extensionFile. 1825 2074 # This tag requires that the tag GENERATE_RTF is set to YES. 1826 2075 1827 2076 RTF_EXTENSIONS_FILE = 1828 1829 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code1830 # with syntax highlighting in the RTF output.1831 #1832 # Note that which sources are shown also depends on other settings such as1833 # SOURCE_BROWSER.1834 # The default value is: NO.1835 # This tag requires that the tag GENERATE_RTF is set to YES.1836 1837 RTF_SOURCE_CODE = NO1838 2077 1839 2078 #--------------------------------------------------------------------------- … … 1908 2147 XML_PROGRAMLISTING = YES 1909 2148 2149 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include 2150 # namespace members in file scope as well, matching the HTML output. 2151 # The default value is: NO. 2152 # This tag requires that the tag GENERATE_XML is set to YES. 2153 2154 XML_NS_MEMB_FILE_SCOPE = NO 2155 1910 2156 #--------------------------------------------------------------------------- 1911 2157 # Configuration options related to the DOCBOOK output … … 1926 2172 DOCBOOK_OUTPUT = docbook 1927 2173 1928 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the1929 # program listings (including syntax highlighting and cross-referencing1930 # information) to the DOCBOOK output. Note that enabling this will significantly1931 # increase the size of the DOCBOOK output.1932 # The default value is: NO.1933 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.1934 1935 DOCBOOK_PROGRAMLISTING = NO1936 1937 2174 #--------------------------------------------------------------------------- 1938 2175 # Configuration options for the AutoGen Definitions output … … 1940 2177 1941 2178 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an 1942 # AutoGen Definitions (see http://autogen.s f.net) file that captures the1943 # structure of the code including all documentation. Note that this feature is1944 # still experimental and incomplete at the moment.2179 # AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures 2180 # the structure of the code including all documentation. Note that this feature 2181 # is still experimental and incomplete at the moment. 1945 2182 # The default value is: NO. 1946 2183 … … 2021 2258 # The INCLUDE_PATH tag can be used to specify one or more directories that 2022 2259 # contain include files that are not input files but should be processed by the 2023 # preprocessor. 2260 # preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of 2261 # RECURSIVE has no effect here. 2024 2262 # This tag requires that the tag SEARCH_INCLUDES is set to YES. 2025 2263 … … 2176 2414 EXTERNAL_PAGES = YES 2177 2415 2178 # The PERL_PATH should be the absolute path and name of the perl script2179 # interpreter (i.e. the result of 'which perl').2180 # The default file (with absolute path) is: /usr/bin/perl.2181 2182 PERL_PATH = /usr/bin/perl2183 2184 2416 #--------------------------------------------------------------------------- 2185 2417 # Configuration options related to the dot tool 2186 2418 #--------------------------------------------------------------------------- 2187 2188 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram2189 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to2190 # NO turns the diagrams off. Note that this option also works with HAVE_DOT2191 # disabled, but it is recommended to install and use dot, since it yields more2192 # powerful graphs.2193 # The default value is: YES.2194 2195 CLASS_DIAGRAMS = YES2196 2197 # You can define message sequence charts within doxygen comments using the \msc2198 # command. Doxygen will then run the mscgen tool (see:2199 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the2200 # documentation. The MSCGEN_PATH tag allows you to specify the directory where2201 # the mscgen tool resides. If left empty the tool is assumed to be found in the2202 # default search path.2203 2204 MSCGEN_PATH =2205 2419 2206 2420 # You can include diagrams made with dia in doxygen documentation. Doxygen will … … 2222 2436 # Bell Labs. The other options in this section have no effect if this option is 2223 2437 # set to NO 2224 # The default value is: YES.2438 # The default value is: NO. 2225 2439 2226 2440 HAVE_DOT = NO … … 2236 2450 DOT_NUM_THREADS = 0 2237 2451 2238 # When you want a differently looking font in the dot files that doxygen 2239 # generates you can specify the font name using DOT_FONTNAME. You need to make 2240 # sure dot is able to find the font, which can be done by putting it in a 2241 # standard location or by setting the DOTFONTPATH environment variable or by 2242 # setting DOT_FONTPATH to the directory containing the font. 2243 # The default value is: Helvetica. 2452 # DOT_COMMON_ATTR is common attributes for nodes, edges and labels of 2453 # subgraphs. When you want a differently looking font in the dot files that 2454 # doxygen generates you can specify fontname, fontcolor and fontsize attributes. 2455 # For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node, 2456 # Edge and Graph Attributes specification</a> You need to make sure dot is able 2457 # to find the font, which can be done by putting it in a standard location or by 2458 # setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the 2459 # directory containing the font. Default graphviz fontsize is 14. 2460 # The default value is: fontname=Helvetica,fontsize=10. 2244 2461 # This tag requires that the tag HAVE_DOT is set to YES. 2245 2462 2246 #DOT_FONTNAME = FreeSans 2247 2248 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of 2249 # dot graphs. 2250 # Minimum value: 4, maximum value: 24, default value: 10. 2463 DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10" 2464 2465 # DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can 2466 # add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a 2467 # href=https://graphviz.org/doc/info/arrows.html>Complete documentation about 2468 # arrows shapes.</a> 2469 # The default value is: labelfontname=Helvetica,labelfontsize=10. 2251 2470 # This tag requires that the tag HAVE_DOT is set to YES. 2252 2471 2253 DOT_FONTSIZE = 10 2254 2255 # By default doxygen will tell dot to use the default font as specified with 2256 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set 2257 # the path where dot can find it using this tag. 2472 DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10" 2473 2474 # DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes 2475 # around nodes set 'shape=plain' or 'shape=plaintext' <a 2476 # href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a> 2477 # The default value is: shape=box,height=0.2,width=0.4. 2258 2478 # This tag requires that the tag HAVE_DOT is set to YES. 2259 2479 2480 DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4" 2481 2482 # You can set the path where dot can find font specified with fontname in 2483 # DOT_COMMON_ATTR and others dot attributes. 2484 # This tag requires that the tag HAVE_DOT is set to YES. 2485 2260 2486 DOT_FONTPATH = 2261 2487 2262 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for 2263 # each documented class showing the direct and indirect inheritance relations. 2264 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. 2265 # The default value is: YES. 2266 # This tag requires that the tag HAVE_DOT is set to YES. 2488 # If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a 2489 # graph for each documented class showing the direct and indirect inheritance 2490 # relations. In case HAVE_DOT is set as well dot will be used to draw the graph, 2491 # otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set 2492 # to TEXT the direct and indirect inheritance relations will be shown as texts / 2493 # links. 2494 # Possible values are: NO, YES, TEXT and GRAPH. 2495 # The default value is: YES. 2267 2496 2268 2497 CLASS_GRAPH = YES … … 2278 2507 2279 2508 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for 2280 # groups, showing the direct groups dependencies. 2509 # groups, showing the direct groups dependencies. See also the chapter Grouping 2510 # in the manual. 2281 2511 # The default value is: YES. 2282 2512 # This tag requires that the tag HAVE_DOT is set to YES. … … 2301 2531 # 10. 2302 2532 # Minimum value: 0, maximum value: 100, default value: 10. 2533 # This tag requires that the tag UML_LOOK is set to YES. 2534 2535 UML_LIMIT_NUM_FIELDS = 10 2536 2537 # If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and 2538 # methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS 2539 # tag is set to YES, doxygen will add type and arguments for attributes and 2540 # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen 2541 # will not generate fields with class member information in the UML graphs. The 2542 # class diagrams will look similar to the default class diagrams but using UML 2543 # notation for the relationships. 2544 # Possible values are: NO, YES and NONE. 2545 # The default value is: NO. 2546 # This tag requires that the tag UML_LOOK is set to YES. 2547 2548 DOT_UML_DETAILS = NO 2549 2550 # The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters 2551 # to display on a single line. If the actual line length exceeds this threshold 2552 # significantly it will wrapped across multiple lines. Some heuristics are apply 2553 # to avoid ugly line breaks. 2554 # Minimum value: 0, maximum value: 1000, default value: 17. 2303 2555 # This tag requires that the tag HAVE_DOT is set to YES. 2304 2556 2305 UML_LIMIT_NUM_FIELDS = 10 2557 DOT_WRAP_THRESHOLD = 17 2306 2558 2307 2559 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and … … 2370 2622 2371 2623 DIRECTORY_GRAPH = YES 2624 2625 # The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels 2626 # of child directories generated in directory dependency graphs by dot. 2627 # Minimum value: 1, maximum value: 25, default value: 1. 2628 # This tag requires that the tag DIRECTORY_GRAPH is set to YES. 2629 2630 DIR_GRAPH_MAX_DEPTH = 1 2372 2631 2373 2632 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images … … 2378 2637 # to make the SVG files visible in IE 9+ (other browsers do not have this 2379 2638 # requirement). 2380 # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd, 2381 # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo, 2382 # gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo, 2639 # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, 2383 2640 # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and 2384 2641 # png:gdiplus:gdiplus. … … 2426 2683 2427 2684 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the 2428 # path where java can find the plantuml.jar file . If left blank, it is assumed2429 # PlantUML is not used or called during a preprocessing step. Doxygen will2430 # generate a warning when it encounters a \startuml command in this case and2431 # will not generate output for the diagram.2685 # path where java can find the plantuml.jar file or to the filename of jar file 2686 # to be used. If left blank, it is assumed PlantUML is not used or called during 2687 # a preprocessing step. Doxygen will generate a warning when it encounters a 2688 # \startuml command in this case and will not generate output for the diagram. 2432 2689 2433 2690 PLANTUML_JAR_PATH = 2691 2692 # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a 2693 # configuration file for plantuml. 2694 2695 PLANTUML_CFG_FILE = 2434 2696 2435 2697 # When using plantuml, the specified paths are searched for files specified by … … 2462 2724 MAX_DOT_GRAPH_DEPTH = 0 2463 2725 2464 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent2465 # background. This is disabled by default, because dot on Windows does not seem2466 # to support this out of the box.2467 #2468 # Warning: Depending on the platform used, enabling this option may lead to2469 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to2470 # read).2471 # The default value is: NO.2472 # This tag requires that the tag HAVE_DOT is set to YES.2473 2474 DOT_TRANSPARENT = YES2475 2476 2726 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output 2477 2727 # files in one run (i.e. multiple -o and -T options on the command line). This … … 2486 2736 # explaining the meaning of the various boxes and arrows in the dot generated 2487 2737 # graphs. 2738 # Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal 2739 # graphical representation for inheritance and collaboration diagrams is used. 2488 2740 # The default value is: YES. 2489 2741 # This tag requires that the tag HAVE_DOT is set to YES. … … 2491 2743 GENERATE_LEGEND = YES 2492 2744 2493 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot2745 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate 2494 2746 # files that are used to generate the various graphs. 2495 # The default value is: YES. 2496 # This tag requires that the tag HAVE_DOT is set to YES. 2747 # 2748 # Note: This setting is not only used for dot files but also for msc temporary 2749 # files. 2750 # The default value is: YES. 2497 2751 2498 2752 DOT_CLEANUP = YES 2499 2500 MARKDOWN_SUPPORT = NO
Note:
See TracChangeset
for help on using the changeset viewer.
