Changeset 9a83b91 for doc/devel.cfg
- Timestamp:
- May 18, 2006, 8:51:59 PM (18 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:
- e604630
- Parents:
- 6e35163
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/devel.cfg
r6e35163 r9a83b91 1 # Doxyfile 1. 3.41 # Doxyfile 1.4.6 2 2 3 3 # This file describes the settings to be used by the documentation system … … 24 24 # if some version control system is used. 25 25 26 PROJECT_NUMBER = 0. 2.026 PROJECT_NUMBER = 0.3.0 27 27 28 28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) … … 33 33 OUTPUT_DIRECTORY = devel 34 34 35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 36 # 4096 sub-directories (in 2 levels) under the output directory of each output 37 # format and will distribute the generated files over these directories. 38 # Enabling this option can be useful when feeding doxygen a huge amount of 39 # source files, where putting all generated files in the same directory would 40 # otherwise cause performance problems for the file system. 41 42 CREATE_SUBDIRS = NO 43 35 44 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 36 45 # documentation generated by doxygen is written. Doxygen will use this 37 46 # information to generate all constant output in the proper language. 38 47 # The default language is English, other supported languages are: 39 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, 40 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en 41 # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese, 42 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. 48 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, 49 # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, 50 # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, 51 # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, 52 # Swedish, and Ukrainian. 43 53 44 54 OUTPUT_LANGUAGE = English … … 68 78 REPEAT_BRIEF = YES 69 79 80 # This tag implements a quasi-intelligent brief description abbreviator 81 # that is used to form the text in various listings. Each string 82 # in this list, if found as the leading text of the brief description, will be 83 # stripped from the text and the result after processing the whole list, is 84 # used as the annotated text. Otherwise, the brief description is used as-is. 85 # If left blank, the following values are used ("$name" is automatically 86 # replaced with the name of the entity): "The $name class" "The $name widget" 87 # "The $name file" "is" "provides" "specifies" "contains" 88 # "represents" "a" "an" "the" 89 90 ABBREVIATE_BRIEF = 91 70 92 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 71 93 # Doxygen will generate a detailed section even if there is only a brief … … 74 96 ALWAYS_DETAILED_SEC = NO 75 97 76 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited77 # members of a class in the documentation of that class as if those members were78 # ordinary class members. Constructors, destructors and assignment operators of79 # the base classes will not be shown.98 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 99 # inherited members of a class in the documentation of that class as if those 100 # members were ordinary class members. Constructors, destructors and assignment 101 # operators of the base classes will not be shown. 80 102 81 103 INLINE_INHERITED_MEMB = NO … … 90 112 # can be used to strip a user-defined part of the path. Stripping is 91 113 # only done if one of the specified strings matches the left-hand part of 92 # the path. It is allowed to use relative paths in the argument list. 114 # the path. The tag can be used to show relative paths in the file list. 115 # If left blank the directory from which doxygen is run is used as the 116 # path to strip. 93 117 94 118 STRIP_FROM_PATH = 119 120 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 121 # the path mentioned in the documentation of a class, which tells 122 # the reader which header file to include in order to use a class. 123 # If left blank only the name of the header file containing the class 124 # definition is used. Otherwise one should specify the include paths that 125 # are normally passed to the compiler using the -I flag. 126 127 STRIP_FROM_INC_PATH = 95 128 96 129 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter … … 104 137 # comment as the brief description. If set to NO, the JavaDoc 105 138 # comments will behave just like the Qt-style comments (thus requiring an 106 # explic t @brief command for a brief description.139 # explicit @brief command for a brief description. 107 140 108 141 JAVADOC_AUTOBRIEF = YES … … 125 158 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 126 159 # member inherits the documentation from any documented member that it 127 # re implements.160 # re-implements. 128 161 129 162 INHERIT_DOCS = YES 130 163 131 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 132 # tag is set to YES, then doxygen will reuse the documentation of the first 133 # member in the group (if any) for the other members of the group. By default 134 # all members of a group must be documented explicitly. 135 136 DISTRIBUTE_GROUP_DOC = NO 164 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 165 # a new page for each member. If set to NO, the documentation of a member will 166 # be part of the file/class/namespace that contains it. 167 168 SEPARATE_MEMBER_PAGES = NO 137 169 138 170 # The TAB_SIZE tag can be used to set the number of spaces in a tab. … … 150 182 ALIASES = 151 183 152 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources153 # only. Doxygen will then generate output that is more tailored for C.184 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 185 # sources only. Doxygen will then generate output that is more tailored for C. 154 186 # For instance, some of the names that are used will be different. The list 155 187 # of all members will be omitted, etc. … … 157 189 OPTIMIZE_OUTPUT_FOR_C = YES 158 190 159 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources160 # only. Doxygen will then generate output that is more tailored for Java.191 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 192 # sources only. Doxygen will then generate output that is more tailored for Java. 161 193 # For instance, namespaces will be presented as packages, qualified scopes 162 194 # will look different, etc. 163 195 164 196 OPTIMIZE_OUTPUT_JAVA = NO 197 198 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to 199 # include (a tag file for) the STL sources as input, then you should 200 # set this tag to YES in order to let doxygen match functions declarations and 201 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 202 # func(std::string) {}). This also make the inheritance and collaboration 203 # diagrams that involve STL classes more complete and accurate. 204 205 BUILTIN_STL_SUPPORT = NO 206 207 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 208 # tag is set to YES, then doxygen will reuse the documentation of the first 209 # member in the group (if any) for the other members of the group. By default 210 # all members of a group must be documented explicitly. 211 212 DISTRIBUTE_GROUP_DOC = NO 165 213 166 214 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of … … 199 247 EXTRACT_LOCAL_CLASSES = YES 200 248 249 # This flag is only useful for Objective-C code. When set to YES local 250 # methods, which are defined in the implementation section but not in 251 # the interface are included in the documentation. 252 # If set to NO (the default) only methods in the interface are included. 253 254 EXTRACT_LOCAL_METHODS = NO 255 201 256 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 202 257 # undocumented members of documented classes, files or namespaces. … … 239 294 # allowed. This is useful if you have classes or files whose names only differ 240 295 # in case and if your file system supports case sensitive file names. Windows 241 # users are advised to set this option to NO.296 # and Mac users are advised to set this option to NO. 242 297 243 298 CASE_SENSE_NAMES = YES … … 266 321 267 322 SORT_MEMBER_DOCS = YES 323 324 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 325 # brief documentation of file, namespace and class members alphabetically 326 # by member name. If set to NO (the default) the members will appear in 327 # declaration order. 328 329 SORT_BRIEF_DOCS = NO 330 331 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 332 # sorted by fully-qualified names, including namespaces. If set to 333 # NO (the default), the class list will be sorted only by class name, 334 # not including the namespace part. 335 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 336 # Note: This option applies only to the class list, not to the 337 # alphabetical list. 338 339 SORT_BY_SCOPE_NAME = NO 268 340 269 341 # The GENERATE_TODOLIST tag can be used to enable (YES) or … … 312 384 SHOW_USED_FILES = YES 313 385 386 # If the sources in your project are distributed over multiple directories 387 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 388 # in the documentation. The default is NO. 389 390 SHOW_DIRECTORIES = NO 391 392 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 393 # doxygen should invoke to get the current version for each file (typically from the 394 # version control system). Doxygen will invoke the program by executing (via 395 # popen()) the command <command> <input-file>, where <command> is the value of 396 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 397 # provided by doxygen. Whatever the program writes to standard output 398 # is used as the file version. See the manual for examples. 399 400 FILE_VERSION_FILTER = 401 314 402 #--------------------------------------------------------------------------- 315 403 # configuration options related to warning and progress messages … … 340 428 WARN_IF_DOC_ERROR = YES 341 429 430 # This WARN_NO_PARAMDOC option can be abled to get warnings for 431 # functions that are documented, but have no documentation for their parameters 432 # or return value. If set to NO (the default) doxygen will only warn about 433 # wrong or incomplete parameter documentation, but not about the absence of 434 # documentation. 435 436 WARN_NO_PARAMDOC = NO 437 342 438 # The WARN_FORMAT tag determines the format of the warning messages that 343 439 # doxygen can produce. The string should contain the $file, $line, and $text 344 440 # tags, which will be replaced by the file and line number from which the 345 # warning originated and the warning text. 441 # warning originated and the warning text. Optionally the format may contain 442 # $version, which will be replaced by the version of the file (if it could 443 # be obtained via FILE_VERSION_FILTER) 346 444 347 445 WARN_FORMAT = "$file:$line: $text" … … 362 460 # with spaces. 363 461 364 #INPUT = src examples 365 INPUT = ../src../ext462 INPUT = ../src \ 463 ../ext 366 464 367 465 # If the value of the INPUT tag contains directories, you can use the … … 369 467 # and *.h) to filter out the source-files in the directories. If left 370 468 # blank the following patterns are tested: 371 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp372 # *.h ++ *.idl *.odl *.cs *.php *.php3 *.inc469 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 470 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py 373 471 374 472 FILE_PATTERNS = … … 386 484 EXCLUDE = 387 485 388 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories 389 # that are symbolic links (a Unix filesystem feature) are excluded from the input. 486 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 487 # directories that are symbolic links (a Unix filesystem feature) are excluded 488 # from the input. 390 489 391 490 EXCLUDE_SYMLINKS = NO … … 393 492 # If the value of the INPUT tag contains directories, you can use the 394 493 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 395 # certain files from those directories. 494 # certain files from those directories. Note that the wildcards are matched 495 # against the file with absolute path, so to exclude all test directories 496 # for example use the pattern */test/* 396 497 397 498 EXCLUDE_PATTERNS = … … 428 529 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 429 530 # input file. Doxygen will then use the output that the filter program writes 430 # to standard output. 531 # to standard output. If FILTER_PATTERNS is specified, this tag will be 532 # ignored. 431 533 432 534 INPUT_FILTER = 535 536 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 537 # basis. Doxygen will compare the file name with each pattern and apply the 538 # filter if there is a match. The filters are a list of the form: 539 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 540 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 541 # is applied to all files. 542 543 FILTER_PATTERNS = 433 544 434 545 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using … … 443 554 444 555 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 445 # be generated. Documented entities will be cross-referenced with these sources. 446 447 #SOURCE_BROWSER = NO 556 # be generated. Documented entities will be cross-referenced with these sources. 557 # Note: To get rid of all source code in the generated output, make sure also 558 # VERBATIM_HEADERS is set to NO. 559 448 560 SOURCE_BROWSER = YES 449 561 … … 470 582 471 583 REFERENCES_RELATION = YES 584 585 # If the USE_HTAGS tag is set to YES then the references to source code 586 # will point to the HTML generated by the htags(1) tool instead of doxygen 587 # built-in source browser. The htags tool is part of GNU's global source 588 # tagging system (see http://www.gnu.org/software/global/global.html). You 589 # will need version 4.8.6 or higher. 590 591 USE_HTAGS = NO 472 592 473 593 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen … … 536 656 # style sheet that is used by each HTML page. It can be used to 537 657 # fine-tune the look of the HTML output. If the tag is left blank doxygen 538 # will generate a default style sheet 658 # will generate a default style sheet. Note that doxygen will try to copy 659 # the style sheet file to the HTML output directory, so don't put your own 660 # stylesheet in the HTML output directory as well, or it will be erased! 539 661 540 662 HTML_STYLESHEET = aubio.css … … 556 678 # be used to specify the file name of the resulting .chm file. You 557 679 # can add a path in front of the file if the result should not be 558 # written to the html output dir .680 # written to the html output directory. 559 681 560 682 CHM_FILE = … … 691 813 692 814 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 693 # The RTF output is optimi sed for Word 97 and may not look very pretty with815 # The RTF output is optimized for Word 97 and may not look very pretty with 694 816 # other RTF readers or editors. 695 817 … … 718 840 719 841 # Load stylesheet definitions from file. Syntax is similar to doxygen's 720 # config file, i.e. a series of assig ments. You only have to provide842 # config file, i.e. a series of assignments. You only have to provide 721 843 # replacements, missing definitions are set to their default value. 722 844 … … 762 884 # If the GENERATE_XML tag is set to YES Doxygen will 763 885 # generate an XML file that captures the structure of 764 # the code including all documentation. Note that this 765 # feature is still experimental and incomplete at the 766 # moment. 886 # the code including all documentation. 767 887 768 888 GENERATE_XML = NO … … 785 905 786 906 XML_DTD = 907 908 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 909 # dump the program listings (including syntax highlighting 910 # and cross-referencing information) to the XML output. Note that 911 # enabling this will significantly increase the size of the XML output. 912 913 XML_PROGRAMLISTING = YES 787 914 788 915 #--------------------------------------------------------------------------- … … 850 977 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 851 978 # then the macro expansion is limited to the macros specified with the 852 # PREDEFINED and EXPAND_AS_ PREDEFINED tags.979 # PREDEFINED and EXPAND_AS_DEFINED tags. 853 980 854 981 EXPAND_ONLY_PREDEF = NO … … 876 1003 # gcc). The argument of the tag is a list of macros of the form: name 877 1004 # or name=definition (no spaces). If the definition and the = are 878 # omitted =1 is assumed. 1005 # omitted =1 is assumed. To prevent a macro definition from being 1006 # undefined via #undef or recursively expanded use the := operator 1007 # instead of the = operator. 879 1008 880 1009 PREDEFINED = … … 890 1019 # doxygen's preprocessor will remove all function-like macros that are alone 891 1020 # on a line, have an all uppercase name, and do not end with a semicolon. Such 892 # function macros are typically used for boiler-plate code, and will confuse the893 # parser if not removed.1021 # function macros are typically used for boiler-plate code, and will confuse 1022 # the parser if not removed. 894 1023 895 1024 SKIP_FUNCTION_MACROS = YES 896 1025 897 1026 #--------------------------------------------------------------------------- 898 # Configuration::add tions related to external references1027 # Configuration::additions related to external references 899 1028 #--------------------------------------------------------------------------- 900 1029 … … 943 1072 944 1073 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 945 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or 946 # super classes. Setting the tag to NO turns the diagrams off. Note that this 947 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is 948 # recommended to install and use dot, since it yields more powerful graphs. 1074 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1075 # or super classes. Setting the tag to NO turns the diagrams off. Note that 1076 # this option is superseded by the HAVE_DOT option below. This is only a 1077 # fallback. It is recommended to install and use dot, since it yields more 1078 # powerful graphs. 949 1079 950 1080 CLASS_DIAGRAMS = YES … … 954 1084 # or is not a class. 955 1085 956 #HIDE_UNDOC_RELATIONS = YES957 1086 HIDE_UNDOC_RELATIONS = NO 958 1087 … … 962 1091 # have no effect if this option is set to NO (the default) 963 1092 964 #HAVE_DOT = NO965 1093 HAVE_DOT = YES 966 1094 … … 979 1107 COLLABORATION_GRAPH = YES 980 1108 1109 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1110 # will generate a graph for groups, showing the direct groups dependencies 1111 1112 GROUP_GRAPHS = YES 1113 981 1114 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 982 # collaboration diagrams in a style simil iar to the OMG's Unified Modeling1115 # collaboration diagrams in a style similar to the OMG's Unified Modeling 983 1116 # Language. 984 1117 … … 1017 1150 GRAPHICAL_HIERARCHY = YES 1018 1151 1152 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1153 # then doxygen will show the dependencies a directory has on other directories 1154 # in a graphical way. The dependency relations are determined by the #include 1155 # relations between the files in the directories. 1156 1157 DIRECTORY_GRAPH = YES 1158 1019 1159 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1020 1160 # generated by dot. Possible values are png, jpg, or gif … … 1024 1164 1025 1165 # The tag DOT_PATH can be used to specify the path where the dot tool can be 1026 # found. If left blank, it is assumed the dot tool can be found on the path.1166 # found. If left blank, it is assumed the dot tool can be found in the path. 1027 1167 1028 1168 DOT_PATH = … … 1052 1192 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1053 1193 # graphs generated by dot. A depth value of 3 means that only nodes reachable 1054 # from the root by following a path via at most 3 edges will be shown. Nodes that 1055 # lay further from the root node will be omitted. Note that setting this option to 1056 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also 1057 # note that a graph may be further truncated if the graph's image dimensions are 1058 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). 1059 # If 0 is used for the depth value (the default), the graph is not depth-constrained. 1194 # from the root by following a path via at most 3 edges will be shown. Nodes 1195 # that lay further from the root node will be omitted. Note that setting this 1196 # option to 1 or 2 may greatly reduce the computation time needed for large 1197 # code bases. Also note that a graph may be further truncated if the graph's 1198 # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH 1199 # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), 1200 # the graph is not depth-constrained. 1060 1201 1061 1202 MAX_DOT_GRAPH_DEPTH = 0 1203 1204 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1205 # background. This is disabled by default, which results in a white background. 1206 # Warning: Depending on the platform used, enabling this option may lead to 1207 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to 1208 # read). 1209 1210 DOT_TRANSPARENT = NO 1211 1212 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1213 # files in one run (i.e. multiple -o and -T options on the command line). This 1214 # makes dot run faster, but since only newer versions of dot (>1.8.10) 1215 # support this, this feature is disabled by default. 1216 1217 DOT_MULTI_TARGETS = NO 1062 1218 1063 1219 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will … … 1074 1230 1075 1231 #--------------------------------------------------------------------------- 1076 # Configuration::add tions related to the search engine1232 # Configuration::additions related to the search engine 1077 1233 #--------------------------------------------------------------------------- 1078 1234
Note: See TracChangeset
for help on using the changeset viewer.