Mercurial > hg > vamp-plugin-sdk
comparison build/Doxyfile @ 298:5940dd0a399f
* Add NoShift option to PluginInputDomainAdapter as well, for completeness
* Minor & doc updates
| author | cannam |
|---|---|
| date | Tue, 22 Sep 2009 13:01:56 +0000 |
| parents | de74128bfeb0 |
| children | 2c546a899eec |
comparison
equal
deleted
inserted
replaced
| 297:f3db7ba66fea | 298:5940dd0a399f |
|---|---|
| 1 # Doxyfile 1.5.5 | 1 # Doxyfile 1.5.8 |
| 2 | 2 |
| 3 # This file describes the settings to be used by the documentation system | 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 |
| 29 | 29 |
| 30 # The PROJECT_NUMBER tag can be used to enter a project or revision number. | 30 # The PROJECT_NUMBER tag can be used to enter a project or revision number. |
| 31 # This could be handy for archiving the generated documentation or | 31 # This could be handy for archiving the generated documentation or |
| 32 # if some version control system is used. | 32 # if some version control system is used. |
| 33 | 33 |
| 34 PROJECT_NUMBER = 2.0 | 34 PROJECT_NUMBER = 2.1 |
| 35 | 35 |
| 36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) | 36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) |
| 37 # base path where the generated documentation will be put. | 37 # base path where the generated documentation will be put. |
| 38 # If a relative path is entered, it will be relative to the location | 38 # If a relative path is entered, it will be relative to the location |
| 39 # where doxygen was started. If left blank the current directory will be used. | 39 # where doxygen was started. If left blank the current directory will be used. |
| 55 # The default language is English, other supported languages are: | 55 # The default language is English, other supported languages are: |
| 56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, | 56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, |
| 57 # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, | 57 # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, |
| 58 # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), | 58 # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), |
| 59 # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, | 59 # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, |
| 60 # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, | 60 # Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene, |
| 61 # and Ukrainian. | 61 # Spanish, Swedish, and Ukrainian. |
| 62 | 62 |
| 63 OUTPUT_LANGUAGE = English | 63 OUTPUT_LANGUAGE = English |
| 64 | 64 |
| 65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will | 65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will |
| 66 # include brief member descriptions after the members that are listed in | 66 # include brief member descriptions after the members that are listed in |
| 153 # The new default is to treat a multi-line C++ comment block as a detailed | 153 # The new default is to treat a multi-line C++ comment block as a detailed |
| 154 # description. Set this tag to YES if you prefer the old behaviour instead. | 154 # description. Set this tag to YES if you prefer the old behaviour instead. |
| 155 | 155 |
| 156 MULTILINE_CPP_IS_BRIEF = NO | 156 MULTILINE_CPP_IS_BRIEF = NO |
| 157 | 157 |
| 158 # If the DETAILS_AT_TOP tag is set to YES then Doxygen | |
| 159 # will output the detailed description near the top, like JavaDoc. | |
| 160 # If set to NO, the detailed description appears after the member | |
| 161 # documentation. | |
| 162 | |
| 163 DETAILS_AT_TOP = YES | |
| 164 | |
| 165 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented | 158 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented |
| 166 # member inherits the documentation from any documented member that it | 159 # member inherits the documentation from any documented member that it |
| 167 # re-implements. | 160 # re-implements. |
| 168 | 161 |
| 169 INHERIT_DOCS = YES | 162 INHERIT_DOCS = YES |
| 212 # sources. Doxygen will then generate output that is tailored for | 205 # sources. Doxygen will then generate output that is tailored for |
| 213 # VHDL. | 206 # VHDL. |
| 214 | 207 |
| 215 OPTIMIZE_OUTPUT_VHDL = NO | 208 OPTIMIZE_OUTPUT_VHDL = NO |
| 216 | 209 |
| 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 | |
| 218 | |
| 219 EXTENSION_MAPPING = | |
| 220 | |
| 217 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want | 221 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want |
| 218 # to include (a tag file for) the STL sources as input, then you should | 222 # to include (a tag file for) the STL sources as input, then you should |
| 219 # set this tag to YES in order to let doxygen match functions declarations and | 223 # set this tag to YES in order to let doxygen match functions declarations and |
| 220 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. | 224 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. |
| 221 # func(std::string) {}). This also make the inheritance and collaboration | 225 # func(std::string) {}). This also make the inheritance and collaboration |
| 222 # diagrams that involve STL classes more complete and accurate. | 226 # diagrams that involve STL classes more complete and accurate. |
| 223 | 227 |
| 224 BUILTIN_STL_SUPPORT = NO | 228 BUILTIN_STL_SUPPORT = NO |
| 225 | 229 |
| 226 # If you use Microsoft's C++/CLI language, you should set this option to YES to | 230 # If you use Microsoft's C++/CLI language, you should set this option to YES to |
| 227 # enable parsing support. | 231 # enable parsing support. |
| 228 | 232 |
| 229 CPP_CLI_SUPPORT = NO | 233 CPP_CLI_SUPPORT = NO |
| 230 | 234 |
| 231 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. | 235 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. |
| 232 # Doxygen will parse them like normal C++ but will assume all classes use public | 236 # Doxygen will parse them like normal C++ but will assume all classes use public |
| 233 # instead of private inheritance when no explicit protection keyword is present. | 237 # instead of private inheritance when no explicit protection keyword is present. |
| 234 | 238 |
| 235 SIP_SUPPORT = NO | 239 SIP_SUPPORT = NO |
| 240 | |
| 241 # For Microsoft's IDL there are propget and propput attributes to indicate getter | |
| 242 # 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 the | |
| 244 # documentation. This will only work if the methods are indeed getting or | |
| 245 # setting a simple type. If this is not the case, or you want to show the | |
| 246 # methods anyway, you should set this option to NO. | |
| 247 | |
| 248 IDL_PROPERTY_SUPPORT = YES | |
| 236 | 249 |
| 237 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC | 250 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
| 238 # tag is set to YES, then doxygen will reuse the documentation of the first | 251 # tag is set to YES, then doxygen will reuse the documentation of the first |
| 239 # member in the group (if any) for the other members of the group. By default | 252 # member in the group (if any) for the other members of the group. By default |
| 240 # all members of a group must be documented explicitly. | 253 # all members of a group must be documented explicitly. |
| 257 # be useful for C code in case the coding convention dictates that all compound | 270 # be useful for C code in case the coding convention dictates that all compound |
| 258 # types are typedef'ed and only the typedef is referenced, never the tag name. | 271 # types are typedef'ed and only the typedef is referenced, never the tag name. |
| 259 | 272 |
| 260 TYPEDEF_HIDES_STRUCT = NO | 273 TYPEDEF_HIDES_STRUCT = NO |
| 261 | 274 |
| 275 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to | |
| 276 # determine which symbols to keep in memory and which to flush to disk. | |
| 277 # When the cache is full, less often used symbols will be written to disk. | |
| 278 # For small to medium size projects (<1000 input files) the default value is | |
| 279 # probably good enough. For larger projects a too small cache size can cause | |
| 280 # doxygen to be busy swapping symbols to and from disk most of the time | |
| 281 # causing a significant performance penality. | |
| 282 # If the system has enough physical memory increasing the cache will improve the | |
| 283 # performance by keeping more symbols in memory. Note that the value works on | |
| 284 # a logarithmic scale so increasing the size by one will rougly double the | |
| 285 # memory usage. The cache size is given by this formula: | |
| 286 # 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 | |
| 288 | |
| 289 SYMBOL_CACHE_SIZE = 0 | |
| 290 | |
| 262 #--------------------------------------------------------------------------- | 291 #--------------------------------------------------------------------------- |
| 263 # Build related configuration options | 292 # Build related configuration options |
| 264 #--------------------------------------------------------------------------- | 293 #--------------------------------------------------------------------------- |
| 265 | 294 |
| 266 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in | 295 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
| 384 | 413 |
| 385 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be | 414 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be |
| 386 # sorted by fully-qualified names, including namespaces. If set to | 415 # sorted by fully-qualified names, including namespaces. If set to |
| 387 # NO (the default), the class list will be sorted only by class name, | 416 # NO (the default), the class list will be sorted only by class name, |
| 388 # not including the namespace part. | 417 # not including the namespace part. |
| 389 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. | 418 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. |
| 390 # Note: This option applies only to the class list, not to the | 419 # Note: This option applies only to the class list, not to the |
| 391 # alphabetical list. | 420 # alphabetical list. |
| 392 | 421 |
| 393 SORT_BY_SCOPE_NAME = NO | 422 SORT_BY_SCOPE_NAME = NO |
| 394 | 423 |
| 441 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy | 470 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy |
| 442 # in the documentation. The default is NO. | 471 # in the documentation. The default is NO. |
| 443 | 472 |
| 444 SHOW_DIRECTORIES = YES | 473 SHOW_DIRECTORIES = YES |
| 445 | 474 |
| 475 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. | |
| 476 # This will remove the Files entry from the Quick Index and from the | |
| 477 # Folder Tree View (if specified). The default is YES. | |
| 478 | |
| 479 SHOW_FILES = YES | |
| 480 | |
| 481 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the | |
| 482 # Namespaces page. | |
| 483 # This will remove the Namespaces entry from the Quick Index | |
| 484 # and from the Folder Tree View (if specified). The default is YES. | |
| 485 | |
| 486 SHOW_NAMESPACES = YES | |
| 487 | |
| 446 # The FILE_VERSION_FILTER tag can be used to specify a program or script that | 488 # The FILE_VERSION_FILTER tag can be used to specify a program or script that |
| 447 # doxygen should invoke to get the current version for each file (typically from | 489 # doxygen should invoke to get the current version for each file (typically from |
| 448 # the version control system). Doxygen will invoke the program by executing (via | 490 # the version control system). Doxygen will invoke the program by executing (via |
| 449 # popen()) the command <command> <input-file>, where <command> is the value of | 491 # popen()) the command <command> <input-file>, where <command> is the value of |
| 450 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file | 492 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file |
| 451 # provided by doxygen. Whatever the program writes to standard output | 493 # provided by doxygen. Whatever the program writes to standard output |
| 452 # is used as the file version. See the manual for examples. | 494 # is used as the file version. See the manual for examples. |
| 453 | 495 |
| 454 FILE_VERSION_FILTER = | 496 FILE_VERSION_FILTER = |
| 455 | 497 |
| 498 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by | |
| 499 # doxygen. The layout file controls the global structure of the generated output files | |
| 500 # in an output format independent way. The create the layout file that represents | |
| 501 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a | |
| 502 # file name after the option, if omitted DoxygenLayout.xml will be used as the name | |
| 503 # of the layout file. | |
| 504 | |
| 505 LAYOUT_FILE = | |
| 506 | |
| 456 #--------------------------------------------------------------------------- | 507 #--------------------------------------------------------------------------- |
| 457 # configuration options related to warning and progress messages | 508 # configuration options related to warning and progress messages |
| 458 #--------------------------------------------------------------------------- | 509 #--------------------------------------------------------------------------- |
| 459 | 510 |
| 460 # The QUIET tag can be used to turn on/off the messages that are generated | 511 # The QUIET tag can be used to turn on/off the messages that are generated |
| 607 # The INPUT_FILTER tag can be used to specify a program that doxygen should | 658 # The INPUT_FILTER tag can be used to specify a program that doxygen should |
| 608 # invoke to filter for each input file. Doxygen will invoke the filter program | 659 # invoke to filter for each input file. Doxygen will invoke the filter program |
| 609 # by executing (via popen()) the command <filter> <input-file>, where <filter> | 660 # by executing (via popen()) the command <filter> <input-file>, where <filter> |
| 610 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an | 661 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an |
| 611 # input file. Doxygen will then use the output that the filter program writes | 662 # input file. Doxygen will then use the output that the filter program writes |
| 612 # to standard output. If FILTER_PATTERNS is specified, this tag will be | 663 # to standard output. |
| 664 # If FILTER_PATTERNS is specified, this tag will be | |
| 613 # ignored. | 665 # ignored. |
| 614 | 666 |
| 615 INPUT_FILTER = | 667 INPUT_FILTER = |
| 616 | 668 |
| 617 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern | 669 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern |
| 618 # basis. Doxygen will compare the file name with each pattern and apply the | 670 # basis. |
| 619 # filter if there is a match. The filters are a list of the form: | 671 # Doxygen will compare the file name with each pattern and apply the |
| 672 # filter if there is a match. | |
| 673 # The filters are a list of the form: | |
| 620 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further | 674 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further |
| 621 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER | 675 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER |
| 622 # is applied to all files. | 676 # is applied to all files. |
| 623 | 677 |
| 624 FILTER_PATTERNS = | 678 FILTER_PATTERNS = |
| 649 # doxygen to hide any special comment blocks from generated source code | 703 # doxygen to hide any special comment blocks from generated source code |
| 650 # fragments. Normal C and C++ comments will always remain visible. | 704 # fragments. Normal C and C++ comments will always remain visible. |
| 651 | 705 |
| 652 STRIP_CODE_COMMENTS = YES | 706 STRIP_CODE_COMMENTS = YES |
| 653 | 707 |
| 654 # If the REFERENCED_BY_RELATION tag is set to YES (the default) | 708 # If the REFERENCED_BY_RELATION tag is set to YES |
| 655 # then for each documented function all documented | 709 # then for each documented function all documented |
| 656 # functions referencing it will be listed. | 710 # functions referencing it will be listed. |
| 657 | 711 |
| 658 REFERENCED_BY_RELATION = YES | 712 REFERENCED_BY_RELATION = YES |
| 659 | 713 |
| 660 # If the REFERENCES_RELATION tag is set to YES (the default) | 714 # If the REFERENCES_RELATION tag is set to YES |
| 661 # then for each documented function all documented entities | 715 # then for each documented function all documented entities |
| 662 # called/used by that function will be listed. | 716 # called/used by that function will be listed. |
| 663 | 717 |
| 664 REFERENCES_RELATION = YES | 718 REFERENCES_RELATION = YES |
| 665 | 719 |
| 666 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) | 720 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) |
| 667 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from | 721 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from |
| 668 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will | 722 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will |
| 669 # link to the source code. Otherwise they will link to the documentstion. | 723 # link to the source code. |
| 724 # Otherwise they will link to the documentation. | |
| 670 | 725 |
| 671 REFERENCES_LINK_SOURCE = YES | 726 REFERENCES_LINK_SOURCE = YES |
| 672 | 727 |
| 673 # If the USE_HTAGS tag is set to YES then the references to source code | 728 # If the USE_HTAGS tag is set to YES then the references to source code |
| 674 # will point to the HTML generated by the htags(1) tool instead of doxygen | 729 # will point to the HTML generated by the htags(1) tool instead of doxygen |
| 753 # files or namespaces will be aligned in HTML using tables. If set to | 808 # files or namespaces will be aligned in HTML using tables. If set to |
| 754 # NO a bullet list will be used. | 809 # NO a bullet list will be used. |
| 755 | 810 |
| 756 HTML_ALIGN_MEMBERS = YES | 811 HTML_ALIGN_MEMBERS = YES |
| 757 | 812 |
| 758 # If the GENERATE_HTMLHELP tag is set to YES, additional index files | 813 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML |
| 759 # will be generated that can be used as input for tools like the | 814 # documentation will contain sections that can be hidden and shown after the |
| 760 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) | 815 # page has loaded. For this to work a browser that supports |
| 761 # of the generated HTML documentation. | 816 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox |
| 762 | 817 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). |
| 763 GENERATE_HTMLHELP = NO | 818 |
| 819 HTML_DYNAMIC_SECTIONS = NO | |
| 764 | 820 |
| 765 # If the GENERATE_DOCSET tag is set to YES, additional index files | 821 # If the GENERATE_DOCSET tag is set to YES, additional index files |
| 766 # will be generated that can be used as input for Apple's Xcode 3 | 822 # will be generated that can be used as input for Apple's Xcode 3 |
| 767 # integrated development environment, introduced with OSX 10.5 (Leopard). | 823 # integrated development environment, introduced with OSX 10.5 (Leopard). |
| 768 # To create a documentation set, doxygen will generate a Makefile in the | 824 # To create a documentation set, doxygen will generate a Makefile in the |
| 769 # HTML output directory. Running make will produce the docset in that | 825 # HTML output directory. Running make will produce the docset in that |
| 770 # directory and running "make install" will install the docset in | 826 # directory and running "make install" will install the docset in |
| 771 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find | 827 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find |
| 772 # it at startup. | 828 # it at startup. |
| 829 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. | |
| 773 | 830 |
| 774 GENERATE_DOCSET = NO | 831 GENERATE_DOCSET = NO |
| 775 | 832 |
| 776 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the | 833 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the |
| 777 # feed. A documentation feed provides an umbrella under which multiple | 834 # feed. A documentation feed provides an umbrella under which multiple |
| 785 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen | 842 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen |
| 786 # will append .docset to the name. | 843 # will append .docset to the name. |
| 787 | 844 |
| 788 DOCSET_BUNDLE_ID = org.doxygen.Project | 845 DOCSET_BUNDLE_ID = org.doxygen.Project |
| 789 | 846 |
| 790 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML | 847 # If the GENERATE_HTMLHELP tag is set to YES, additional index files |
| 791 # documentation will contain sections that can be hidden and shown after the | 848 # will be generated that can be used as input for tools like the |
| 792 # page has loaded. For this to work a browser that supports | 849 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) |
| 793 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox | 850 # of the generated HTML documentation. |
| 794 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). | 851 |
| 795 | 852 GENERATE_HTMLHELP = NO |
| 796 HTML_DYNAMIC_SECTIONS = NO | |
| 797 | 853 |
| 798 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can | 854 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can |
| 799 # be used to specify the file name of the resulting .chm file. You | 855 # be used to specify the file name of the resulting .chm file. You |
| 800 # can add a path in front of the file if the result should not be | 856 # can add a path in front of the file if the result should not be |
| 801 # written to the html output directory. | 857 # written to the html output directory. |
| 813 # controls if a separate .chi index file is generated (YES) or that | 869 # controls if a separate .chi index file is generated (YES) or that |
| 814 # it should be included in the master .chm file (NO). | 870 # it should be included in the master .chm file (NO). |
| 815 | 871 |
| 816 GENERATE_CHI = NO | 872 GENERATE_CHI = NO |
| 817 | 873 |
| 874 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING | |
| 875 # is used to encode HtmlHelp index (hhk), content (hhc) and project file | |
| 876 # content. | |
| 877 | |
| 878 CHM_INDEX_ENCODING = | |
| 879 | |
| 818 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag | 880 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag |
| 819 # controls whether a binary table of contents is generated (YES) or a | 881 # controls whether a binary table of contents is generated (YES) or a |
| 820 # normal table of contents (NO) in the .chm file. | 882 # normal table of contents (NO) in the .chm file. |
| 821 | 883 |
| 822 BINARY_TOC = NO | 884 BINARY_TOC = NO |
| 824 # The TOC_EXPAND flag can be set to YES to add extra items for group members | 886 # The TOC_EXPAND flag can be set to YES to add extra items for group members |
| 825 # to the contents of the HTML help documentation and to the tree view. | 887 # to the contents of the HTML help documentation and to the tree view. |
| 826 | 888 |
| 827 TOC_EXPAND = NO | 889 TOC_EXPAND = NO |
| 828 | 890 |
| 891 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER | |
| 892 # are set, an additional index file will be generated that can be used as input for | |
| 893 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated | |
| 894 # HTML documentation. | |
| 895 | |
| 896 GENERATE_QHP = NO | |
| 897 | |
| 898 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can | |
| 899 # be used to specify the file name of the resulting .qch file. | |
| 900 # The path specified is relative to the HTML output folder. | |
| 901 | |
| 902 QCH_FILE = | |
| 903 | |
| 904 # The QHP_NAMESPACE tag specifies the namespace to use when generating | |
| 905 # Qt Help Project output. For more information please see | |
| 906 # http://doc.trolltech.com/qthelpproject.html#namespace | |
| 907 | |
| 908 QHP_NAMESPACE = | |
| 909 | |
| 910 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating | |
| 911 # Qt Help Project output. For more information please see | |
| 912 # http://doc.trolltech.com/qthelpproject.html#virtual-folders | |
| 913 | |
| 914 QHP_VIRTUAL_FOLDER = doc | |
| 915 | |
| 916 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. | |
| 917 # For more information please see | |
| 918 # http://doc.trolltech.com/qthelpproject.html#custom-filters | |
| 919 | |
| 920 QHP_CUST_FILTER_NAME = | |
| 921 | |
| 922 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see | |
| 923 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. | |
| 924 | |
| 925 QHP_CUST_FILTER_ATTRS = | |
| 926 | |
| 927 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's | |
| 928 # filter section matches. | |
| 929 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>. | |
| 930 | |
| 931 QHP_SECT_FILTER_ATTRS = | |
| 932 | |
| 933 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can | |
| 934 # be used to specify the location of Qt's qhelpgenerator. | |
| 935 # If non-empty doxygen will try to run qhelpgenerator on the generated | |
| 936 # .qhp file. | |
| 937 | |
| 938 QHG_LOCATION = | |
| 939 | |
| 829 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at | 940 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at |
| 830 # top of each HTML page. The value NO (the default) enables the index and | 941 # top of each HTML page. The value NO (the default) enables the index and |
| 831 # the value YES disables it. | 942 # the value YES disables it. |
| 832 | 943 |
| 833 DISABLE_INDEX = NO | 944 DISABLE_INDEX = NO |
| 835 # This tag can be used to set the number of enum values (range [1..20]) | 946 # This tag can be used to set the number of enum values (range [1..20]) |
| 836 # that doxygen will group on one line in the generated HTML documentation. | 947 # that doxygen will group on one line in the generated HTML documentation. |
| 837 | 948 |
| 838 ENUM_VALUES_PER_LINE = 4 | 949 ENUM_VALUES_PER_LINE = 4 |
| 839 | 950 |
| 840 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be | 951 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index |
| 841 # generated containing a tree-like index structure (just like the one that | 952 # structure should be generated to display hierarchical information. |
| 953 # If the tag value is set to FRAME, a side panel will be generated | |
| 954 # containing a tree-like index structure (just like the one that | |
| 842 # is generated for HTML Help). For this to work a browser that supports | 955 # is generated for HTML Help). For this to work a browser that supports |
| 843 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, | 956 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, |
| 844 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are | 957 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are |
| 845 # probably better off using the HTML help feature. | 958 # probably better off using the HTML help feature. Other possible values |
| 959 # for this tag are: HIERARCHIES, which will generate the Groups, Directories, | |
| 960 # and Class Hierarchy pages using a tree view instead of an ordered list; | |
| 961 # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which | |
| 962 # disables this behavior completely. For backwards compatibility with previous | |
| 963 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE | |
| 964 # respectively. | |
| 846 | 965 |
| 847 GENERATE_TREEVIEW = YES | 966 GENERATE_TREEVIEW = YES |
| 848 | 967 |
| 849 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be | 968 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be |
| 850 # used to set the initial width (in pixels) of the frame in which the tree | 969 # used to set the initial width (in pixels) of the frame in which the tree |
| 851 # is shown. | 970 # is shown. |
| 852 | 971 |
| 853 TREEVIEW_WIDTH = 250 | 972 TREEVIEW_WIDTH = 250 |
| 973 | |
| 974 # Use this tag to change the font size of Latex formulas included | |
| 975 # as images in the HTML documentation. The default is 10. Note that | |
| 976 # when you change the font size after a successful doxygen run you need | |
| 977 # to manually remove any form_*.png images from the HTML output directory | |
| 978 # to force them to be regenerated. | |
| 979 | |
| 980 FORMULA_FONTSIZE = 10 | |
| 854 | 981 |
| 855 #--------------------------------------------------------------------------- | 982 #--------------------------------------------------------------------------- |
| 856 # configuration options related to the LaTeX output | 983 # configuration options related to the LaTeX output |
| 857 #--------------------------------------------------------------------------- | 984 #--------------------------------------------------------------------------- |
| 858 | 985 |
| 1062 # to generate PDF and DVI output from the Perl module output. | 1189 # to generate PDF and DVI output from the Perl module output. |
| 1063 | 1190 |
| 1064 PERLMOD_LATEX = NO | 1191 PERLMOD_LATEX = NO |
| 1065 | 1192 |
| 1066 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be | 1193 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be |
| 1067 # nicely formatted so it can be parsed by a human reader. This is useful | 1194 # nicely formatted so it can be parsed by a human reader. |
| 1068 # if you want to understand what is going on. On the other hand, if this | 1195 # This is useful |
| 1196 # if you want to understand what is going on. | |
| 1197 # On the other hand, if this | |
| 1069 # tag is set to NO the size of the Perl module output will be much smaller | 1198 # tag is set to NO the size of the Perl module output will be much smaller |
| 1070 # and Perl will parse it just the same. | 1199 # and Perl will parse it just the same. |
| 1071 | 1200 |
| 1072 PERLMOD_PRETTY = YES | 1201 PERLMOD_PRETTY = YES |
| 1073 | 1202 |
| 1150 | 1279 |
| 1151 # The TAGFILES option can be used to specify one or more tagfiles. | 1280 # The TAGFILES option can be used to specify one or more tagfiles. |
| 1152 # Optionally an initial location of the external documentation | 1281 # Optionally an initial location of the external documentation |
| 1153 # can be added for each tagfile. The format of a tag file without | 1282 # can be added for each tagfile. The format of a tag file without |
| 1154 # this location is as follows: | 1283 # this location is as follows: |
| 1155 # TAGFILES = file1 file2 ... | 1284 # |
| 1285 # TAGFILES = file1 file2 ... | |
| 1156 # Adding location for the tag files is done as follows: | 1286 # Adding location for the tag files is done as follows: |
| 1157 # TAGFILES = file1=loc1 "file2 = loc2" ... | 1287 # |
| 1288 # TAGFILES = file1=loc1 "file2 = loc2" ... | |
| 1158 # where "loc1" and "loc2" can be relative or absolute paths or | 1289 # where "loc1" and "loc2" can be relative or absolute paths or |
| 1159 # URLs. If a location is present for each tag, the installdox tool | 1290 # URLs. If a location is present for each tag, the installdox tool |
| 1160 # does not have to be run to correct the links. | 1291 # does not have to be run to correct the links. |
| 1161 # Note that each tag file must have a unique name | 1292 # Note that each tag file must have a unique name |
| 1162 # (where the name does NOT include the path) | 1293 # (where the name does NOT include the path) |
| 1163 # If a tag file is not located in the directory in which doxygen | 1294 # If a tag file is not located in the directory in which doxygen |
| 1164 # is run, you must also specify the path to the tagfile here. | 1295 # is run, you must also specify the path to the tagfile here. |
| 1165 | 1296 |
| 1166 TAGFILES = | 1297 TAGFILES = |
| 1167 | 1298 |
| 1196 # or super classes. Setting the tag to NO turns the diagrams off. Note that | 1327 # or super classes. Setting the tag to NO turns the diagrams off. Note that |
| 1197 # this option is superseded by the HAVE_DOT option below. This is only a | 1328 # this option is superseded by the HAVE_DOT option below. This is only a |
| 1198 # fallback. It is recommended to install and use dot, since it yields more | 1329 # fallback. It is recommended to install and use dot, since it yields more |
| 1199 # powerful graphs. | 1330 # powerful graphs. |
| 1200 | 1331 |
| 1201 CLASS_DIAGRAMS = NO | 1332 CLASS_DIAGRAMS = YES |
| 1202 | 1333 |
| 1203 # You can define message sequence charts within doxygen comments using the \msc | 1334 # You can define message sequence charts within doxygen comments using the \msc |
| 1204 # command. Doxygen will then run the mscgen tool (see | 1335 # command. Doxygen will then run the mscgen tool (see |
| 1205 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the | 1336 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the |
| 1206 # documentation. The MSCGEN_PATH tag allows you to specify the directory where | 1337 # documentation. The MSCGEN_PATH tag allows you to specify the directory where |
| 1220 # toolkit from AT&T and Lucent Bell Labs. The other options in this section | 1351 # toolkit from AT&T and Lucent Bell Labs. The other options in this section |
| 1221 # have no effect if this option is set to NO (the default) | 1352 # have no effect if this option is set to NO (the default) |
| 1222 | 1353 |
| 1223 HAVE_DOT = YES | 1354 HAVE_DOT = YES |
| 1224 | 1355 |
| 1356 # By default doxygen will write a font called FreeSans.ttf to the output | |
| 1357 # directory and reference it in all dot files that doxygen generates. This | |
| 1358 # font does not include all possible unicode characters however, so when you need | |
| 1359 # these (or just want a differently looking font) you can specify the font name | |
| 1360 # using DOT_FONTNAME. You need need to make sure dot is able to find the font, | |
| 1361 # which can be done by putting it in a standard location or by setting the | |
| 1362 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory | |
| 1363 # containing the font. | |
| 1364 | |
| 1365 DOT_FONTNAME = DejaVuSansCondensed | |
| 1366 | |
| 1367 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. | |
| 1368 # The default size is 10pt. | |
| 1369 | |
| 1370 DOT_FONTSIZE = 9 | |
| 1371 | |
| 1372 # By default doxygen will tell dot to use the output directory to look for the | |
| 1373 # FreeSans.ttf font (which doxygen will put there itself). If you specify a | |
| 1374 # different font using DOT_FONTNAME you can set the path where dot | |
| 1375 # can find it using this tag. | |
| 1376 | |
| 1377 DOT_FONTPATH = /usr/share/fonts/truetype/ttf-dejavu | |
| 1378 | |
| 1225 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen | 1379 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen |
| 1226 # will generate a graph for each documented class showing the direct and | 1380 # will generate a graph for each documented class showing the direct and |
| 1227 # indirect inheritance relations. Setting this tag to YES will force the | 1381 # indirect inheritance relations. Setting this tag to YES will force the |
| 1228 # the CLASS_DIAGRAMS tag to NO. | 1382 # the CLASS_DIAGRAMS tag to NO. |
| 1229 | 1383 |
| 1287 | 1441 |
| 1288 GRAPHICAL_HIERARCHY = YES | 1442 GRAPHICAL_HIERARCHY = YES |
| 1289 | 1443 |
| 1290 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES | 1444 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES |
| 1291 # then doxygen will show the dependencies a directory has on other directories | 1445 # then doxygen will show the dependencies a directory has on other directories |
| 1292 # in a graphical way. The dependency relations are determined by the #include | 1446 # in a graphical way. The dependency relations are determined by the #include |
| 1293 # relations between the files in the directories. | 1447 # relations between the files in the directories. |
| 1294 | 1448 |
| 1295 DIRECTORY_GRAPH = YES | 1449 DIRECTORY_GRAPH = YES |
| 1296 | 1450 |
| 1297 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images | 1451 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images |
| 1298 # generated by dot. Possible values are png, jpg, or gif | 1452 # generated by dot. Possible values are png, jpg, or gif |
| 1299 # If left blank png will be used. | 1453 # If left blank png will be used. |
| 1300 | 1454 |
| 1301 DOT_IMAGE_FORMAT = png | 1455 DOT_IMAGE_FORMAT = png |
| 1302 | 1456 |
| 1303 # The tag DOT_PATH can be used to specify the path where the dot tool can be | 1457 # The tag DOT_PATH can be used to specify the path where the dot tool can be |
| 1309 # contain dot files that are included in the documentation (see the | 1463 # contain dot files that are included in the documentation (see the |
| 1310 # \dotfile command). | 1464 # \dotfile command). |
| 1311 | 1465 |
| 1312 DOTFILE_DIRS = | 1466 DOTFILE_DIRS = |
| 1313 | 1467 |
| 1314 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of | 1468 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of |
| 1315 # nodes that will be shown in the graph. If the number of nodes in a graph | 1469 # nodes that will be shown in the graph. If the number of nodes in a graph |
| 1316 # becomes larger than this value, doxygen will truncate the graph, which is | 1470 # becomes larger than this value, doxygen will truncate the graph, which is |
| 1317 # visualized by representing a node as a red box. Note that doxygen if the | 1471 # visualized by representing a node as a red box. Note that doxygen if the |
| 1318 # number of direct children of the root node in a graph is already larger than | 1472 # number of direct children of the root node in a graph is already larger than |
| 1319 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note | 1473 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note |
| 1330 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. | 1484 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. |
| 1331 | 1485 |
| 1332 MAX_DOT_GRAPH_DEPTH = 0 | 1486 MAX_DOT_GRAPH_DEPTH = 0 |
| 1333 | 1487 |
| 1334 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent | 1488 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent |
| 1335 # background. This is enabled by default, which results in a transparent | 1489 # background. This is disabled by default, because dot on Windows does not |
| 1336 # background. Warning: Depending on the platform used, enabling this option | 1490 # seem to support this out of the box. Warning: Depending on the platform used, |
| 1337 # may lead to badly anti-aliased labels on the edges of a graph (i.e. they | 1491 # enabling this option may lead to badly anti-aliased labels on the edges of |
| 1338 # become hard to read). | 1492 # a graph (i.e. they become hard to read). |
| 1339 | 1493 |
| 1340 DOT_TRANSPARENT = NO | 1494 DOT_TRANSPARENT = NO |
| 1341 | 1495 |
| 1342 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output | 1496 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output |
| 1343 # files in one run (i.e. multiple -o and -T options on the command line). This | 1497 # files in one run (i.e. multiple -o and -T options on the command line). This |
| 1357 # the various graphs. | 1511 # the various graphs. |
| 1358 | 1512 |
| 1359 DOT_CLEANUP = YES | 1513 DOT_CLEANUP = YES |
| 1360 | 1514 |
| 1361 #--------------------------------------------------------------------------- | 1515 #--------------------------------------------------------------------------- |
| 1362 # Configuration::additions related to the search engine | 1516 # Options related to the search engine |
| 1363 #--------------------------------------------------------------------------- | 1517 #--------------------------------------------------------------------------- |
| 1364 | 1518 |
| 1365 # The SEARCHENGINE tag specifies whether or not a search engine should be | 1519 # The SEARCHENGINE tag specifies whether or not a search engine should be |
| 1366 # used. If set to NO the values of all tags below this one will be ignored. | 1520 # used. If set to NO the values of all tags below this one will be ignored. |
| 1367 | 1521 |
