Changeset bb42f65 for doc/full.cfg
- Timestamp:
- Mar 18, 2013, 4:34:01 PM (11 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:
- b209eda
- Parents:
- ac20c85 (diff), a5f4b7d (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the(diff)
links above to see all the changes relative to each parent. - File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/full.cfg
rac20c85 rbb42f65 1 # Doxyfile 1. 6.11 # Doxyfile 1.8.3.1 2 2 3 3 # This file describes the settings to be used by the documentation system 4 # doxygen (www.doxygen.org) for a project 4 # doxygen (www.doxygen.org) for a project. 5 5 # 6 # All text after a hash (#) is considered a comment and will be ignored 6 # All text after a hash (#) is considered a comment and will be ignored. 7 7 # The format is: 8 8 # TAG = value [value, ...] 9 9 # For lists items can also be appended using: 10 10 # TAG += value [value, ...] 11 # Values that contain spaces should be placed between quotes (" ") 11 # Values that contain spaces should be placed between quotes (" "). 12 12 13 13 #--------------------------------------------------------------------------- … … 23 23 DOXYFILE_ENCODING = UTF-8 24 24 25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded26 # by quotes) that should identify the project.27 25 # The PROJECT_NAME tag is a single word (or sequence of words) that should 26 # identify the project. Note that if you do not use Doxywizard you need 27 # to put quotes around the project name if it contains spaces. 28 28 PROJECT_NAME = aubio 29 29 … … 33 33 34 34 PROJECT_NUMBER = "0.4.0alpha full" 35 36 # Using the PROJECT_BRIEF tag one can provide an optional one line description 37 # for a project that appears at the top of each page and should give viewer 38 # a quick idea about the purpose of the project. Keep the description short. 39 40 PROJECT_BRIEF = 41 42 # With the PROJECT_LOGO tag one can specify an logo or icon that is 43 # included in the documentation. The maximum height of the logo should not 44 # exceed 55 pixels and the maximum width should not exceed 200 pixels. 45 # Doxygen will copy the logo to the output directory. 46 47 PROJECT_LOGO = 35 48 36 49 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) … … 113 126 # the path. The tag can be used to show relative paths in the file list. 114 127 # If left blank the directory from which doxygen is run is used as the 115 # path to strip. 128 # path to strip. Note that you specify absolute paths here, but also 129 # relative paths, which will be relative from the directory where doxygen is 130 # started. 116 131 117 132 STRIP_FROM_PATH = ../src … … 127 142 128 143 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 129 # (but less readable) file names. This can be useful i s your file systems144 # (but less readable) file names. This can be useful if your file system 130 145 # doesn't support long names like on DOS, Mac, or CD-ROM. 131 146 … … 182 197 ALIASES = 183 198 199 # This tag can be used to specify a number of word-keyword mappings (TCL only). 200 # A mapping has the form "name=value". For example adding 201 # "class=itcl::class" will allow you to use the command class in the 202 # itcl::class meaning. 203 204 TCL_SUBST = 205 184 206 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 185 207 # sources only. Doxygen will then generate output that is more tailored for C. … … 208 230 OPTIMIZE_OUTPUT_VHDL = NO 209 231 210 # Doxygen selects the parser to use depending on the extension of the files it parses. 211 # With this tag you can assign which parser to use for a given extension. 212 # Doxygen has a built-in mapping, but you can override or extend it using this tag. 213 # The format is ext=language, where ext is a file extension, and language is one of 214 # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, 215 # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat 216 # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), 217 # use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. 232 # Doxygen selects the parser to use depending on the extension of the files it 233 # parses. With this tag you can assign which parser to use for a given 234 # extension. Doxygen has a built-in mapping, but you can override or extend it 235 # using this tag. The format is ext=language, where ext is a file extension, 236 # and language is one of the parsers supported by doxygen: IDL, Java, 237 # Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, 238 # C++. For instance to make doxygen treat .inc files as Fortran files (default 239 # is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note 240 # that for custom extensions you also need to set FILE_PATTERNS otherwise the 241 # files are not read by doxygen. 218 242 219 243 EXTENSION_MAPPING = 244 245 # If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all 246 # comments according to the Markdown format, which allows for more readable 247 # documentation. See http://daringfireball.net/projects/markdown/ for details. 248 # The output of markdown processing is further processed by doxygen, so you 249 # can mix doxygen, HTML, and XML commands with Markdown formatting. 250 # Disable only in case of backward compatibilities issues. 251 252 MARKDOWN_SUPPORT = YES 253 254 # When enabled doxygen tries to link words that correspond to documented classes, 255 # or namespaces to their corresponding documentation. Such a link can be 256 # prevented in individual cases by by putting a % sign in front of the word or 257 # globally by setting AUTOLINK_SUPPORT to NO. 258 259 AUTOLINK_SUPPORT = YES 220 260 221 261 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want … … 223 263 # set this tag to YES in order to let doxygen match functions declarations and 224 264 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 225 # func(std::string) {}). This also make the inheritance and collaboration265 # func(std::string) {}). This also makes the inheritance and collaboration 226 266 # diagrams that involve STL classes more complete and accurate. 227 267 … … 239 279 SIP_SUPPORT = NO 240 280 241 # For Microsoft's IDL there are propget and propput attributes to indicate getter242 # and setter methods for a property. Setting this option to YES (the default)243 # will make doxygen to replace the get and set methods by a property in the244 # documentation. This will only work if the methods are indeed getting or281 # For Microsoft's IDL there are propget and propput attributes to indicate 282 # getter and setter methods for a property. Setting this option to YES (the 283 # default) will make doxygen replace the get and set methods by a property in 284 # the documentation. This will only work if the methods are indeed getting or 245 285 # setting a simple type. If this is not the case, or you want to show the 246 286 # methods anyway, you should set this option to NO. … … 262 302 263 303 SUBGROUPING = YES 304 305 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and 306 # unions are shown inside the group in which they are included (e.g. using 307 # @ingroup) instead of on a separate page (for HTML and Man pages) or 308 # section (for LaTeX and RTF). 309 310 INLINE_GROUPED_CLASSES = NO 311 312 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and 313 # unions with only public data fields will be shown inline in the documentation 314 # of the scope in which they are defined (i.e. file, namespace, or group 315 # documentation), provided this scope is documented. If set to NO (the default), 316 # structs, classes, and unions are shown on a separate page (for HTML and Man 317 # pages) or section (for LaTeX and RTF). 318 319 INLINE_SIMPLE_STRUCTS = NO 264 320 265 321 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum … … 279 335 # probably good enough. For larger projects a too small cache size can cause 280 336 # doxygen to be busy swapping symbols to and from disk most of the time 281 # causing a significant performance penal ity.337 # causing a significant performance penalty. 282 338 # If the system has enough physical memory increasing the cache will improve the 283 339 # performance by keeping more symbols in memory. Note that the value works on 284 # a logarithmic scale so increasing the size by one will roug ly double the340 # a logarithmic scale so increasing the size by one will roughly double the 285 341 # memory usage. The cache size is given by this formula: 286 342 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 287 # corresponding to a cache size of 2^16 = 65536 symbols 343 # corresponding to a cache size of 2^16 = 65536 symbols. 288 344 289 345 SYMBOL_CACHE_SIZE = 0 346 347 # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be 348 # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given 349 # their name and scope. Since this can be an expensive process and often the 350 # same symbol appear multiple times in the code, doxygen keeps a cache of 351 # pre-resolved symbols. If the cache is too small doxygen will become slower. 352 # If the cache is too large, memory is wasted. The cache size is given by this 353 # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, 354 # corresponding to a cache size of 2^16 = 65536 symbols. 355 356 LOOKUP_CACHE_SIZE = 0 290 357 291 358 #--------------------------------------------------------------------------- … … 305 372 EXTRACT_PRIVATE = YES 306 373 374 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal 375 # scope will be included in the documentation. 376 377 EXTRACT_PACKAGE = NO 378 307 379 # If the EXTRACT_STATIC tag is set to YES all static members of a file 308 380 # will be included in the documentation. … … 327 399 # 'anonymous_namespace{file}', where file will be replaced with the base 328 400 # name of the file that contains the anonymous namespace. By default 329 # anonymous namespace are hidden.401 # anonymous namespaces are hidden. 330 402 331 403 EXTRACT_ANON_NSPACES = NO … … 373 445 # and Mac users are advised to set this option to NO. 374 446 375 CASE_SENSE_NAMES = YES447 CASE_SENSE_NAMES = NO 376 448 377 449 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen … … 386 458 387 459 SHOW_INCLUDE_FILES = YES 460 461 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 462 # will list include files with double quotes in the documentation 463 # rather than with sharp brackets. 464 465 FORCE_LOCAL_INCLUDES = NO 388 466 389 467 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] … … 406 484 SORT_BRIEF_DOCS = NO 407 485 408 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 486 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 487 # will sort the (brief and detailed) documentation of class members so that 488 # constructors and destructors are listed first. If set to NO (the default) 489 # the constructors will appear in the respective orders defined by 490 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 491 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 492 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 409 493 410 494 SORT_MEMBERS_CTORS_1ST = NO … … 426 510 SORT_BY_SCOPE_NAME = NO 427 511 512 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to 513 # do proper type resolution of all parameters of a function it will reject a 514 # match between the prototype and the implementation of a member function even 515 # if there is only one candidate or it is obvious which candidate to choose 516 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen 517 # will still accept a match between prototype and implementation in such cases. 518 519 STRICT_PROTO_MATCHING = NO 520 428 521 # The GENERATE_TODOLIST tag can be used to enable (YES) or 429 522 # disable (NO) the todo list. This list is created by putting \todo … … 451 544 452 545 # The ENABLED_SECTIONS tag can be used to enable conditional 453 # documentation sections, marked by \if sectionname ... \endif. 546 # documentation sections, marked by \if section-label ... \endif 547 # and \cond section-label ... \endcond blocks. 454 548 455 549 ENABLED_SECTIONS = 456 550 457 551 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 458 # the initial value of a variable or defineconsists of for it to appear in552 # the initial value of a variable or macro consists of for it to appear in 459 553 # the documentation. If the initializer consists of more lines than specified 460 554 # here it will be hidden. Use a value of 0 to hide initializers completely. 461 # The appearance of the initializer of individual variables and defines in the555 # The appearance of the initializer of individual variables and macros in the 462 556 # documentation can be controlled using \showinitializer or \hideinitializer 463 557 # command in the documentation regardless of this setting. … … 494 588 FILE_VERSION_FILTER = 495 589 496 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by 497 # doxygen. The layout file controls the global structure of the generated output files 498 # in an output format independent way. The create the layout file that represents 499 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a 500 # file name after the option, if omitted DoxygenLayout.xml will be used as the name 501 # of the layout file. 502 503 LAYOUT_FILE = 590 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 591 # by doxygen. The layout file controls the global structure of the generated 592 # output files in an output format independent way. To create the layout file 593 # that represents doxygen's defaults, run doxygen with the -l option. 594 # You can optionally specify a file name after the option, if omitted 595 # DoxygenLayout.xml will be used as the name of the layout file. 596 597 #LAYOUT_FILE = 598 LAYOUT_FILE = DoxygenLayout.xml 599 600 # The CITE_BIB_FILES tag can be used to specify one or more bib files 601 # containing the references data. This must be a list of .bib files. The 602 # .bib extension is automatically appended if omitted. Using this command 603 # requires the bibtex tool to be installed. See also 604 # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style 605 # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this 606 # feature you need bibtex and perl available in the search path. Do not use 607 # file names with spaces, bibtex cannot handle them. 608 609 CITE_BIB_FILES = 504 610 505 611 #--------------------------------------------------------------------------- … … 531 637 WARN_IF_DOC_ERROR = YES 532 638 533 # Th is WARN_NO_PARAMDOC option can beabled to get warnings for639 # The WARN_NO_PARAMDOC option can be enabled to get warnings for 534 640 # functions that are documented, but have no documentation for their parameters 535 641 # or return value. If set to NO (the default) doxygen will only warn about … … 546 652 # be obtained via FILE_VERSION_FILTER) 547 653 548 WARN_FORMAT = "$file:$line: $text 654 WARN_FORMAT = "$file:$line: $text" 549 655 550 656 # The WARN_LOGFILE tag can be used to specify a file to which warning … … 577 683 # and *.h) to filter out the source-files in the directories. If left 578 684 # blank the following patterns are tested: 579 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 580 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 685 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 686 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 687 # *.f90 *.f *.for *.vhd *.vhdl 581 688 582 689 FILE_PATTERNS = *.h *.c … … 588 695 RECURSIVE = YES 589 696 590 # The EXCLUDE tag can be used to specify files and/or directories that should 697 # The EXCLUDE tag can be used to specify files and/or directories that should be 591 698 # excluded from the INPUT source files. This way you can easily exclude a 592 699 # subdirectory from a directory tree whose root is specified with the INPUT tag. 700 # Note that relative paths are relative to the directory from which doxygen is 701 # run. 593 702 594 703 EXCLUDE = 595 704 596 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or597 # directories that are symbolic links (a Unix file system feature) are excluded705 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 706 # directories that are symbolic links (a Unix file system feature) are excluded 598 707 # from the input. 599 708 … … 659 768 # The filters are a list of the form: 660 769 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 661 # info on how filters are used. If FILTER_PATTERNS is empty , INPUT_FILTER662 # is applied to all files.770 # info on how filters are used. If FILTER_PATTERNS is empty or if 771 # non of the patterns match the file name, INPUT_FILTER is applied. 663 772 664 773 FILTER_PATTERNS = … … 669 778 670 779 FILTER_SOURCE_FILES = NO 780 781 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 782 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) 783 # and it is also possible to disable source filtering for a specific pattern 784 # using *.ext= (so without naming a filter). This option only has effect when 785 # FILTER_SOURCE_FILES is enabled. 786 787 FILTER_SOURCE_PATTERNS = 788 789 # If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that 790 # is part of the input, its contents will be placed on the main page (index.html). 791 # This can be useful if you have a project on for instance GitHub and want reuse 792 # the introduction page also for the doxygen output. 793 794 USE_MDFILE_AS_MAINPAGE = 671 795 672 796 #--------------------------------------------------------------------------- … … 688 812 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 689 813 # doxygen to hide any special comment blocks from generated source code 690 # fragments. Normal C and C++comments will always remain visible.814 # fragments. Normal C, C++ and Fortran comments will always remain visible. 691 815 692 816 STRIP_CODE_COMMENTS = NO … … 772 896 # The HTML_HEADER tag can be used to specify a personal HTML header for 773 897 # each generated HTML page. If it is left blank doxygen will generate a 774 # standard header. 898 # standard header. Note that when using a custom header you are responsible 899 # for the proper inclusion of any scripts and style sheets that doxygen 900 # needs, which is dependent on the configuration options used. 901 # It is advised to generate a default header using "doxygen -w html 902 # header.html footer.html stylesheet.css YourConfigFile" and then modify 903 # that header. Note that the header is subject to change so you typically 904 # have to redo this when upgrading to a newer version of doxygen or when 905 # changing the value of configuration settings such as GENERATE_TREEVIEW! 775 906 776 907 HTML_HEADER = … … 784 915 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 785 916 # style sheet that is used by each HTML page. It can be used to 786 # fine-tune the look of the HTML output. If the tag is left blank doxygen787 # will generate a default style sheet. Note that doxygen will try to copy788 # the style sheet file to the HTML output directory, so don't put your own789 # stylesheet in the HTML output directory as well, or it will be erased!917 # fine-tune the look of the HTML output. If left blank doxygen will 918 # generate a default style sheet. Note that it is recommended to use 919 # HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this 920 # tag will in the future become obsolete. 790 921 791 922 HTML_STYLESHEET = 923 924 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional 925 # user-defined cascading style sheet that is included after the standard 926 # style sheets created by doxygen. Using this option one can overrule 927 # certain style aspects. This is preferred over using HTML_STYLESHEET 928 # since it does not replace the standard style sheet and is therefor more 929 # robust against future updates. Doxygen will copy the style sheet file to 930 # the output directory. 931 932 HTML_EXTRA_STYLESHEET = 933 934 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 935 # other source files which should be copied to the HTML output directory. Note 936 # that these files will be copied to the base HTML output directory. Use the 937 # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 938 # files. In the HTML_STYLESHEET file, use the file name only. Also note that 939 # the files will be copied as-is; there are no commands or markers available. 940 941 HTML_EXTRA_FILES = 942 943 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 944 # Doxygen will adjust the colors in the style sheet and background images 945 # according to this color. Hue is specified as an angle on a colorwheel, 946 # see http://en.wikipedia.org/wiki/Hue for more information. 947 # For instance the value 0 represents red, 60 is yellow, 120 is green, 948 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 949 # The allowed range is 0 to 359. 950 951 HTML_COLORSTYLE_HUE = 220 952 953 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 954 # the colors in the HTML output. For a value of 0 the output will use 955 # grayscales only. A value of 255 will produce the most vivid colors. 956 957 HTML_COLORSTYLE_SAT = 100 958 959 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 960 # the luminance component of the colors in the HTML output. Values below 961 # 100 gradually make the output lighter, whereas values above 100 make 962 # the output darker. The value divided by 100 is the actual gamma applied, 963 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 964 # and 100 does not change the gamma. 965 966 HTML_COLORSTYLE_GAMMA = 80 967 968 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 969 # page will contain the date and time when the page was generated. Setting 970 # this to NO can help when comparing the output of multiple runs. 971 972 HTML_TIMESTAMP = YES 792 973 793 974 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 794 975 # documentation will contain sections that can be hidden and shown after the 795 # page has loaded. For this to work a browser that supports 796 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 797 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 976 # page has loaded. 798 977 799 978 HTML_DYNAMIC_SECTIONS = NO 979 980 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of 981 # entries shown in the various tree structured indices initially; the user 982 # can expand and collapse entries dynamically later on. Doxygen will expand 983 # the tree to such a level that at most the specified number of entries are 984 # visible (unless a fully collapsed tree already exceeds this amount). 985 # So setting the number of entries 1 will produce a full collapsed tree by 986 # default. 0 is a special value representing an infinite number of entries 987 # and will result in a full expanded tree by default. 988 989 HTML_INDEX_NUM_ENTRIES = 100 800 990 801 991 # If the GENERATE_DOCSET tag is set to YES, additional index files … … 807 997 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 808 998 # it at startup. 809 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. 999 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1000 # for more information. 810 1001 811 1002 GENERATE_DOCSET = NO … … 825 1016 DOCSET_BUNDLE_ID = org.doxygen.Project 826 1017 1018 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely 1019 # identify the documentation publisher. This should be a reverse domain-name 1020 # style string, e.g. com.mycompany.MyDocSet.documentation. 1021 1022 DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1023 1024 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. 1025 1026 DOCSET_PUBLISHER_NAME = Publisher 1027 827 1028 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 828 1029 # will be generated that can be used as input for tools like the … … 869 1070 TOC_EXPAND = NO 870 1071 871 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER872 # are set, an additional index file will be generated that can be used as input for873 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated874 # HTML documentation.1072 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1073 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 1074 # that can be used as input for Qt's qhelpgenerator to generate a 1075 # Qt Compressed Help (.qch) of the generated HTML documentation. 875 1076 876 1077 GENERATE_QHP = NO … … 894 1095 QHP_VIRTUAL_FOLDER = doc 895 1096 896 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.897 # For more information please see1097 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 1098 # add. For more information please see 898 1099 # http://doc.trolltech.com/qthelpproject.html#custom-filters 899 1100 900 1101 QHP_CUST_FILTER_NAME = 901 1102 902 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see 903 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. 1103 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 1104 # custom filter to add. For more information please see 1105 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> 1106 # Qt Help Project / Custom Filters</a>. 904 1107 905 1108 QHP_CUST_FILTER_ATTRS = 906 1109 907 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's 1110 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1111 # project's 908 1112 # filter section matches. 909 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>. 1113 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> 1114 # Qt Help Project / Filter Attributes</a>. 910 1115 911 1116 QHP_SECT_FILTER_ATTRS = … … 918 1123 QHG_LOCATION = 919 1124 920 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 921 # top of each HTML page. The value NO (the default) enables the index and 922 # the value YES disables it. 1125 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files 1126 # will be generated, which together with the HTML files, form an Eclipse help 1127 # plugin. To install this plugin and make it available under the help contents 1128 # menu in Eclipse, the contents of the directory containing the HTML and XML 1129 # files needs to be copied into the plugins directory of eclipse. The name of 1130 # the directory within the plugins directory should be the same as 1131 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 1132 # the help appears. 1133 1134 GENERATE_ECLIPSEHELP = NO 1135 1136 # A unique identifier for the eclipse help plugin. When installing the plugin 1137 # the directory name containing the HTML and XML files should also have 1138 # this name. 1139 1140 ECLIPSE_DOC_ID = org.doxygen.Project 1141 1142 # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) 1143 # at top of each HTML page. The value NO (the default) enables the index and 1144 # the value YES disables it. Since the tabs have the same information as the 1145 # navigation tree you can set this option to NO if you already set 1146 # GENERATE_TREEVIEW to YES. 923 1147 924 1148 DISABLE_INDEX = NO 925 926 # This tag can be used to set the number of enum values (range [1..20])927 # that doxygen will group on one line in the generated HTML documentation.928 929 ENUM_VALUES_PER_LINE = 4930 1149 931 1150 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index … … 936 1155 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 937 1156 # Windows users are probably better off using the HTML help feature. 1157 # Since the tree basically has the same information as the tab index you 1158 # could consider to set DISABLE_INDEX to NO when enabling this option. 938 1159 939 1160 GENERATE_TREEVIEW = NO 1161 1162 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 1163 # (range [0,1..20]) that doxygen will group on one line in the generated HTML 1164 # documentation. Note that a value of 0 will completely suppress the enum 1165 # values from appearing in the overview section. 1166 1167 ENUM_VALUES_PER_LINE = 4 940 1168 941 1169 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be … … 944 1172 945 1173 TREEVIEW_WIDTH = 250 1174 1175 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 1176 # links to external symbols imported via tag files in a separate window. 1177 1178 EXT_LINKS_IN_WINDOW = NO 946 1179 947 1180 # Use this tag to change the font size of Latex formulas included … … 953 1186 FORMULA_FONTSIZE = 10 954 1187 955 # When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript 956 # and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP) 957 # there is already a search function so this one should typically 958 # be disabled. 1188 # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1189 # generated for formulas are transparent PNGs. Transparent PNGs are 1190 # not supported properly for IE 6.0, but are supported on all modern browsers. 1191 # Note that when changing this option you need to delete any form_*.png files 1192 # in the HTML output before the changes have effect. 1193 1194 FORMULA_TRANSPARENT = YES 1195 1196 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 1197 # (see http://www.mathjax.org) which uses client side Javascript for the 1198 # rendering instead of using prerendered bitmaps. Use this if you do not 1199 # have LaTeX installed or if you want to formulas look prettier in the HTML 1200 # output. When enabled you may also need to install MathJax separately and 1201 # configure the path to it using the MATHJAX_RELPATH option. 1202 1203 USE_MATHJAX = YES 1204 1205 # When MathJax is enabled you can set the default output format to be used for 1206 # thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and 1207 # SVG. The default value is HTML-CSS, which is slower, but has the best 1208 # compatibility. 1209 1210 MATHJAX_FORMAT = HTML-CSS 1211 1212 # When MathJax is enabled you need to specify the location relative to the 1213 # HTML output directory using the MATHJAX_RELPATH option. The destination 1214 # directory should contain the MathJax.js script. For instance, if the mathjax 1215 # directory is located at the same level as the HTML output directory, then 1216 # MATHJAX_RELPATH should be ../mathjax. The default value points to 1217 # the MathJax Content Delivery Network so you can quickly see the result without 1218 # installing MathJax. 1219 # However, it is strongly recommended to install a local 1220 # copy of MathJax from http://www.mathjax.org before deployment. 1221 1222 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1223 1224 # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension 1225 # names that should be enabled during MathJax rendering. 1226 1227 MATHJAX_EXTENSIONS = 1228 1229 # When the SEARCHENGINE tag is enabled doxygen will generate a search box 1230 # for the HTML output. The underlying search engine uses javascript 1231 # and DHTML and should work on any modern browser. Note that when using 1232 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 1233 # (GENERATE_DOCSET) there is already a search function so this one should 1234 # typically be disabled. For large projects the javascript based search engine 1235 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 959 1236 960 1237 SEARCHENGINE = YES 1238 1239 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1240 # implemented using a web server instead of a web client using Javascript. 1241 # There are two flavours of web server based search depending on the 1242 # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for 1243 # searching and an index file used by the script. When EXTERNAL_SEARCH is 1244 # enabled the indexing and searching needs to be provided by external tools. 1245 # See the manual for details. 1246 1247 SERVER_BASED_SEARCH = NO 1248 1249 # When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP 1250 # script for searching. Instead the search results are written to an XML file 1251 # which needs to be processed by an external indexer. Doxygen will invoke an 1252 # external search engine pointed to by the SEARCHENGINE_URL option to obtain 1253 # the search results. Doxygen ships with an example indexer (doxyindexer) and 1254 # search engine (doxysearch.cgi) which are based on the open source search engine 1255 # library Xapian. See the manual for configuration details. 1256 1257 EXTERNAL_SEARCH = NO 1258 1259 # The SEARCHENGINE_URL should point to a search engine hosted by a web server 1260 # which will returned the search results when EXTERNAL_SEARCH is enabled. 1261 # Doxygen ships with an example search engine (doxysearch) which is based on 1262 # the open source search engine library Xapian. See the manual for configuration 1263 # details. 1264 1265 SEARCHENGINE_URL = 1266 1267 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed 1268 # search data is written to a file for indexing by an external tool. With the 1269 # SEARCHDATA_FILE tag the name of this file can be specified. 1270 1271 SEARCHDATA_FILE = searchdata.xml 1272 1273 # When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the 1274 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is 1275 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple 1276 # projects and redirect the results back to the right project. 1277 1278 EXTERNAL_SEARCH_ID = 1279 1280 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen 1281 # projects other than the one defined by this configuration file, but that are 1282 # all added to the same external search index. Each project needs to have a 1283 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id 1284 # of to a relative location where the documentation can be found. 1285 # The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ... 1286 1287 EXTRA_SEARCH_MAPPINGS = 961 1288 962 1289 #--------------------------------------------------------------------------- … … 977 1304 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 978 1305 # invoked. If left blank `latex' will be used as the default command name. 1306 # Note that when enabling USE_PDFLATEX this option is only used for 1307 # generating bitmaps for formulas in the HTML output, but not in the 1308 # Makefile that is written to the output directory. 979 1309 980 1310 LATEX_CMD_NAME = latex … … 993 1323 994 1324 # The PAPER_TYPE tag can be used to set the paper type that is used 995 # by the printer. Possible values are: a4, a4wide,letter, legal and1325 # by the printer. Possible values are: a4, letter, legal and 996 1326 # executive. If left blank a4wide will be used. 997 1327 998 PAPER_TYPE = a4 wide1328 PAPER_TYPE = a4 999 1329 1000 1330 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX … … 1010 1340 LATEX_HEADER = 1011 1341 1342 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for 1343 # the generated latex document. The footer should contain everything after 1344 # the last chapter. If it is left blank doxygen will generate a 1345 # standard footer. Notice: only use this tag if you know what you are doing! 1346 1347 LATEX_FOOTER = 1348 1012 1349 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1013 1350 # is prepared for conversion to pdf (using ps2pdf). The pdf file will … … 1015 1352 # This makes the output suitable for online browsing using a pdf viewer. 1016 1353 1017 PDF_HYPERLINKS = NO1354 PDF_HYPERLINKS = YES 1018 1355 1019 1356 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of … … 1021 1358 # higher quality PDF documentation. 1022 1359 1023 USE_PDFLATEX = NO1360 USE_PDFLATEX = YES 1024 1361 1025 1362 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. … … 1036 1373 LATEX_HIDE_INDICES = NO 1037 1374 1038 # If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER. 1375 # If LATEX_SOURCE_CODE is set to YES then doxygen will include 1376 # source code with syntax highlighting in the LaTeX output. 1377 # Note that which sources are shown also depends on other settings 1378 # such as SOURCE_BROWSER. 1039 1379 1040 1380 LATEX_SOURCE_CODE = NO 1381 1382 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1383 # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See 1384 # http://en.wikipedia.org/wiki/BibTeX for more info. 1385 1386 LATEX_BIB_STYLE = plain 1041 1387 1042 1388 #--------------------------------------------------------------------------- … … 1071 1417 RTF_HYPERLINKS = NO 1072 1418 1073 # Load style sheet definitions from file. Syntax is similar to doxygen's1419 # Load style sheet definitions from file. Syntax is similar to doxygen's 1074 1420 # config file, i.e. a series of assignments. You only have to provide 1075 1421 # replacements, missing definitions are set to their default value. … … 1216 1562 1217 1563 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1218 # in the INCLUDE_PATH (see below) will be search ifa #include is found.1564 # pointed to by INCLUDE_PATH will be searched when a #include is found. 1219 1565 1220 1566 SEARCH_INCLUDES = YES … … 1246 1592 # this tag can be used to specify a list of macro names that should be expanded. 1247 1593 # The macro definition that is found in the sources will be used. 1248 # Use the PREDEFINED tag if you want to use a different macro definition. 1594 # Use the PREDEFINED tag if you want to use a different macro definition that 1595 # overrules the definition found in the source code. 1249 1596 1250 1597 EXPAND_AS_DEFINED = 1251 1598 1252 1599 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1253 # doxygen's preprocessor will remove all function-like macros that are alone 1254 # on a line, have an all uppercase name, and do not end with a semicolon. Such 1255 # function macros are typically used for boiler-plate code, and will confuse 1256 # the parser if not removed. 1600 # doxygen's preprocessor will remove all references to function-like macros 1601 # that are alone on a line, have an all uppercase name, and do not end with a 1602 # semicolon, because these will confuse the parser if not removed. 1257 1603 1258 1604 SKIP_FUNCTION_MACROS = YES … … 1262 1608 #--------------------------------------------------------------------------- 1263 1609 1264 # The TAGFILES option can be used to specify one or more tagfiles. 1265 # Optionally an initial location of the external documentation 1266 # can be added for each tagfile. The format of a tag file without 1267 # this location is as follows: 1610 # The TAGFILES option can be used to specify one or more tagfiles. For each 1611 # tag file the location of the external documentation should be added. The 1612 # format of a tag file without this location is as follows: 1268 1613 # 1269 1614 # TAGFILES = file1 file2 ... … … 1271 1616 # 1272 1617 # TAGFILES = file1=loc1 "file2 = loc2" ... 1273 # where "loc1" and "loc2" can be relative or absolute paths or 1274 # URLs. If a location is present for each tag, the installdox tool 1275 # does not have to be run to correct the links. 1276 # Note that each tag file must have a unique name 1277 # (where the name does NOT include the path) 1278 # If a tag file is not located in the directory in which doxygen 1279 # is run, you must also specify the path to the tagfile here. 1618 # where "loc1" and "loc2" can be relative or absolute paths 1619 # or URLs. Note that each tag file must have a unique name (where the name does 1620 # NOT include the path). If a tag file is not located in the directory in which 1621 # doxygen is run, you must also specify the path to the tagfile here. 1280 1622 1281 1623 TAGFILES = … … 1310 1652 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1311 1653 # or super classes. Setting the tag to NO turns the diagrams off. Note that 1312 # this option is superseded by the HAVE_DOT option below. This is only a 1313 # fallback. It is recommended to install and use dot, since it yields more 1314 # powerful graphs. 1654 # this option also works with HAVE_DOT disabled, but it is recommended to 1655 # install and use dot, since it yields more powerful graphs. 1315 1656 1316 1657 CLASS_DIAGRAMS = YES … … 1336 1677 # have no effect if this option is set to NO (the default) 1337 1678 1338 HAVE_DOT = YES 1339 1340 # By default doxygen will write a font called FreeSans.ttf to the output 1341 # directory and reference it in all dot files that doxygen generates. This 1342 # font does not include all possible unicode characters however, so when you need 1343 # these (or just want a differently looking font) you can specify the font name 1344 # using DOT_FONTNAME. You need need to make sure dot is able to find the font, 1345 # which can be done by putting it in a standard location or by setting the 1346 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 1347 # containing the font. 1679 HAVE_DOT = NO 1680 1681 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 1682 # allowed to run in parallel. When set to 0 (the default) doxygen will 1683 # base this on the number of processors available in the system. You can set it 1684 # explicitly to a value larger than 0 to get control over the balance 1685 # between CPU load and processing speed. 1686 1687 DOT_NUM_THREADS = 0 1688 1689 # By default doxygen will use the Helvetica font for all dot files that 1690 # doxygen generates. When you want a differently looking font you can specify 1691 # the font name using DOT_FONTNAME. You need to make sure dot is able to find 1692 # the font, which can be done by putting it in a standard location or by setting 1693 # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the 1694 # directory containing the font. 1348 1695 1349 1696 DOT_FONTNAME = FreeSans … … 1354 1701 DOT_FONTSIZE = 10 1355 1702 1356 # By default doxygen will tell dot to use the output directory to look for the 1357 # FreeSans.ttf font (which doxygen will put there itself). If you specify a 1358 # different font using DOT_FONTNAME you can set the path where dot 1359 # can find it using this tag. 1703 # By default doxygen will tell dot to use the Helvetica font. 1704 # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to 1705 # set the path where dot can find it. 1360 1706 1361 1707 DOT_FONTPATH = … … 1364 1710 # will generate a graph for each documented class showing the direct and 1365 1711 # indirect inheritance relations. Setting this tag to YES will force the 1366 # theCLASS_DIAGRAMS tag to NO.1712 # CLASS_DIAGRAMS tag to NO. 1367 1713 1368 1714 CLASS_GRAPH = YES … … 1385 1731 1386 1732 UML_LOOK = NO 1733 1734 # If the UML_LOOK tag is enabled, the fields and methods are shown inside 1735 # the class node. If there are many fields or methods and many nodes the 1736 # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS 1737 # threshold limits the number of items for each type to make the size more 1738 # managable. Set this to 0 for no limit. Note that the threshold may be 1739 # exceeded by 50% before the limit is enforced. 1740 1741 UML_LIMIT_NUM_FIELDS = 10 1387 1742 1388 1743 # If set to YES, the inheritance and collaboration graphs will show the … … 1422 1777 1423 1778 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1424 # will g raphical hierarchy of all classes instead of a textual one.1779 # will generate a graphical hierarchy of all classes instead of a textual one. 1425 1780 1426 1781 GRAPHICAL_HIERARCHY = YES 1427 1782 1428 # If the DIRECTORY_GRAPH , SHOW_DIRECTORIESand HAVE_DOT tags are set to YES1783 # If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES 1429 1784 # then doxygen will show the dependencies a directory has on other directories 1430 1785 # in a graphical way. The dependency relations are determined by the #include … … 1434 1789 1435 1790 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1436 # generated by dot. Possible values are png, jpg, or gif 1437 # If left blank png will be used. 1791 # generated by dot. Possible values are svg, png, jpg, or gif. 1792 # If left blank png will be used. If you choose svg you need to set 1793 # HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1794 # visible in IE 9+ (other browsers do not have this requirement). 1438 1795 1439 1796 DOT_IMAGE_FORMAT = png 1797 1798 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 1799 # enable generation of interactive SVG images that allow zooming and panning. 1800 # Note that this requires a modern browser other than Internet Explorer. 1801 # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you 1802 # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1803 # visible. Older versions of IE do not have SVG support. 1804 1805 INTERACTIVE_SVG = NO 1440 1806 1441 1807 # The tag DOT_PATH can be used to specify the path where the dot tool can be … … 1449 1815 1450 1816 DOTFILE_DIRS = 1817 1818 # The MSCFILE_DIRS tag can be used to specify one or more directories that 1819 # contain msc files that are included in the documentation (see the 1820 # \mscfile command). 1821 1822 MSCFILE_DIRS = 1451 1823 1452 1824 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
Note: See TracChangeset
for help on using the changeset viewer.