- Timestamp:
- Jul 20, 2016, 3:46:42 PM (8 years ago)
- Branches:
- feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master, pitchshift, sampler, timestretch, yinfft+
- Children:
- 288c193
- Parents:
- 5f852c1
- Location:
- doc
- Files:
-
- 2 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/full.cfg
r5f852c1 r413bc0f 1 # Doxyfile 1.8. 51 # Doxyfile 1.8.8 2 2 3 3 # This file describes the settings to be used by the documentation system … … 71 71 CREATE_SUBDIRS = NO 72 72 73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 74 # characters to appear in the names of generated files. If set to NO, non-ASCII 75 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 76 # U+3044. 77 # The default value is: NO. 78 79 ALLOW_UNICODE_NAMES = NO 80 73 81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 74 82 # documentation generated by doxygen is written. Doxygen will use this 75 83 # information to generate all constant output in the proper language. 76 # Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese- 77 # Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi, 78 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en, 79 # Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish, 80 # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, 81 # Turkish, Ukrainian and Vietnamese. 84 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 85 # Chinese-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. 82 92 # The default value is: English. 83 93 … … 260 270 # using this tag. The format is ext=language, where ext is a file extension, and 261 271 # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 262 # C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make 263 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C 264 # (default is Fortran), use: inc=Fortran f=C. 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. 265 278 # 266 279 # Note For files without extension you can use no_extension as a placeholder. … … 501 514 SHOW_INCLUDE_FILES = YES 502 515 516 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 517 # grouped member an include statement to the documentation, telling the reader 518 # which file to include in order to use the member. 519 # The default value is: NO. 520 521 SHOW_GROUPED_MEMB_INC = NO 522 503 523 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 504 524 # files with double quotes in the documentation rather than with sharp brackets. … … 522 542 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 523 543 # descriptions of file, namespace and class members alphabetically by member 524 # name. If set to NO the members will appear in declaration order. 544 # name. If set to NO the members will appear in declaration order. Note that 545 # this will also influence the order of the classes in the class list. 525 546 # The default value is: NO. 526 547 … … 660 681 # For LaTeX the style of the bibliography can be controlled using 661 682 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 662 # search path. Do not use file names with spaces, bibtex cannot handle them. See 663 # also \cite for info how to create references. 683 # search path. See also \cite for info how to create references. 664 684 665 685 CITE_BIB_FILES = … … 959 979 960 980 VERBATIM_HEADERS = YES 981 982 # If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the 983 # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the 984 # cost of reduced performance. This can be particularly helpful with template 985 # rich C++ code for which doxygen's built-in parser lacks the necessary type 986 # information. 987 # Note: The availability of this option depends on whether or not doxygen was 988 # compiled with the --with-libclang option. 989 # The default value is: NO. 990 991 CLANG_ASSISTED_PARSING = NO 992 993 # If clang assisted parsing is enabled you can provide the compiler with command 994 # line options that you would normally use when invoking the compiler. Note that 995 # the include paths will already be set by doxygen for the files and directories 996 # specified with INPUT and INCLUDE_PATH. 997 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. 998 999 CLANG_OPTIONS = 961 1000 962 1001 #--------------------------------------------------------------------------- … … 1052 1091 HTML_STYLESHEET = 1053 1092 1054 # The HTML_EXTRA_STYLESHEET tag can be used to specify a n additional user-1055 # defined cascading style sheet that isincluded after the standard style sheets1093 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1094 # cascading style sheets that are included after the standard style sheets 1056 1095 # created by doxygen. Using this option one can overrule certain style aspects. 1057 1096 # This is preferred over using HTML_STYLESHEET since it does not replace the 1058 1097 # standard style sheet and is therefor more robust against future updates. 1059 # Doxygen will copy the style sheet file to the output directory. For an example 1060 # see the documentation. 1098 # Doxygen will copy the style sheet files to the output directory. 1099 # Note: The order of the extra stylesheet files is of importance (e.g. the last 1100 # stylesheet in the list overrules the setting of the previous ones in the 1101 # list). For an example see the documentation. 1061 1102 # This tag requires that the tag GENERATE_HTML is set to YES. 1062 1103 … … 1223 1264 1224 1265 # The BINARY_TOC flag controls whether a binary table of contents is generated ( 1225 # YES) or a normal table of contents ( NO) in the .chm file. 1266 # YES) or a normal table of contents ( NO) in the .chm file. Furthermore it 1267 # enables the Previous and Next buttons. 1226 1268 # The default value is: NO. 1227 1269 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. … … 1463 1505 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1464 1506 # implemented using a web server instead of a web client using Javascript. There 1465 # are two flavo urs of web server based searching depending on the1466 # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for1467 # searching and an index file used by the script. When EXTERNAL_SEARCH is1468 # enabled the indexing and searching needs to be provided by external tools. See1469 # the section"External Indexing and Searching" for details.1507 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH 1508 # setting. When disabled, doxygen will generate a PHP script for searching and 1509 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing 1510 # and searching needs to be provided by external tools. See the section 1511 # "External Indexing and Searching" for details. 1470 1512 # The default value is: NO. 1471 1513 # This tag requires that the tag SEARCHENGINE is set to YES. … … 1595 1637 # Note: Only use a user-defined header if you know what you are doing! The 1596 1638 # following commands have a special meaning inside the header: $title, 1597 # $datetime, $date, $doxygenversion, $projectname, $projectnumber . Doxygen will1598 # replace them by respectively the title of the page, the current date and time,1599 # only the current date, the version number of doxygen, the project name (see1600 # PROJECT_NAME), or the project number (see PROJECT_NUMBER).1639 # $datetime, $date, $doxygenversion, $projectname, $projectnumber, 1640 # $projectbrief, $projectlogo. Doxygen will replace $title with the empy string, 1641 # for the replacement values of the other commands the user is refered to 1642 # HTML_HEADER. 1601 1643 # This tag requires that the tag GENERATE_LATEX is set to YES. 1602 1644 … … 1605 1647 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the 1606 1648 # generated LaTeX document. The footer should contain everything after the last 1607 # chapter. If it is left blank doxygen will generate a standard footer. 1649 # chapter. If it is left blank doxygen will generate a standard footer. See 1650 # LATEX_HEADER for more information on how to generate a default footer and what 1651 # special commands can be used inside the footer. 1608 1652 # 1609 1653 # Note: Only use a user-defined footer if you know what you are doing! … … 1629 1673 PDF_HYPERLINKS = YES 1630 1674 1631 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate1675 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate 1632 1676 # the PDF file directly from the LaTeX files. Set this option to YES to get a 1633 1677 # higher quality PDF documentation. … … 1755 1799 MAN_EXTENSION = .3 1756 1800 1801 # The MAN_SUBDIR tag determines the name of the directory created within 1802 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by 1803 # MAN_EXTENSION with the initial . removed. 1804 # This tag requires that the tag GENERATE_MAN is set to YES. 1805 1806 MAN_SUBDIR = 1807 1757 1808 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it 1758 1809 # will generate one additional man file for each entity documented in the real … … 1782 1833 XML_OUTPUT = xml 1783 1834 1784 # The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a1785 # validating XML parser to check the syntax of the XML files.1786 # This tag requires that the tag GENERATE_XML is set to YES.1787 1788 XML_SCHEMA =1789 1790 # The XML_DTD tag can be used to specify a XML DTD, which can be used by a1791 # validating XML parser to check the syntax of the XML files.1792 # This tag requires that the tag GENERATE_XML is set to YES.1793 1794 XML_DTD =1795 1796 1835 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program 1797 1836 # listings (including syntax highlighting and cross-referencing information) to … … 1820 1859 1821 1860 DOCBOOK_OUTPUT = docbook 1861 1862 # If the DOCBOOK_PROGRAMLISTING tag is set to YES doxygen will include the 1863 # program listings (including syntax highlighting and cross-referencing 1864 # information) to the DOCBOOK output. Note that enabling this will significantly 1865 # increase the size of the DOCBOOK output. 1866 # The default value is: NO. 1867 # This tag requires that the tag GENERATE_DOCBOOK is set to YES. 1868 1869 DOCBOOK_PROGRAMLISTING = NO 1822 1870 1823 1871 #--------------------------------------------------------------------------- … … 1940 1988 1941 1989 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will 1942 # remove all ref rences to function-like macros that are alone on a line, have an1943 # a ll uppercase name, and do not end with a semicolon. Such function macros are1944 # typically used for boiler-plate code, and will confuse the parser if not1990 # remove all references to function-like macros that are alone on a line, have 1991 # an all uppercase name, and do not end with a semicolon. Such function macros 1992 # are typically used for boiler-plate code, and will confuse the parser if not 1945 1993 # removed. 1946 1994 # The default value is: YES. … … 1962 2010 # section "Linking to external documentation" for more information about the use 1963 2011 # of tag files. 1964 # Note: Each tag file must have a nunique name (where the name does NOT include2012 # Note: Each tag file must have a unique name (where the name does NOT include 1965 2013 # the path). If a tag file is not located in the directory in which doxygen is 1966 2014 # run, you must also specify the path to the tagfile here. … … 2022 2070 MSCGEN_PATH = 2023 2071 2072 # You can include diagrams made with dia in doxygen documentation. Doxygen will 2073 # then run dia to produce the diagram and insert it in the documentation. The 2074 # DIA_PATH tag allows you to specify the directory where the dia binary resides. 2075 # If left empty dia is assumed to be found in the default search path. 2076 2077 DIA_PATH = 2078 2024 2079 # If set to YES, the inheritance and collaboration graphs will hide inheritance 2025 2080 # and usage relations if the target is undocumented or is not a class. … … 2033 2088 # Bell Labs. The other options in this section have no effect if this option is 2034 2089 # set to NO 2035 # The default value is: NO.2090 # The default value is: YES. 2036 2091 2037 2092 HAVE_DOT = NO … … 2047 2102 DOT_NUM_THREADS = 0 2048 2103 2049 # When you want a differently looking font n the dot files that doxygen2104 # When you want a differently looking font in the dot files that doxygen 2050 2105 # generates you can specify the font name using DOT_FONTNAME. You need to make 2051 2106 # sure dot is able to find the font, which can be done by putting it in a … … 2185 2240 # to make the SVG files visible in IE 9+ (other browsers do not have this 2186 2241 # requirement). 2187 # Possible values are: png, jpg, gif and svg. 2242 # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd, 2243 # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo, 2244 # gif:cairo:gd, gif:gd, gif:gd:gd and svg. 2188 2245 # The default value is: png. 2189 2246 # This tag requires that the tag HAVE_DOT is set to YES. … … 2221 2278 2222 2279 MSCFILE_DIRS = 2280 2281 # The DIAFILE_DIRS tag can be used to specify one or more directories that 2282 # contain dia files that are included in the documentation (see the \diafile 2283 # command). 2284 2285 DIAFILE_DIRS = 2286 2287 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the 2288 # path where java can find the plantuml.jar file. If left blank, it is assumed 2289 # PlantUML is not used or called during a preprocessing step. Doxygen will 2290 # generate a warning when it encounters a \startuml command in this case and 2291 # will not generate output for the diagram. 2292 # This tag requires that the tag HAVE_DOT is set to YES. 2293 2294 PLANTUML_JAR_PATH = 2223 2295 2224 2296 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes -
doc/web.cfg
r5f852c1 r413bc0f 1 # Doxyfile 1.8. 51 # Doxyfile 1.8.8 2 2 3 3 # This file describes the settings to be used by the documentation system … … 71 71 CREATE_SUBDIRS = NO 72 72 73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 74 # characters to appear in the names of generated files. If set to NO, non-ASCII 75 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 76 # U+3044. 77 # The default value is: NO. 78 79 ALLOW_UNICODE_NAMES = NO 80 73 81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 74 82 # documentation generated by doxygen is written. Doxygen will use this 75 83 # information to generate all constant output in the proper language. 76 # Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese- 77 # Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi, 78 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en, 79 # Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish, 80 # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, 81 # Turkish, Ukrainian and Vietnamese. 84 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 85 # Chinese-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. 82 92 # The default value is: English. 83 93 … … 260 270 # using this tag. The format is ext=language, where ext is a file extension, and 261 271 # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 262 # C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make 263 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C 264 # (default is Fortran), use: inc=Fortran f=C. 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. 265 278 # 266 279 # Note For files without extension you can use no_extension as a placeholder. … … 501 514 SHOW_INCLUDE_FILES = YES 502 515 516 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 517 # grouped member an include statement to the documentation, telling the reader 518 # which file to include in order to use the member. 519 # The default value is: NO. 520 521 SHOW_GROUPED_MEMB_INC = NO 522 503 523 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 504 524 # files with double quotes in the documentation rather than with sharp brackets. … … 522 542 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 523 543 # descriptions of file, namespace and class members alphabetically by member 524 # name. If set to NO the members will appear in declaration order. 544 # name. If set to NO the members will appear in declaration order. Note that 545 # this will also influence the order of the classes in the class list. 525 546 # The default value is: NO. 526 547 … … 660 681 # For LaTeX the style of the bibliography can be controlled using 661 682 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 662 # search path. Do not use file names with spaces, bibtex cannot handle them. See 663 # also \cite for info how to create references. 683 # search path. See also \cite for info how to create references. 664 684 665 685 CITE_BIB_FILES = … … 979 999 VERBATIM_HEADERS = YES 980 1000 1001 # If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the 1002 # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the 1003 # cost of reduced performance. This can be particularly helpful with template 1004 # rich C++ code for which doxygen's built-in parser lacks the necessary type 1005 # information. 1006 # Note: The availability of this option depends on whether or not doxygen was 1007 # compiled with the --with-libclang option. 1008 # The default value is: NO. 1009 1010 CLANG_ASSISTED_PARSING = NO 1011 1012 # If clang assisted parsing is enabled you can provide the compiler with command 1013 # line options that you would normally use when invoking the compiler. Note that 1014 # the include paths will already be set by doxygen for the files and directories 1015 # specified with INPUT and INCLUDE_PATH. 1016 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. 1017 1018 CLANG_OPTIONS = 1019 981 1020 #--------------------------------------------------------------------------- 982 1021 # Configuration options related to the alphabetical class index … … 1071 1110 HTML_STYLESHEET = 1072 1111 1073 # The HTML_EXTRA_STYLESHEET tag can be used to specify a n additional user-1074 # defined cascading style sheet that isincluded after the standard style sheets1112 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1113 # cascading style sheets that are included after the standard style sheets 1075 1114 # created by doxygen. Using this option one can overrule certain style aspects. 1076 1115 # This is preferred over using HTML_STYLESHEET since it does not replace the 1077 1116 # standard style sheet and is therefor more robust against future updates. 1078 # Doxygen will copy the style sheet file to the output directory. For an example 1079 # see the documentation. 1117 # Doxygen will copy the style sheet files to the output directory. 1118 # Note: The order of the extra stylesheet files is of importance (e.g. the last 1119 # stylesheet in the list overrules the setting of the previous ones in the 1120 # list). For an example see the documentation. 1080 1121 # This tag requires that the tag GENERATE_HTML is set to YES. 1081 1122 … … 1242 1283 1243 1284 # The BINARY_TOC flag controls whether a binary table of contents is generated ( 1244 # YES) or a normal table of contents ( NO) in the .chm file. 1285 # YES) or a normal table of contents ( NO) in the .chm file. Furthermore it 1286 # enables the Previous and Next buttons. 1245 1287 # The default value is: NO. 1246 1288 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. … … 1482 1524 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1483 1525 # implemented using a web server instead of a web client using Javascript. There 1484 # are two flavo urs of web server based searching depending on the1485 # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for1486 # searching and an index file used by the script. When EXTERNAL_SEARCH is1487 # enabled the indexing and searching needs to be provided by external tools. See1488 # the section"External Indexing and Searching" for details.1526 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH 1527 # setting. When disabled, doxygen will generate a PHP script for searching and 1528 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing 1529 # and searching needs to be provided by external tools. See the section 1530 # "External Indexing and Searching" for details. 1489 1531 # The default value is: NO. 1490 1532 # This tag requires that the tag SEARCHENGINE is set to YES. … … 1614 1656 # Note: Only use a user-defined header if you know what you are doing! The 1615 1657 # following commands have a special meaning inside the header: $title, 1616 # $datetime, $date, $doxygenversion, $projectname, $projectnumber . Doxygen will1617 # replace them by respectively the title of the page, the current date and time,1618 # only the current date, the version number of doxygen, the project name (see1619 # PROJECT_NAME), or the project number (see PROJECT_NUMBER).1658 # $datetime, $date, $doxygenversion, $projectname, $projectnumber, 1659 # $projectbrief, $projectlogo. Doxygen will replace $title with the empy string, 1660 # for the replacement values of the other commands the user is refered to 1661 # HTML_HEADER. 1620 1662 # This tag requires that the tag GENERATE_LATEX is set to YES. 1621 1663 … … 1624 1666 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the 1625 1667 # generated LaTeX document. The footer should contain everything after the last 1626 # chapter. If it is left blank doxygen will generate a standard footer. 1668 # chapter. If it is left blank doxygen will generate a standard footer. See 1669 # LATEX_HEADER for more information on how to generate a default footer and what 1670 # special commands can be used inside the footer. 1627 1671 # 1628 1672 # Note: Only use a user-defined footer if you know what you are doing! … … 1648 1692 PDF_HYPERLINKS = YES 1649 1693 1650 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate1694 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate 1651 1695 # the PDF file directly from the LaTeX files. Set this option to YES to get a 1652 1696 # higher quality PDF documentation. … … 1774 1818 MAN_EXTENSION = .3 1775 1819 1820 # The MAN_SUBDIR tag determines the name of the directory created within 1821 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by 1822 # MAN_EXTENSION with the initial . removed. 1823 # This tag requires that the tag GENERATE_MAN is set to YES. 1824 1825 MAN_SUBDIR = 1826 1776 1827 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it 1777 1828 # will generate one additional man file for each entity documented in the real … … 1801 1852 XML_OUTPUT = xml 1802 1853 1803 # The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a1804 # validating XML parser to check the syntax of the XML files.1805 # This tag requires that the tag GENERATE_XML is set to YES.1806 1807 XML_SCHEMA =1808 1809 # The XML_DTD tag can be used to specify a XML DTD, which can be used by a1810 # validating XML parser to check the syntax of the XML files.1811 # This tag requires that the tag GENERATE_XML is set to YES.1812 1813 XML_DTD =1814 1815 1854 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program 1816 1855 # listings (including syntax highlighting and cross-referencing information) to … … 1839 1878 1840 1879 DOCBOOK_OUTPUT = docbook 1880 1881 # If the DOCBOOK_PROGRAMLISTING tag is set to YES doxygen will include the 1882 # program listings (including syntax highlighting and cross-referencing 1883 # information) to the DOCBOOK output. Note that enabling this will significantly 1884 # increase the size of the DOCBOOK output. 1885 # The default value is: NO. 1886 # This tag requires that the tag GENERATE_DOCBOOK is set to YES. 1887 1888 DOCBOOK_PROGRAMLISTING = NO 1841 1889 1842 1890 #--------------------------------------------------------------------------- … … 1959 2007 1960 2008 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will 1961 # remove all ref rences to function-like macros that are alone on a line, have an1962 # a ll uppercase name, and do not end with a semicolon. Such function macros are1963 # typically used for boiler-plate code, and will confuse the parser if not2009 # remove all references to function-like macros that are alone on a line, have 2010 # an all uppercase name, and do not end with a semicolon. Such function macros 2011 # are typically used for boiler-plate code, and will confuse the parser if not 1964 2012 # removed. 1965 2013 # The default value is: YES. … … 1981 2029 # section "Linking to external documentation" for more information about the use 1982 2030 # of tag files. 1983 # Note: Each tag file must have a nunique name (where the name does NOT include2031 # Note: Each tag file must have a unique name (where the name does NOT include 1984 2032 # the path). If a tag file is not located in the directory in which doxygen is 1985 2033 # run, you must also specify the path to the tagfile here. … … 2041 2089 MSCGEN_PATH = 2042 2090 2091 # You can include diagrams made with dia in doxygen documentation. Doxygen will 2092 # then run dia to produce the diagram and insert it in the documentation. The 2093 # DIA_PATH tag allows you to specify the directory where the dia binary resides. 2094 # If left empty dia is assumed to be found in the default search path. 2095 2096 DIA_PATH = 2097 2043 2098 # If set to YES, the inheritance and collaboration graphs will hide inheritance 2044 2099 # and usage relations if the target is undocumented or is not a class. … … 2052 2107 # Bell Labs. The other options in this section have no effect if this option is 2053 2108 # set to NO 2054 # The default value is: NO.2109 # The default value is: YES. 2055 2110 2056 2111 HAVE_DOT = NO … … 2066 2121 DOT_NUM_THREADS = 0 2067 2122 2068 # When you want a differently looking font n the dot files that doxygen2123 # When you want a differently looking font in the dot files that doxygen 2069 2124 # generates you can specify the font name using DOT_FONTNAME. You need to make 2070 2125 # sure dot is able to find the font, which can be done by putting it in a … … 2204 2259 # to make the SVG files visible in IE 9+ (other browsers do not have this 2205 2260 # requirement). 2206 # Possible values are: png, jpg, gif and svg. 2261 # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd, 2262 # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo, 2263 # gif:cairo:gd, gif:gd, gif:gd:gd and svg. 2207 2264 # The default value is: png. 2208 2265 # This tag requires that the tag HAVE_DOT is set to YES. … … 2240 2297 2241 2298 MSCFILE_DIRS = 2299 2300 # The DIAFILE_DIRS tag can be used to specify one or more directories that 2301 # contain dia files that are included in the documentation (see the \diafile 2302 # command). 2303 2304 DIAFILE_DIRS = 2305 2306 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the 2307 # path where java can find the plantuml.jar file. If left blank, it is assumed 2308 # PlantUML is not used or called during a preprocessing step. Doxygen will 2309 # generate a warning when it encounters a \startuml command in this case and 2310 # will not generate output for the diagram. 2311 # This tag requires that the tag HAVE_DOT is set to YES. 2312 2313 PLANTUML_JAR_PATH = 2242 2314 2243 2315 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
Note: See TracChangeset
for help on using the changeset viewer.
