Check-in [a31f7f44c3]

Not logged in

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
SHA1 Hash:a31f7f44c3e5c3af093d097cf3b6d547cac9ded0
Date: 2009-06-15 19:27:04
User: stephan
Comment:updated with 'doxygen -u'
Tags And Properties
Changes
hide diffs unified diffs patch

Changes to Doxyfile-hacker

Old (370a0418ddb9d916) New (e7dd6e43402d80b0)
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
22 hidden lines
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 = # @PACKAGE_VERSION@ | 34 PROJECT_NUMBER =
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.
15 hidden lines
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
86 hidden lines
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 = NO <
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 = NO 162 INHERIT_DOCS = NO
42 hidden lines
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
9 hidden lines
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.
15 hidden lines
256 # namespace, or class. And the struct will be named TypeS. This can typically 269 # namespace, or class. And the struct will be named TypeS. This can typically
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
> 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
261 290
262 #--------------------------------------------------------------------------- 291 #---------------------------------------------------------------------------
263 # Build related configuration options 292 # Build related configuration options
264 #--------------------------------------------------------------------------- 293 #---------------------------------------------------------------------------
265 294
175 hidden lines
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 =
> 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 =
455 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
51 hidden lines
511 # The INPUT tag can be used to specify the files and/or directories that contain 562 # The INPUT tag can be used to specify the files and/or directories that contain
512 # documented source files. You may enter file names like "myfile.cpp" or 563 # documented source files. You may enter file names like "myfile.cpp" or
513 # directories like "/usr/src/myproject". Separate the files or directories 564 # directories like "/usr/src/myproject". Separate the files or directories
514 # with spaces. 565 # with spaces.
515 566
516 INPUT = whefs_amalgamation.h whefs_details.c | 567 INPUT = whefs_details.c whefs_amalgamation.h
517 # @DOXYGEN_INPUT@ | 568
518 569
519 # This tag can be used to specify the character encoding of the source files 570 # This tag can be used to specify the character encoding of the source files
520 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 571 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
521 # also the default input encoding. Doxygen uses libiconv (or the iconv built 572 # also the default input encoding. Doxygen uses libiconv (or the iconv built
522 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 573 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
73 hidden lines
596 # The INPUT_FILTER tag can be used to specify a program that doxygen should 647 # The INPUT_FILTER tag can be used to specify a program that doxygen should
597 # invoke to filter for each input file. Doxygen will invoke the filter program 648 # invoke to filter for each input file. Doxygen will invoke the filter program
598 # by executing (via popen()) the command <filter> <input-file>, where <filter> 649 # by executing (via popen()) the command <filter> <input-file>, where <filter>
599 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 650 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
600 # input file. Doxygen will then use the output that the filter program writes 651 # input file. Doxygen will then use the output that the filter program writes
601 # to standard output. If FILTER_PATTERNS is specified, this tag will be | 652 # to standard output.
| 653 # If FILTER_PATTERNS is specified, this tag will be
602 # ignored. 654 # ignored.
603 655
604 INPUT_FILTER = 656 INPUT_FILTER =
605 657
606 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 658 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
607 # basis. Doxygen will compare the file name with each pattern and apply the | 659 # basis.
608 # filter if there is a match. The filters are a list of the form: | 660 # Doxygen will compare the file name with each pattern and apply the
| 661 # filter if there is a match.
| 662 # The filters are a list of the form:
609 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 663 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
610 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 664 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
611 # is applied to all files. 665 # is applied to all files.
612 666
613 FILTER_PATTERNS = 667 FILTER_PATTERNS =
24 hidden lines
638 # doxygen to hide any special comment blocks from generated source code 692 # doxygen to hide any special comment blocks from generated source code
639 # fragments. Normal C and C++ comments will always remain visible. 693 # fragments. Normal C and C++ comments will always remain visible.
640 694
641 STRIP_CODE_COMMENTS = NO 695 STRIP_CODE_COMMENTS = NO
642 696
643 # If the REFERENCED_BY_RELATION tag is set to YES (the default) | 697 # If the REFERENCED_BY_RELATION tag is set to YES
644 # then for each documented function all documented 698 # then for each documented function all documented
645 # functions referencing it will be listed. 699 # functions referencing it will be listed.
646 700
647 REFERENCED_BY_RELATION = YES 701 REFERENCED_BY_RELATION = YES
648 702
649 # If the REFERENCES_RELATION tag is set to YES (the default) | 703 # If the REFERENCES_RELATION tag is set to YES
650 # then for each documented function all documented entities 704 # then for each documented function all documented entities
651 # called/used by that function will be listed. 705 # called/used by that function will be listed.
652 706
653 REFERENCES_RELATION = YES 707 REFERENCES_RELATION = YES
654 708
655 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 709 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
656 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 710 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
657 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 711 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
658 # link to the source code. Otherwise they will link to the documentstion. | 712 # link to the source code.
| 713 # Otherwise they will link to the documentation.
659 714
660 REFERENCES_LINK_SOURCE = YES 715 REFERENCES_LINK_SOURCE = YES
661 716
662 # If the USE_HTAGS tag is set to YES then the references to source code 717 # If the USE_HTAGS tag is set to YES then the references to source code
663 # will point to the HTML generated by the htags(1) tool instead of doxygen 718 # will point to the HTML generated by the htags(1) tool instead of doxygen
78 hidden lines
742 # files or namespaces will be aligned in HTML using tables. If set to 797 # files or namespaces will be aligned in HTML using tables. If set to
743 # NO a bullet list will be used. 798 # NO a bullet list will be used.
744 799
745 HTML_ALIGN_MEMBERS = YES 800 HTML_ALIGN_MEMBERS = YES
746 801
747 # If the GENERATE_HTMLHELP tag is set to YES, additional index files | 802 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
748 # will be generated that can be used as input for tools like the | 803 # documentation will contain sections that can be hidden and shown after the
749 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) | 804 # page has loaded. For this to work a browser that supports
750 # of the generated HTML documentation. | 805 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
| 806 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
751 807
752 GENERATE_HTMLHELP = NO | 808 HTML_DYNAMIC_SECTIONS = NO
753 809
754 # If the GENERATE_DOCSET tag is set to YES, additional index files 810 # If the GENERATE_DOCSET tag is set to YES, additional index files
755 # will be generated that can be used as input for Apple's Xcode 3 811 # will be generated that can be used as input for Apple's Xcode 3
756 # integrated development environment, introduced with OSX 10.5 (Leopard). 812 # integrated development environment, introduced with OSX 10.5 (Leopard).
757 # To create a documentation set, doxygen will generate a Makefile in the 813 # To create a documentation set, doxygen will generate a Makefile in the
758 # HTML output directory. Running make will produce the docset in that 814 # HTML output directory. Running make will produce the docset in that
759 # directory and running "make install" will install the docset in 815 # directory and running "make install" will install the docset in
760 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 816 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
761 # it at startup. 817 # it at startup.
> 818 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
762 819
763 GENERATE_DOCSET = NO 820 GENERATE_DOCSET = NO
764 821
765 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 822 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
766 # feed. A documentation feed provides an umbrella under which multiple 823 # feed. A documentation feed provides an umbrella under which multiple
7 hidden lines
774 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 831 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
775 # will append .docset to the name. 832 # will append .docset to the name.
776 833
777 DOCSET_BUNDLE_ID = org.doxygen.Project 834 DOCSET_BUNDLE_ID = org.doxygen.Project
778 835
779 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML | 836 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
780 # documentation will contain sections that can be hidden and shown after the | 837 # will be generated that can be used as input for tools like the
781 # page has loaded. For this to work a browser that supports | 838 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
782 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox | 839 # of the generated HTML documentation.
783 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). |
784 840
785 HTML_DYNAMIC_SECTIONS = NO | 841 GENERATE_HTMLHELP = NO
786 842
787 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 843 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
788 # be used to specify the file name of the resulting .chm file. You 844 # be used to specify the file name of the resulting .chm file. You
789 # can add a path in front of the file if the result should not be 845 # can add a path in front of the file if the result should not be
790 # written to the html output directory. 846 # written to the html output directory.
11 hidden lines
802 # controls if a separate .chi index file is generated (YES) or that 858 # controls if a separate .chi index file is generated (YES) or that
803 # it should be included in the master .chm file (NO). 859 # it should be included in the master .chm file (NO).
804 860
805 GENERATE_CHI = NO 861 GENERATE_CHI = NO
806 862
> 863 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
> 864 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
> 865 # content.
> 866
> 867 CHM_INDEX_ENCODING =
> 868
807 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 869 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
808 # controls whether a binary table of contents is generated (YES) or a 870 # controls whether a binary table of contents is generated (YES) or a
809 # normal table of contents (NO) in the .chm file. 871 # normal table of contents (NO) in the .chm file.
810 872
811 BINARY_TOC = NO 873 BINARY_TOC = NO
813 # The TOC_EXPAND flag can be set to YES to add extra items for group members 875 # The TOC_EXPAND flag can be set to YES to add extra items for group members
814 # to the contents of the HTML help documentation and to the tree view. 876 # to the contents of the HTML help documentation and to the tree view.
815 877
816 TOC_EXPAND = NO 878 TOC_EXPAND = NO
817 879
> 880 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
> 881 # are set, an additional index file will be generated that can be used as input for
> 882 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
> 883 # HTML documentation.
> 884
> 885 GENERATE_QHP = NO
> 886
> 887 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
> 888 # be used to specify the file name of the resulting .qch file.
> 889 # The path specified is relative to the HTML output folder.
> 890
> 891 QCH_FILE =
> 892
> 893 # The QHP_NAMESPACE tag specifies the namespace to use when generating
> 894 # Qt Help Project output. For more information please see
> 895 # http://doc.trolltech.com/qthelpproject.html#namespace
> 896
> 897 QHP_NAMESPACE =
> 898
> 899 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
> 900 # Qt Help Project output. For more information please see
> 901 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
> 902
> 903 QHP_VIRTUAL_FOLDER = doc
> 904
> 905 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
> 906 # For more information please see
> 907 # http://doc.trolltech.com/qthelpproject.html#custom-filters
> 908
> 909 QHP_CUST_FILTER_NAME =
> 910
> 911 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
> 912 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
> 913
> 914 QHP_CUST_FILTER_ATTRS =
> 915
> 916 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
> 917 # filter section matches.
> 918 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
> 919
> 920 QHP_SECT_FILTER_ATTRS =
> 921
> 922 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
> 923 # be used to specify the location of Qt's qhelpgenerator.
> 924 # If non-empty doxygen will try to run qhelpgenerator on the generated
> 925 # .qhp file.
> 926
> 927 QHG_LOCATION =
> 928
818 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 929 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
819 # top of each HTML page. The value NO (the default) enables the index and 930 # top of each HTML page. The value NO (the default) enables the index and
820 # the value YES disables it. 931 # the value YES disables it.
821 932
822 DISABLE_INDEX = NO 933 DISABLE_INDEX = NO
824 # This tag can be used to set the number of enum values (range [1..20]) 935 # This tag can be used to set the number of enum values (range [1..20])
825 # that doxygen will group on one line in the generated HTML documentation. 936 # that doxygen will group on one line in the generated HTML documentation.
826 937
827 ENUM_VALUES_PER_LINE = 1 938 ENUM_VALUES_PER_LINE = 1
828 939
829 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be | 940 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
830 # generated containing a tree-like index structure (just like the one that | 941 # structure should be generated to display hierarchical information.
| 942 # If the tag value is set to FRAME, a side panel will be generated
| 943 # containing a tree-like index structure (just like the one that
831 # is generated for HTML Help). For this to work a browser that supports 944 # is generated for HTML Help). For this to work a browser that supports
832 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 945 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
833 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 946 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
834 # probably better off using the HTML help feature. | 947 # probably better off using the HTML help feature. Other possible values
| 948 # for this tag are: HIERARCHIES, which will generate the Groups, Directories,
| 949 # and Class Hierarchy pages using a tree view instead of an ordered list;
| 950 # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
| 951 # disables this behavior completely. For backwards compatibility with previous
| 952 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
| 953 # respectively.
835 954
836 GENERATE_TREEVIEW = YES 955 GENERATE_TREEVIEW = YES
837 956
838 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 957 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
839 # used to set the initial width (in pixels) of the frame in which the tree 958 # used to set the initial width (in pixels) of the frame in which the tree
840 # is shown. 959 # is shown.
841 960
842 TREEVIEW_WIDTH = 300 961 TREEVIEW_WIDTH = 300
843 962
> 963 # Use this tag to change the font size of Latex formulas included
> 964 # as images in the HTML documentation. The default is 10. Note that
> 965 # when you change the font size after a successful doxygen run you need
> 966 # to manually remove any form_*.png images from the HTML output directory
> 967 # to force them to be regenerated.
> 968
> 969 FORMULA_FONTSIZE = 10
> 970
844 #--------------------------------------------------------------------------- 971 #---------------------------------------------------------------------------
845 # configuration options related to the LaTeX output 972 # configuration options related to the LaTeX output
846 #--------------------------------------------------------------------------- 973 #---------------------------------------------------------------------------
847 974
848 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 975 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
849 # generate Latex output. 976 # generate Latex output.
850 977
851 GENERATE_LATEX = NO # @GENERATE_LATEX@ | 978 GENERATE_LATEX = NO
852 979
853 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 980 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
854 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 981 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
855 # put in front of it. If left blank `latex' will be used as the default path. 982 # put in front of it. If left blank `latex' will be used as the default path.
856 983
857 LATEX_OUTPUT = NO # @LATEX_OUTPUT@ | 984 LATEX_OUTPUT = NO
858 985
859 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 986 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
860 # invoked. If left blank `latex' will be used as the default command name. 987 # invoked. If left blank `latex' will be used as the default command name.
861 988
862 LATEX_CMD_NAME = latex 989 LATEX_CMD_NAME = latex
188 hidden lines
1051 # to generate PDF and DVI output from the Perl module output. 1178 # to generate PDF and DVI output from the Perl module output.
1052 1179
1053 PERLMOD_LATEX = NO 1180 PERLMOD_LATEX = NO
1054 1181
1055 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1182 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1056 # nicely formatted so it can be parsed by a human reader. This is useful | 1183 # nicely formatted so it can be parsed by a human reader.
1057 # if you want to understand what is going on. On the other hand, if this | 1184 # This is useful
| 1185 # if you want to understand what is going on.
| 1186 # On the other hand, if this
1058 # tag is set to NO the size of the Perl module output will be much smaller 1187 # tag is set to NO the size of the Perl module output will be much smaller
1059 # and Perl will parse it just the same. 1188 # and Perl will parse it just the same.
1060 1189
1061 PERLMOD_PRETTY = YES 1190 PERLMOD_PRETTY = YES
1062 1191
51 hidden lines
1114 # or name=definition (no spaces). If the definition and the = are 1243 # or name=definition (no spaces). If the definition and the = are
1115 # omitted =1 is assumed. To prevent a macro definition from being 1244 # omitted =1 is assumed. To prevent a macro definition from being
1116 # undefined via #undef or recursively expanded use the := operator 1245 # undefined via #undef or recursively expanded use the := operator
1117 # instead of the = operator. 1246 # instead of the = operator.
1118 1247
1119 # this __cplusplus define is a kludge to get doxygen to hide my <
1120 # 'bool' stuff from the docs. <
1121 PREDEFINED = __cplusplus 1248 PREDEFINED = __cplusplus
1122 1249
1123 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1250 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1124 # this tag can be used to specify a list of macro names that should be expanded. 1251 # this tag can be used to specify a list of macro names that should be expanded.
1125 # The macro definition that is found in the sources will be used. 1252 # The macro definition that is found in the sources will be used.
15 hidden lines
1141 1268
1142 # The TAGFILES option can be used to specify one or more tagfiles. 1269 # The TAGFILES option can be used to specify one or more tagfiles.
1143 # Optionally an initial location of the external documentation 1270 # Optionally an initial location of the external documentation
1144 # can be added for each tagfile. The format of a tag file without 1271 # can be added for each tagfile. The format of a tag file without
1145 # this location is as follows: 1272 # this location is as follows:
1146 # TAGFILES = file1 file2 ... | 1273 #
| 1274 # TAGFILES = file1 file2 ...
1147 # Adding location for the tag files is done as follows: 1275 # Adding location for the tag files is done as follows:
1148 # TAGFILES = file1=loc1 "file2 = loc2" ... | 1276 #
| 1277 # TAGFILES = file1=loc1 "file2 = loc2" ...
1149 # where "loc1" and "loc2" can be relative or absolute paths or 1278 # where "loc1" and "loc2" can be relative or absolute paths or
1150 # URLs. If a location is present for each tag, the installdox tool 1279 # URLs. If a location is present for each tag, the installdox tool
1151 # does not have to be run to correct the links. 1280 # does not have to be run to correct the links.
1152 # Note that each tag file must have a unique name 1281 # Note that each tag file must have a unique name
1153 # (where the name does NOT include the path) 1282 # (where the name does NOT include the path)
20 hidden lines
1174 EXTERNAL_GROUPS = YES 1303 EXTERNAL_GROUPS = YES
1175 1304
1176 # The PERL_PATH should be the absolute path and name of the perl script 1305 # The PERL_PATH should be the absolute path and name of the perl script
1177 # interpreter (i.e. the result of `which perl'). 1306 # interpreter (i.e. the result of `which perl').
1178 1307
1179 # PERL_PATH = @PERL@ | 1308 PERL_PATH = /usr/bin/perl
1180 1309
1181 #--------------------------------------------------------------------------- 1310 #---------------------------------------------------------------------------
1182 # Configuration options related to the dot tool 1311 # Configuration options related to the dot tool
1183 #--------------------------------------------------------------------------- 1312 #---------------------------------------------------------------------------
1184 1313
24 hidden lines
1209 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1338 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1210 # available from the path. This tool is part of Graphviz, a graph visualization 1339 # available from the path. This tool is part of Graphviz, a graph visualization
1211 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 1340 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1212 # have no effect if this option is set to NO (the default) 1341 # have no effect if this option is set to NO (the default)
1213 1342
1214 HAVE_DOT = NO # @USE_DOT@ | 1343 HAVE_DOT = NO
| 1344
| 1345 # By default doxygen will write a font called FreeSans.ttf to the output
| 1346 # directory and reference it in all dot files that doxygen generates. This
| 1347 # font does not include all possible unicode characters however, so when you need
| 1348 # these (or just want a differently looking font) you can specify the font name
| 1349 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
| 1350 # which can be done by putting it in a standard location or by setting the
| 1351 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
| 1352 # containing the font.
| 1353
| 1354 DOT_FONTNAME = FreeSans
| 1355
| 1356 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
| 1357 # The default size is 10pt.
| 1358
| 1359 DOT_FONTSIZE = 10
| 1360
| 1361 # By default doxygen will tell dot to use the output directory to look for the
| 1362 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
| 1363 # different font using DOT_FONTNAME you can set the path where dot
| 1364 # can find it using this tag.
| 1365
| 1366 DOT_FONTPATH =
1215 1367
1216 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1368 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1217 # will generate a graph for each documented class showing the direct and 1369 # will generate a graph for each documented class showing the direct and
1218 # indirect inheritance relations. Setting this tag to YES will force the 1370 # indirect inheritance relations. Setting this tag to YES will force the
1219 # the CLASS_DIAGRAMS tag to NO. 1371 # the CLASS_DIAGRAMS tag to NO.
80 hidden lines
1300 # contain dot files that are included in the documentation (see the 1452 # contain dot files that are included in the documentation (see the
1301 # \dotfile command). 1453 # \dotfile command).
1302 1454
1303 DOTFILE_DIRS = 1455 DOTFILE_DIRS =
1304 1456
1305 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of | 1457 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1306 # nodes that will be shown in the graph. If the number of nodes in a graph 1458 # nodes that will be shown in the graph. If the number of nodes in a graph
1307 # becomes larger than this value, doxygen will truncate the graph, which is 1459 # becomes larger than this value, doxygen will truncate the graph, which is
1308 # visualized by representing a node as a red box. Note that doxygen if the 1460 # visualized by representing a node as a red box. Note that doxygen if the
1309 # number of direct children of the root node in a graph is already larger than 1461 # number of direct children of the root node in a graph is already larger than
1310 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 1462 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
10 hidden lines
1321 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 1473 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1322 1474
1323 MAX_DOT_GRAPH_DEPTH = 0 1475 MAX_DOT_GRAPH_DEPTH = 0
1324 1476
1325 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1477 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1326 # background. This is enabled by default, which results in a transparent | 1478 # background. This is disabled by default, because dot on Windows does not
1327 # background. Warning: Depending on the platform used, enabling this option | 1479 # seem to support this out of the box. Warning: Depending on the platform used,
1328 # may lead to badly anti-aliased labels on the edges of a graph (i.e. they | 1480 # enabling this option may lead to badly anti-aliased labels on the edges of
1329 # become hard to read). | 1481 # a graph (i.e. they become hard to read).
1330 1482
1331 DOT_TRANSPARENT = NO 1483 DOT_TRANSPARENT = NO
1332 1484
1333 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1485 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1334 # files in one run (i.e. multiple -o and -T options on the command line). This 1486 # files in one run (i.e. multiple -o and -T options on the command line). This
13 hidden lines
1348 # the various graphs. 1500 # the various graphs.
1349 1501
1350 DOT_CLEANUP = YES 1502 DOT_CLEANUP = YES
1351 1503
1352 #--------------------------------------------------------------------------- 1504 #---------------------------------------------------------------------------
1353 # Configuration::additions related to the search engine | 1505 # Options related to the search engine
1354 #--------------------------------------------------------------------------- 1506 #---------------------------------------------------------------------------
1355 1507
1356 # The SEARCHENGINE tag specifies whether or not a search engine should be 1508 # The SEARCHENGINE tag specifies whether or not a search engine should be
1357 # used. If set to NO the values of all tags below this one will be ignored. 1509 # used. If set to NO the values of all tags below this one will be ignored.
1358 1510
1359 SEARCHENGINE = NO 1511 SEARCHENGINE = NO