Changeset 12080 for utils/tools/SIREN/Doxyfile
- Timestamp:
- 2019-12-06T10:30:14+01:00 (5 years ago)
- File:
-
- 1 edited
-
utils/tools/SIREN/Doxyfile (modified) (101 diffs, 1 prop)
Legend:
- Unmodified
- Added
- Removed
-
utils/tools/SIREN/Doxyfile
- Property svn:keywords set to Rev
r7646 r12080 1 # Doxyfile 1.8. 81 # Doxyfile 1.8.15 2 2 3 3 # This file describes the settings to be used by the documentation system … … 18 18 #--------------------------------------------------------------------------- 19 19 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.20 # This tag specifies the encoding used for all characters in the configuration 21 # file that follow. The default is UTF-8 which is also the encoding used for all 22 # text before the first occurrence of this tag. Doxygen uses libiconv (or the 23 # iconv built into libc) for the transcoding. See 24 # https://www.gnu.org/software/libiconv/ for the list of possible encodings. 25 25 # The default value is: UTF-8. 26 26 … … 39 39 # control system is used. 40 40 41 PROJECT_NUMBER = " NEMO 3.6"41 PROJECT_NUMBER = "$Rev$" 42 42 43 43 # Using the PROJECT_BRIEF tag one can provide an optional one line description … … 47 47 PROJECT_BRIEF = "System and Interface for oceanic RElocatable Nesting" 48 48 49 # With the PROJECT_LOGO tag one can specify a n logo or icon that is included in50 # the documentation. The maximum height of the logo should not exceed 55 pixels51 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo52 # t o the output directory.49 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included 50 # in the documentation. The maximum height of the logo should not exceed 55 51 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 52 # the logo to the output directory. 53 53 54 54 PROJECT_LOGO = ./src/docsrc/Image/logoSirenNemo.png … … 61 61 OUTPUT_DIRECTORY = ./doc 62 62 63 # If the CREATE_SUBDIRS tag is set to YES ,then doxygen will create 4096 sub-63 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- 64 64 # directories (in 2 levels) under the output directory of each output format and 65 65 # will distribute the generated files over these directories. Enabling this … … 94 94 OUTPUT_LANGUAGE = English 95 95 96 # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member 96 # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all 97 # documentation generated by doxygen is written. Doxygen will use this 98 # information to generate all generated output in the proper direction. 99 # Possible values are: None, LTR, RTL and Context. 100 # The default value is: None. 101 102 OUTPUT_TEXT_DIRECTION = None 103 104 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 97 105 # descriptions after the members that are listed in the file and class 98 106 # documentation (similar to Javadoc). Set to NO to disable this. … … 101 109 BRIEF_MEMBER_DESC = YES 102 110 103 # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief111 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 104 112 # description of a member or function before the detailed description 105 113 # … … 136 144 INLINE_INHERITED_MEMB = NO 137 145 138 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path146 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 139 147 # before files name in the file list and in the header files. If set to NO the 140 148 # shortest path that makes the file name unique will be used … … 206 214 INHERIT_DOCS = YES 207 215 208 # If the SEPARATE_MEMBER_PAGES tag is set to YES , then doxygen will produce a209 # new page for each member. If set to NO, the documentation of a member will be210 # partof the file/class/namespace that contains it.216 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 217 # page for each member. If set to NO, the documentation of a member will be part 218 # of the file/class/namespace that contains it. 211 219 # The default value is: NO. 212 220 … … 227 235 # documentation, which will result in a user-defined paragraph with heading 228 236 # "Side Effects:". You can put \n's in the value part of an alias to insert 229 # newlines. 237 # newlines (in the resulting output). You can put ^^ in the value part of an 238 # alias to insert a newline as if a physical newline was in the original file. 239 # When you need a literal { or } or , in the value part of an alias you have to 240 # escape them by means of a backslash (\), this can lead to conflicts with the 241 # commands \{ and \} for these it is advised to use the version @{ and @} or use 242 # a double escape (\\{ and \\}) 230 243 231 244 ALIASES = … … 264 277 265 278 OPTIMIZE_OUTPUT_VHDL = NO 279 280 # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice 281 # sources only. Doxygen will then generate output that is more tailored for that 282 # language. For instance, namespaces will be presented as modules, types will be 283 # separated into more groups, etc. 284 # The default value is: NO. 285 286 OPTIMIZE_OUTPUT_SLICE = NO 266 287 267 288 # Doxygen selects the parser to use depending on the extension of the files it … … 270 291 # using this tag. The format is ext=language, where ext is a file extension, and 271 292 # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 272 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 273 # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 274 # Fortran. In the later case the parser tries to guess whether the code is fixed 275 # or free formatted code, this is the default for Fortran type files), VHDL. For 276 # instance to make doxygen treat .inc files as Fortran files (default is PHP), 277 # and .f files as C (default is Fortran), use: inc=Fortran f=C. 278 # 279 # Note For files without extension you can use no_extension as a placeholder. 293 # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, 294 # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: 295 # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser 296 # tries to guess whether the code is fixed or free formatted code, this is the 297 # default for Fortran type files), VHDL, tcl. For instance to make doxygen treat 298 # .inc files as Fortran files (default is PHP), and .f files as C (default is 299 # Fortran), use: inc=Fortran f=C. 300 # 301 # Note: For files without extension you can use no_extension as a placeholder. 280 302 # 281 303 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 282 304 # the files are not read by doxygen. 283 305 284 EXTENSION_MAPPING = 306 EXTENSION_MAPPING = 285 307 286 308 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 287 309 # according to the Markdown format, which allows for more readable 288 # documentation. See http ://daringfireball.net/projects/markdown/ for details.310 # documentation. See https://daringfireball.net/projects/markdown/ for details. 289 311 # The output of markdown processing is further processed by doxygen, so you can 290 312 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in … … 294 316 MARKDOWN_SUPPORT = YES 295 317 318 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 319 # to that level are automatically included in the table of contents, even if 320 # they do not have an id attribute. 321 # Note: This feature currently applies only to Markdown headings. 322 # Minimum value: 0, maximum value: 99, default value: 0. 323 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 324 325 TOC_INCLUDE_HEADINGS = 0 326 296 327 # When enabled doxygen tries to link words that correspond to documented 297 328 # classes, or namespaces to their corresponding documentation. Such a link can 298 # be prevented in individual cases by by putting a % sign in front of the word299 # orglobally by setting AUTOLINK_SUPPORT to NO.329 # be prevented in individual cases by putting a % sign in front of the word or 330 # globally by setting AUTOLINK_SUPPORT to NO. 300 331 # The default value is: YES. 301 332 … … 319 350 320 351 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 321 # http ://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen352 # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen 322 353 # will parse them like normal C++ but will assume all classes use public instead 323 354 # of private inheritance when no explicit protection keyword is present. … … 337 368 338 369 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 339 # tag is set to YES ,then doxygen will reuse the documentation of the first370 # tag is set to YES then doxygen will reuse the documentation of the first 340 371 # member in the group (if any) for the other members of the group. By default 341 372 # all members of a group must be documented explicitly. … … 343 374 344 375 DISTRIBUTE_GROUP_DOC = NO 376 377 # If one adds a struct or class to a group and this option is enabled, then also 378 # any nested class or struct is added to the same group. By default this option 379 # is disabled and one has to add nested compounds explicitly via \ingroup. 380 # The default value is: NO. 381 382 GROUP_NESTED_COMPOUNDS = NO 345 383 346 384 # Set the SUBGROUPING tag to YES to allow class member groups of the same type … … 402 440 #--------------------------------------------------------------------------- 403 441 404 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in442 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 405 443 # documentation are documented, even if no documentation was available. Private 406 444 # class members and static file members will be hidden unless the … … 412 450 EXTRACT_ALL = NO 413 451 414 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will452 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 415 453 # be included in the documentation. 416 454 # The default value is: NO. … … 418 456 EXTRACT_PRIVATE = NO 419 457 420 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal458 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 421 459 # scope will be included in the documentation. 422 460 # The default value is: NO. … … 424 462 EXTRACT_PACKAGE = NO 425 463 426 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be464 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 427 465 # included in the documentation. 428 466 # The default value is: NO. … … 430 468 EXTRACT_STATIC = NO 431 469 432 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined433 # locally in source files will be included in the documentation. If set to NO 470 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 471 # locally in source files will be included in the documentation. If set to NO, 434 472 # only classes defined in header files are included. Does not have any effect 435 473 # for Java sources. … … 438 476 EXTRACT_LOCAL_CLASSES = YES 439 477 440 # This flag is only useful for Objective-C code. When set to YESlocal methods,478 # This flag is only useful for Objective-C code. If set to YES, local methods, 441 479 # which are defined in the implementation section but not in the interface are 442 # included in the documentation. If set to NO only methods in the interface are480 # included in the documentation. If set to NO, only methods in the interface are 443 481 # included. 444 482 # The default value is: NO. … … 465 503 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 466 504 # undocumented classes that are normally visible in the class hierarchy. If set 467 # to NO these classes will be included in the various overviews. This option has468 # no effect if EXTRACT_ALL is enabled.505 # to NO, these classes will be included in the various overviews. This option 506 # has no effect if EXTRACT_ALL is enabled. 469 507 # The default value is: NO. 470 508 … … 472 510 473 511 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 474 # (class|struct|union) declarations. If set to NO these declarations will be512 # (class|struct|union) declarations. If set to NO, these declarations will be 475 513 # included in the documentation. 476 514 # The default value is: NO. … … 479 517 480 518 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 481 # documentation blocks found inside the body of a function. If set to NO these519 # documentation blocks found inside the body of a function. If set to NO, these 482 520 # blocks will be appended to the function's detailed documentation block. 483 521 # The default value is: NO. … … 493 531 494 532 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 495 # names in lower-case letters. If set to YES upper-case letters are also533 # names in lower-case letters. If set to YES, upper-case letters are also 496 534 # allowed. This is useful if you have classes or files whose names only differ 497 535 # in case and if your file system supports case sensitive file names. Windows … … 502 540 503 541 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 504 # their full class and namespace scopes in the documentation. If set to YES the542 # their full class and namespace scopes in the documentation. If set to YES, the 505 543 # scope will be hidden. 506 544 # The default value is: NO. 507 545 508 546 HIDE_SCOPE_NAMES = NO 547 548 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 549 # append additional text to a page's title, such as Class Reference. If set to 550 # YES the compound reference will be hidden. 551 # The default value is: NO. 552 553 HIDE_COMPOUND_REFERENCE= NO 509 554 510 555 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of … … 535 580 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 536 581 # (detailed) documentation of file and class members alphabetically by member 537 # name. If set to NO the members will appear in declaration order.582 # name. If set to NO, the members will appear in declaration order. 538 583 # The default value is: YES. 539 584 … … 542 587 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 543 588 # descriptions of file, namespace and class members alphabetically by member 544 # name. If set to NO the members will appear in declaration order. Note that589 # name. If set to NO, the members will appear in declaration order. Note that 545 590 # this will also influence the order of the classes in the class list. 546 591 # The default value is: NO. … … 587 632 STRICT_PROTO_MATCHING = NO 588 633 589 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the 590 # todo list. This list is created by putting \todo commands in the 591 # documentation. 634 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 635 # list. This list is created by putting \todo commands in the documentation. 592 636 # The default value is: YES. 593 637 594 638 GENERATE_TODOLIST = YES 595 639 596 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the 597 # test list. This list is created by putting \test commands in the 598 # documentation. 640 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 641 # list. This list is created by putting \test commands in the documentation. 599 642 # The default value is: YES. 600 643 601 644 GENERATE_TESTLIST = YES 602 645 603 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable (NO) the bug646 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 604 647 # list. This list is created by putting \bug commands in the documentation. 605 648 # The default value is: YES. … … 607 650 GENERATE_BUGLIST = YES 608 651 609 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable (NO)652 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 610 653 # the deprecated list. This list is created by putting \deprecated commands in 611 654 # the documentation. … … 632 675 633 676 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 634 # the bottom of the documentation of classes and structs. If set to YES the list635 # will mention the files that were used to generate the documentation.677 # the bottom of the documentation of classes and structs. If set to YES, the 678 # list will mention the files that were used to generate the documentation. 636 679 # The default value is: YES. 637 680 … … 678 721 # the reference definitions. This must be a list of .bib files. The .bib 679 722 # extension is automatically appended if omitted. This requires the bibtex tool 680 # to be installed. See also http ://en.wikipedia.org/wiki/BibTeX for more info.723 # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. 681 724 # For LaTeX the style of the bibliography can be controlled using 682 725 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the … … 697 740 698 741 # The WARNINGS tag can be used to turn on/off the warning messages that are 699 # generated to standard error ( 742 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 700 743 # this implies that the warnings are on. 701 744 # … … 705 748 WARNINGS = YES 706 749 707 # If the WARN_IF_UNDOCUMENTED tag is set to YES ,then doxygen will generate750 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 708 751 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 709 752 # will automatically be disabled. … … 722 765 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 723 766 # are documented, but have no documentation for their parameters or return 724 # value. If set to NO doxygen will only warn about wrong or incomplete parameter 725 # documentation, but not about the absence of documentation. 767 # value. If set to NO, doxygen will only warn about wrong or incomplete 768 # parameter documentation, but not about the absence of documentation. If 769 # EXTRACT_ALL is set to YES then this flag will automatically be disabled. 726 770 # The default value is: NO. 727 771 728 772 WARN_NO_PARAMDOC = NO 773 774 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 775 # a warning is encountered. 776 # The default value is: NO. 777 778 WARN_AS_ERROR = NO 729 779 730 780 # The WARN_FORMAT tag determines the format of the warning messages that doxygen … … 751 801 # documented source files. You may enter file names like myfile.cpp or 752 802 # directories like /usr/src/myproject. Separate the files or directories with 753 # spaces. 803 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 754 804 # Note: If this tag is empty the current directory is searched. 755 805 756 INPUT = ./src ./src/docsrc 806 INPUT = ./src \ 807 ./src/docsrc 757 808 758 809 # This tag can be used to specify the character encoding of the source files 759 810 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 760 811 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 761 # documentation (see: http ://www.gnu.org/software/libiconv) for the list of812 # documentation (see: https://www.gnu.org/software/libiconv/) for the list of 762 813 # possible encodings. 763 814 # The default value is: UTF-8. … … 767 818 # If the value of the INPUT tag contains directories, you can use the 768 819 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 769 # *.h) to filter out the source-files in the directories. If left blank the 770 # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, 771 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, 772 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, 773 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, 774 # *.qsf, *.as and *.js. 775 776 FILE_PATTERNS = 820 # *.h) to filter out the source-files in the directories. 821 # 822 # Note that for custom extensions or not directly supported extensions you also 823 # need to set EXTENSION_MAPPING for the extension otherwise the files are not 824 # read by doxygen. 825 # 826 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 827 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 828 # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 829 # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, 830 # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. 831 832 FILE_PATTERNS = *.f90 \ 833 *.F90 \ 834 *.md \ 835 *.dox 777 836 778 837 # The RECURSIVE tag can be used to specify whether or not subdirectories should … … 822 881 # command). 823 882 824 EXAMPLE_PATH = 883 EXAMPLE_PATH = ./src/docsrc/include/ \ 884 ./src/docsrc/include/namlog \ 885 ./src/docsrc/include/namcfg \ 886 ./src/docsrc/include/namsrc \ 887 ./src/docsrc/include/namtgt \ 888 ./src/docsrc/include/namvar \ 889 ./src/docsrc/include/namnst \ 890 ./src/docsrc/include/namout 825 891 826 892 # If the value of the EXAMPLE_PATH tag contains directories, you can use the … … 858 924 # code is scanned, but not when the output code is generated. If lines are added 859 925 # or removed, the anchors will not be placed correctly. 926 # 927 # Note that for custom extensions or not directly supported extensions you also 928 # need to set EXTENSION_MAPPING for the extension otherwise the files are not 929 # properly processed by doxygen. 860 930 861 931 INPUT_FILTER = … … 867 937 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 868 938 # patterns match the file name, INPUT_FILTER is applied. 939 # 940 # Note that for custom extensions or not directly supported extensions you also 941 # need to set EXTENSION_MAPPING for the extension otherwise the files are not 942 # properly processed by doxygen. 869 943 870 944 FILTER_PATTERNS = 871 945 872 946 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 873 # INPUT_FILTER 947 # INPUT_FILTER) will also be used to filter the input files that are used for 874 948 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 875 949 # The default value is: NO. … … 919 993 920 994 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 921 # functionall documented functions referencing it will be listed.995 # entity all documented functions referencing it will be listed. 922 996 # The default value is: NO. 923 997 … … 931 1005 932 1006 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 933 # to YES ,then the hyperlinks from functions in REFERENCES_RELATION and1007 # to YES then the hyperlinks from functions in REFERENCES_RELATION and 934 1008 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 935 1009 # link to the documentation. … … 951 1025 # point to the HTML generated by the htags(1) tool instead of doxygen built-in 952 1026 # source browser. The htags tool is part of GNU's global source tagging system 953 # (see http ://www.gnu.org/software/global/global.html). You will need version1027 # (see https://www.gnu.org/software/global/global.html). You will need version 954 1028 # 4.8.6 or higher. 955 1029 # 956 1030 # To use it do the following: 957 1031 # - Install the latest version of global 958 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file1032 # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file 959 1033 # - Make sure the INPUT points to the root of the source tree 960 1034 # - Run doxygen as normal … … 1008 1082 #--------------------------------------------------------------------------- 1009 1083 1010 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output1084 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1011 1085 # The default value is: YES. 1012 1086 … … 1074 1148 # created by doxygen. Using this option one can overrule certain style aspects. 1075 1149 # This is preferred over using HTML_STYLESHEET since it does not replace the 1076 # standard style sheet and is therefor more robust against future updates.1150 # standard style sheet and is therefore more robust against future updates. 1077 1151 # Doxygen will copy the style sheet files to the output directory. 1078 # Note: The order of the extra style sheet files is of importance (e.g. the last1079 # style sheet in the list overrules the setting of the previous ones in the1152 # Note: The order of the extra style sheet files is of importance (e.g. the last 1153 # style sheet in the list overrules the setting of the previous ones in the 1080 1154 # list). For an example see the documentation. 1081 1155 # This tag requires that the tag GENERATE_HTML is set to YES. … … 1094 1168 1095 1169 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1096 # will adjust the colors in the style sheet and background images according to1170 # will adjust the colors in the style sheet and background images according to 1097 1171 # this color. Hue is specified as an angle on a colorwheel, see 1098 # http ://en.wikipedia.org/wiki/Hue for more information. For instance the value1172 # https://en.wikipedia.org/wiki/Hue for more information. For instance the value 1099 1173 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1100 1174 # purple, and 360 is red again. … … 1125 1199 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1126 1200 # page will contain the date and time when the page was generated. Setting this 1127 # to NO can help when comparing the output of multiple runs. 1128 # The default value is: YES. 1201 # to YES can help to show when doxygen was last run and thus if the 1202 # documentation is up to date. 1203 # The default value is: NO. 1129 1204 # This tag requires that the tag GENERATE_HTML is set to YES. 1130 1205 1131 1206 HTML_TIMESTAMP = YES 1207 1208 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML 1209 # documentation will contain a main index with vertical navigation menus that 1210 # are dynamically created via Javascript. If disabled, the navigation index will 1211 # consists of multiple levels of tabs that are statically embedded in every HTML 1212 # page. Disable this option to support browsers that do not have Javascript, 1213 # like the Qt help browser. 1214 # The default value is: YES. 1215 # This tag requires that the tag GENERATE_HTML is set to YES. 1216 1217 HTML_DYNAMIC_MENUS = YES 1132 1218 1133 1219 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML … … 1154 1240 # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1155 1241 # generated that can be used as input for Apple's Xcode 3 integrated development 1156 # environment (see: http ://developer.apple.com/tools/xcode/), introduced with1157 # OSX10.5 (Leopard). To create a documentation set, doxygen will generate a1242 # environment (see: https://developer.apple.com/xcode/), introduced with OSX 1243 # 10.5 (Leopard). To create a documentation set, doxygen will generate a 1158 1244 # Makefile in the HTML output directory. Running make will produce the docset in 1159 1245 # that directory and running make install will install the docset in 1160 1246 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1161 # startup. See http ://developer.apple.com/tools/creatingdocsetswithdoxygen.html1162 # for more information.1247 # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy 1248 # genXcode/_index.html for more information. 1163 1249 # The default value is: NO. 1164 1250 # This tag requires that the tag GENERATE_HTML is set to YES. … … 1199 1285 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1200 1286 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1201 # (see: http ://www.microsoft.com/en-us/download/details.aspx?id=21138) on1287 # (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1202 1288 # Windows. 1203 1289 # … … 1222 1308 1223 1309 # The HHC_LOCATION tag can be used to specify the location (absolute path 1224 # including file name) of the HTML help compiler ( hhc.exe). If non-empty1310 # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1225 1311 # doxygen will try to run the HTML help compiler on the generated index.hhp. 1226 1312 # The file has to be specified with full path. … … 1229 1315 HHC_LOCATION = 1230 1316 1231 # The GENERATE_CHI flag controls if a separate .chi index file is generated (1232 # YES) or that it should be included in the master .chm file (NO).1317 # The GENERATE_CHI flag controls if a separate .chi index file is generated 1318 # (YES) or that it should be included in the master .chm file (NO). 1233 1319 # The default value is: NO. 1234 1320 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. … … 1236 1322 GENERATE_CHI = NO 1237 1323 1238 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content (hhc)1324 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1239 1325 # and project file content. 1240 1326 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. … … 1242 1328 CHM_INDEX_ENCODING = 1243 1329 1244 # The BINARY_TOC flag controls whether a binary table of contents is generated (1245 # YES) or a normal table of contents (NO) in the .chm file. Furthermore it1330 # The BINARY_TOC flag controls whether a binary table of contents is generated 1331 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1246 1332 # enables the Previous and Next buttons. 1247 1333 # The default value is: NO. … … 1275 1361 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1276 1362 # Project output. For more information please see Qt Help Project / Namespace 1277 # (see: http:// qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).1363 # (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). 1278 1364 # The default value is: org.doxygen.Project. 1279 1365 # This tag requires that the tag GENERATE_QHP is set to YES. … … 1283 1369 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1284 1370 # Help Project output. For more information please see Qt Help Project / Virtual 1285 # Folders (see: http:// qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-1371 # Folders (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- 1286 1372 # folders). 1287 1373 # The default value is: doc. … … 1292 1378 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1293 1379 # filter to add. For more information please see Qt Help Project / Custom 1294 # Filters (see: http:// qt-project.org/doc/qt-4.8/qthelpproject.html#custom-1380 # Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- 1295 1381 # filters). 1296 1382 # This tag requires that the tag GENERATE_QHP is set to YES. … … 1300 1386 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1301 1387 # custom filter to add. For more information please see Qt Help Project / Custom 1302 # Filters (see: http:// qt-project.org/doc/qt-4.8/qthelpproject.html#custom-1388 # Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- 1303 1389 # filters). 1304 1390 # This tag requires that the tag GENERATE_QHP is set to YES. … … 1308 1394 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1309 1395 # project's filter section matches. Qt Help Project / Filter Attributes (see: 1310 # http:// qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).1396 # http://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). 1311 1397 # This tag requires that the tag GENERATE_QHP is set to YES. 1312 1398 … … 1357 1443 # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1358 1444 # (i.e. any modern browser). Windows users are probably better off using the 1359 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can1445 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1360 1446 # further fine-tune the look of the index. As an example, the default style 1361 1447 # sheet generated by doxygen has an example that shows how to put an image at … … 1385 1471 TREEVIEW_WIDTH = 250 1386 1472 1387 # When the EXT_LINKS_IN_WINDOW option is set to YESdoxygen will open links to1473 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1388 1474 # external symbols imported via tag files in a separate window. 1389 1475 # The default value is: NO. … … 1401 1487 FORMULA_FONTSIZE = 10 1402 1488 1403 # Use the FORMULA_TRAN PARENT tag to determine whether or not the images1489 # Use the FORMULA_TRANSPARENT tag to determine whether or not the images 1404 1490 # generated for formulas are transparent PNGs. Transparent PNGs are not 1405 1491 # supported properly for IE 6.0, but are supported on all modern browsers. … … 1413 1499 1414 1500 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1415 # http ://www.mathjax.org) which uses client side Javascript for the rendering1416 # instead of using pre rendered bitmaps. Use this if you do not have LaTeX1501 # https://www.mathjax.org) which uses client side Javascript for the rendering 1502 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1417 1503 # installed or if you want to formulas look prettier in the HTML output. When 1418 1504 # enabled you may also need to install MathJax separately and configure the path … … 1440 1526 # Content Delivery Network so you can quickly see the result without installing 1441 1527 # MathJax. However, it is strongly recommended to install a local copy of 1442 # MathJax from http ://www.mathjax.org before deployment.1443 # The default value is: http ://cdn.mathjax.org/mathjax/latest.1528 # MathJax from https://www.mathjax.org before deployment. 1529 # The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. 1444 1530 # This tag requires that the tag USE_MATHJAX is set to YES. 1445 1531 … … 1500 1586 # search results. 1501 1587 # 1502 # Doxygen ships with an example indexer ( 1588 # Doxygen ships with an example indexer (doxyindexer) and search engine 1503 1589 # (doxysearch.cgi) which are based on the open source search engine library 1504 # Xapian (see: http ://xapian.org/).1590 # Xapian (see: https://xapian.org/). 1505 1591 # 1506 1592 # See the section "External Indexing and Searching" for details. … … 1513 1599 # which will return the search results when EXTERNAL_SEARCH is enabled. 1514 1600 # 1515 # Doxygen ships with an example indexer ( 1601 # Doxygen ships with an example indexer (doxyindexer) and search engine 1516 1602 # (doxysearch.cgi) which are based on the open source search engine library 1517 # Xapian (see: http ://xapian.org/). See the section "External Indexing and1603 # Xapian (see: https://xapian.org/). See the section "External Indexing and 1518 1604 # Searching" for details. 1519 1605 # This tag requires that the tag SEARCHENGINE is set to YES. … … 1551 1637 #--------------------------------------------------------------------------- 1552 1638 1553 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.1639 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. 1554 1640 # The default value is: YES. 1555 1641 … … 1567 1653 # invoked. 1568 1654 # 1569 # Note that when enabling USE_PDFLATEX this option is only used for generating 1570 # bitmaps for formulas in the HTML output, but not in the Makefile that is 1571 # written to the output directory. 1572 # The default file is: latex. 1655 # Note that when not enabling USE_PDFLATEX the default is latex when enabling 1656 # USE_PDFLATEX the default is pdflatex and when in the later case latex is 1657 # chosen this is overwritten by pdflatex. For specific output languages the 1658 # default can have been set differently, this depends on the implementation of 1659 # the output language. 1573 1660 # This tag requires that the tag GENERATE_LATEX is set to YES. 1574 1661 … … 1577 1664 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate 1578 1665 # index for LaTeX. 1666 # Note: This tag is used in the Makefile / make.bat. 1667 # See also: LATEX_MAKEINDEX_CMD for the part in the generated output file 1668 # (.tex). 1579 1669 # The default file is: makeindex. 1580 1670 # This tag requires that the tag GENERATE_LATEX is set to YES. … … 1582 1672 MAKEINDEX_CMD_NAME = makeindex 1583 1673 1584 # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX 1674 # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to 1675 # generate index for LaTeX. 1676 # Note: This tag is used in the generated output file (.tex). 1677 # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat. 1678 # The default value is: \makeindex. 1679 # This tag requires that the tag GENERATE_LATEX is set to YES. 1680 1681 LATEX_MAKEINDEX_CMD = \makeindex 1682 1683 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX 1585 1684 # documents. This may be useful for small projects and may help to save some 1586 1685 # trees in general. … … 1600 1699 1601 1700 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names 1602 # that should be included in the LaTeX output. To get the times font for 1603 # instance you can specify 1604 # EXTRA_PACKAGES=times 1701 # that should be included in the LaTeX output. The package can be specified just 1702 # by its name or with the correct syntax as to be used with the LaTeX 1703 # \usepackage command. To get the times font for instance you can specify : 1704 # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times} 1705 # To use the option intlimits with the amsmath package you can specify: 1706 # EXTRA_PACKAGES=[intlimits]{amsmath} 1605 1707 # If left blank no extra packages will be included. 1606 1708 # This tag requires that the tag GENERATE_LATEX is set to YES. … … 1617 1719 # following commands have a special meaning inside the header: $title, 1618 1720 # $datetime, $date, $doxygenversion, $projectname, $projectnumber, 1619 # $projectbrief, $projectlogo. Doxygen will replace $title with the emp y string,1620 # for the replacement values of the other commands the user is refered to1621 # HTML_HEADER.1721 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty 1722 # string, for the replacement values of the other commands the user is referred 1723 # to HTML_HEADER. 1622 1724 # This tag requires that the tag GENERATE_LATEX is set to YES. 1623 1725 … … 1635 1737 LATEX_FOOTER = 1636 1738 1739 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1740 # LaTeX style sheets that are included after the standard style sheets created 1741 # by doxygen. Using this option one can overrule certain style aspects. Doxygen 1742 # will copy the style sheet files to the output directory. 1743 # Note: The order of the extra style sheet files is of importance (e.g. the last 1744 # style sheet in the list overrules the setting of the previous ones in the 1745 # list). 1746 # This tag requires that the tag GENERATE_LATEX is set to YES. 1747 1748 LATEX_EXTRA_STYLESHEET = 1749 1637 1750 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or 1638 1751 # other source files which should be copied to the LATEX_OUTPUT output … … 1653 1766 1654 1767 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate 1655 # the PDF file directly from the LaTeX files. Set this option to YES to get a1768 # the PDF file directly from the LaTeX files. Set this option to YES, to get a 1656 1769 # higher quality PDF documentation. 1657 1770 # The default value is: YES. … … 1688 1801 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1689 1802 # bibliography, e.g. plainnat, or ieeetr. See 1690 # http ://en.wikipedia.org/wiki/BibTeX and \cite for more info.1803 # https://en.wikipedia.org/wiki/BibTeX and \cite for more info. 1691 1804 # The default value is: plain. 1692 1805 # This tag requires that the tag GENERATE_LATEX is set to YES. … … 1694 1807 LATEX_BIB_STYLE = plain 1695 1808 1809 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated 1810 # page will contain the date and time when the page was generated. Setting this 1811 # to NO can help when comparing the output of multiple runs. 1812 # The default value is: NO. 1813 # This tag requires that the tag GENERATE_LATEX is set to YES. 1814 1815 LATEX_TIMESTAMP = NO 1816 1817 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) 1818 # path from which the emoji images will be read. If a relative path is entered, 1819 # it will be relative to the LATEX_OUTPUT directory. If left blank the 1820 # LATEX_OUTPUT directory will be used. 1821 # This tag requires that the tag GENERATE_LATEX is set to YES. 1822 1823 LATEX_EMOJI_DIRECTORY = 1824 1696 1825 #--------------------------------------------------------------------------- 1697 1826 # Configuration options related to the RTF output 1698 1827 #--------------------------------------------------------------------------- 1699 1828 1700 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The1829 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The 1701 1830 # RTF output is optimized for Word 97 and may not look too pretty with other RTF 1702 1831 # readers/editors. … … 1713 1842 RTF_OUTPUT = rtf 1714 1843 1715 # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF1844 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF 1716 1845 # documents. This may be useful for small projects and may help to save some 1717 1846 # trees in general. … … 1733 1862 RTF_HYPERLINKS = NO 1734 1863 1735 # Load stylesheet definitions from file. Syntax is similar to doxygen's config1736 # file, i.e. a series of assignments. You only have to provide replacements,1737 # missing definitions are set to their default value.1864 # Load stylesheet definitions from file. Syntax is similar to doxygen's 1865 # configuration file, i.e. a series of assignments. You only have to provide 1866 # replacements, missing definitions are set to their default value. 1738 1867 # 1739 1868 # See also section "Doxygen usage" for information on how to generate the … … 1744 1873 1745 1874 # Set optional variables used in the generation of an RTF document. Syntax is 1746 # similar to doxygen's config file. A template extensions file can be generated1747 # using doxygen -e rtf extensionFile.1875 # similar to doxygen's configuration file. A template extensions file can be 1876 # generated using doxygen -e rtf extensionFile. 1748 1877 # This tag requires that the tag GENERATE_RTF is set to YES. 1749 1878 1750 1879 RTF_EXTENSIONS_FILE = 1751 1880 1881 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code 1882 # with syntax highlighting in the RTF output. 1883 # 1884 # Note that which sources are shown also depends on other settings such as 1885 # SOURCE_BROWSER. 1886 # The default value is: NO. 1887 # This tag requires that the tag GENERATE_RTF is set to YES. 1888 1889 RTF_SOURCE_CODE = NO 1890 1752 1891 #--------------------------------------------------------------------------- 1753 1892 # Configuration options related to the man page output 1754 1893 #--------------------------------------------------------------------------- 1755 1894 1756 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for1895 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for 1757 1896 # classes and files. 1758 1897 # The default value is: NO. … … 1798 1937 #--------------------------------------------------------------------------- 1799 1938 1800 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that1939 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that 1801 1940 # captures the structure of the code including all documentation. 1802 1941 # The default value is: NO. … … 1812 1951 XML_OUTPUT = xml 1813 1952 1814 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program1953 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program 1815 1954 # listings (including syntax highlighting and cross-referencing information) to 1816 1955 # the XML output. Note that enabling this will significantly increase the size … … 1821 1960 XML_PROGRAMLISTING = YES 1822 1961 1962 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include 1963 # namespace members in file scope as well, matching the HTML output. 1964 # The default value is: NO. 1965 # This tag requires that the tag GENERATE_XML is set to YES. 1966 1967 XML_NS_MEMB_FILE_SCOPE = NO 1968 1823 1969 #--------------------------------------------------------------------------- 1824 1970 # Configuration options related to the DOCBOOK output 1825 1971 #--------------------------------------------------------------------------- 1826 1972 1827 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files1973 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files 1828 1974 # that can be used to generate PDF. 1829 1975 # The default value is: NO. … … 1839 1985 DOCBOOK_OUTPUT = docbook 1840 1986 1841 # If the DOCBOOK_PROGRAMLISTING tag is set to YES doxygen will include the1987 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the 1842 1988 # program listings (including syntax highlighting and cross-referencing 1843 1989 # information) to the DOCBOOK output. Note that enabling this will significantly … … 1852 1998 #--------------------------------------------------------------------------- 1853 1999 1854 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen1855 # Definitions (see http://autogen.sf.net) file that captures the structure of1856 # the code including all documentation. Note that this feature is still1857 # experimental and incomplete at the moment.2000 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an 2001 # AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures 2002 # the structure of the code including all documentation. Note that this feature 2003 # is still experimental and incomplete at the moment. 1858 2004 # The default value is: NO. 1859 2005 … … 1864 2010 #--------------------------------------------------------------------------- 1865 2011 1866 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module2012 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module 1867 2013 # file that captures the structure of the code including all documentation. 1868 2014 # … … 1872 2018 GENERATE_PERLMOD = NO 1873 2019 1874 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary2020 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary 1875 2021 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI 1876 2022 # output from the Perl module output. … … 1880 2026 PERLMOD_LATEX = NO 1881 2027 1882 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely2028 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely 1883 2029 # formatted so it can be parsed by a human reader. This is useful if you want to 1884 # understand what is going on. On the other hand, if this tag is set to NO the2030 # understand what is going on. On the other hand, if this tag is set to NO, the 1885 2031 # size of the Perl module output will be much smaller and Perl will parse it 1886 2032 # just the same. … … 1902 2048 #--------------------------------------------------------------------------- 1903 2049 1904 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all2050 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all 1905 2051 # C-preprocessor directives found in the sources and include files. 1906 2052 # The default value is: YES. … … 1908 2054 ENABLE_PREPROCESSING = YES 1909 2055 1910 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names1911 # in the source code. If set to NO only conditional compilation will be2056 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names 2057 # in the source code. If set to NO, only conditional compilation will be 1912 2058 # performed. Macro expansion can be done in a controlled way by setting 1913 2059 # EXPAND_ONLY_PREDEF to YES. … … 1925 2071 EXPAND_ONLY_PREDEF = NO 1926 2072 1927 # If the SEARCH_INCLUDES tag is set to YES the includesfiles in the2073 # If the SEARCH_INCLUDES tag is set to YES, the include files in the 1928 2074 # INCLUDE_PATH will be searched if a #include is found. 1929 2075 # The default value is: YES. … … 2001 2147 GENERATE_TAGFILE = 2002 2148 2003 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the 2004 # class index. If set to NO only the inherited external classes will be listed. 2149 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in 2150 # the class index. If set to NO, only the inherited external classes will be 2151 # listed. 2005 2152 # The default value is: NO. 2006 2153 2007 2154 ALLEXTERNALS = NO 2008 2155 2009 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in2010 # the modules index. If set to NO, only the current project's groups will be2156 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed 2157 # in the modules index. If set to NO, only the current project's groups will be 2011 2158 # listed. 2012 2159 # The default value is: YES. … … 2014 2161 EXTERNAL_GROUPS = YES 2015 2162 2016 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in2163 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in 2017 2164 # the related pages index. If set to NO, only the current project's pages will 2018 2165 # be listed. … … 2031 2178 #--------------------------------------------------------------------------- 2032 2179 2033 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram2180 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram 2034 2181 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to 2035 2182 # NO turns the diagrams off. Note that this option also works with HAVE_DOT … … 2056 2203 DIA_PATH = 2057 2204 2058 # If set to YES ,the inheritance and collaboration graphs will hide inheritance2205 # If set to YES the inheritance and collaboration graphs will hide inheritance 2059 2206 # and usage relations if the target is undocumented or is not a class. 2060 2207 # The default value is: YES. … … 2129 2276 GROUP_GRAPHS = YES 2130 2277 2131 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and2278 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and 2132 2279 # collaboration diagrams in a style similar to the OMG's Unified Modeling 2133 2280 # Language. … … 2181 2328 # Note that enabling this option will significantly increase the time of a run. 2182 2329 # So in most cases it will be better to enable call graphs for selected 2183 # functions only using the \callgraph command. 2330 # functions only using the \callgraph command. Disabling a call graph can be 2331 # accomplished by means of the command \hidecallgraph. 2184 2332 # The default value is: NO. 2185 2333 # This tag requires that the tag HAVE_DOT is set to YES. … … 2192 2340 # Note that enabling this option will significantly increase the time of a run. 2193 2341 # So in most cases it will be better to enable caller graphs for selected 2194 # functions only using the \callergraph command. 2342 # functions only using the \callergraph command. Disabling a caller graph can be 2343 # accomplished by means of the command \hidecallergraph. 2195 2344 # The default value is: NO. 2196 2345 # This tag requires that the tag HAVE_DOT is set to YES. … … 2215 2364 2216 2365 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 2217 # generated by dot. 2366 # generated by dot. For an explanation of the image formats see the section 2367 # output formats in the documentation of the dot tool (Graphviz (see: 2368 # http://www.graphviz.org/)). 2218 2369 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order 2219 2370 # to make the SVG files visible in IE 9+ (other browsers do not have this 2220 2371 # requirement). 2221 # Possible values are: png, jpg, gif and svg. 2372 # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, 2373 # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and 2374 # png:gdiplus:gdiplus. 2222 2375 # The default value is: png. 2223 2376 # This tag requires that the tag HAVE_DOT is set to YES. … … 2267 2420 # generate a warning when it encounters a \startuml command in this case and 2268 2421 # will not generate output for the diagram. 2269 # This tag requires that the tag HAVE_DOT is set to YES.2270 2422 2271 2423 PLANTUML_JAR_PATH = 2424 2425 # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a 2426 # configuration file for plantuml. 2427 2428 PLANTUML_CFG_FILE = 2429 2430 # When using plantuml, the specified paths are searched for files specified by 2431 # the !include statement in a plantuml block. 2432 2433 PLANTUML_INCLUDE_PATH = 2272 2434 2273 2435 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes … … 2307 2469 DOT_TRANSPARENT = NO 2308 2470 2309 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output2471 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output 2310 2472 # files in one run (i.e. multiple -o and -T options on the command line). This 2311 2473 # makes dot run faster, but since only newer versions of dot (>1.8.10) support … … 2324 2486 GENERATE_LEGEND = YES 2325 2487 2326 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot2488 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot 2327 2489 # files that are used to generate the various graphs. 2328 2490 # The default value is: YES.
Note: See TracChangeset
for help on using the changeset viewer.
