Changeset 56 in 3DVCSoftware for trunk/doc/Doxyfile
- Timestamp:
- 11 May 2012, 21:20:17 (12 years ago)
- File:
-
- 1 edited
-
trunk/doc/Doxyfile (modified) (52 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/doc/Doxyfile
r2 r56 1 # Doxyfile 1. 6.31 # Doxyfile 1.7.5 2 2 3 3 # This file describes the settings to be used by the documentation system … … 23 23 DOXYFILE_ENCODING = UTF-8 24 24 25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 26 # by quotes) that should identify the project. 27 28 PROJECT_NAME = "Test Model under Consideration (TMuC)" 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 29 PROJECT_NAME = "HEVC Test Model (HM)" 29 30 30 31 # The PROJECT_NUMBER tag can be used to enter a project or revision number. … … 32 33 # if some version control system is used. 33 34 34 PROJECT_NUMBER = "Software implementation candidate" 35 PROJECT_NUMBER = HM-3.4 36 37 # Using the PROJECT_BRIEF tag one can provide an optional one line description 38 # for a project that appears at the top of each page and should give viewer 39 # a quick idea about the purpose of the project. Keep the description short. 40 41 PROJECT_BRIEF = 42 43 # With the PROJECT_LOGO tag one can specify an logo or icon that is 44 # included in the documentation. The maximum height of the logo should not 45 # exceed 55 pixels and the maximum width should not exceed 200 pixels. 46 # Doxygen will copy the logo to the output directory. 47 48 PROJECT_LOGO = 35 49 36 50 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) … … 58 72 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 59 73 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 60 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyril ic, Slovak,74 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, 61 75 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. 62 76 … … 125 139 # path to strip. 126 140 127 STRIP_FROM_PATH = 141 STRIP_FROM_PATH = ../source 128 142 129 143 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of … … 137 151 138 152 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 139 # (but less readable) file names. This can be useful i s your file systems153 # (but less readable) file names. This can be useful if your file system 140 154 # doesn't support long names like on DOS, Mac, or CD-ROM. 141 155 … … 181 195 # Doxygen uses this value to replace tabs by spaces in code fragments. 182 196 183 TAB_SIZE = 2197 TAB_SIZE = 8 184 198 185 199 # This tag can be used to specify a number of aliases that acts … … 218 232 OPTIMIZE_OUTPUT_VHDL = NO 219 233 220 # Doxygen selects the parser to use depending on the extension of the files it parses.221 # With this tag you can assign which parser to use for a given extension.222 # Doxygen has a built-in mapping, but you can override or extend it using this tag.223 # The format is ext=language, where ext is a file extension, and language is one of224 # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,225 # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat226 # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),227 # use: inc=Fortran f=C. Note that for custom extensions you also need to set228 # FILE_PATTERNS otherwise the files are not read by doxygen.234 # Doxygen selects the parser to use depending on the extension of the files it 235 # parses. With this tag you can assign which parser to use for a given extension. 236 # Doxygen has a built-in mapping, but you can override or extend it using this 237 # tag. The format is ext=language, where ext is a file extension, and language 238 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, 239 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make 240 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C 241 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions 242 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. 229 243 230 244 EXTENSION_MAPPING = … … 234 248 # set this tag to YES in order to let doxygen match functions declarations and 235 249 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 236 # func(std::string) {}). This also make the inheritance and collaboration250 # func(std::string) {}). This also makes the inheritance and collaboration 237 251 # diagrams that involve STL classes more complete and accurate. 238 252 … … 252 266 # For Microsoft's IDL there are propget and propput attributes to indicate getter 253 267 # and setter methods for a property. Setting this option to YES (the default) 254 # will make doxygen toreplace the get and set methods by a property in the268 # will make doxygen replace the get and set methods by a property in the 255 269 # documentation. This will only work if the methods are indeed getting or 256 270 # setting a simple type. If this is not the case, or you want to show the … … 273 287 274 288 SUBGROUPING = YES 289 290 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and 291 # unions are shown inside the group in which they are included (e.g. using 292 # @ingroup) instead of on a separate page (for HTML and Man pages) or 293 # section (for LaTeX and RTF). 294 295 INLINE_GROUPED_CLASSES = NO 296 297 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and 298 # unions with only public data fields will be shown inline in the documentation 299 # of the scope in which they are defined (i.e. file, namespace, or group 300 # documentation), provided this scope is documented. If set to NO (the default), 301 # structs, classes, and unions are shown on a separate page (for HTML and Man 302 # pages) or section (for LaTeX and RTF). 303 304 INLINE_SIMPLE_STRUCTS = NO 275 305 276 306 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum … … 290 320 # probably good enough. For larger projects a too small cache size can cause 291 321 # doxygen to be busy swapping symbols to and from disk most of the time 292 # causing a significant performance penal ity.322 # causing a significant performance penalty. 293 323 # If the system has enough physical memory increasing the cache will improve the 294 324 # performance by keeping more symbols in memory. Note that the value works on 295 # a logarithmic scale so increasing the size by one will roug ly double the325 # a logarithmic scale so increasing the size by one will roughly double the 296 326 # memory usage. The cache size is given by this formula: 297 327 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, … … 309 339 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 310 340 311 EXTRACT_ALL = NO341 EXTRACT_ALL = YES 312 342 313 343 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class … … 338 368 # 'anonymous_namespace{file}', where file will be replaced with the base 339 369 # name of the file that contains the anonymous namespace. By default 340 # anonymous namespace are hidden.370 # anonymous namespaces are hidden. 341 371 342 372 EXTRACT_ANON_NSPACES = NO … … 423 453 SORT_BRIEF_DOCS = NO 424 454 425 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 426 # will sort the (brief and detailed) documentation of class members so that 427 # constructors and destructors are listed first. If set to NO (the default) 428 # the constructors will appear in the respective orders defined by 429 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 430 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 455 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 456 # will sort the (brief and detailed) documentation of class members so that 457 # constructors and destructors are listed first. If set to NO (the default) 458 # the constructors will appear in the respective orders defined by 459 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 460 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 431 461 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 432 462 … … 449 479 SORT_BY_SCOPE_NAME = NO 450 480 481 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to 482 # do proper type resolution of all parameters of a function it will reject a 483 # match between the prototype and the implementation of a member function even 484 # if there is only one candidate or it is obvious which candidate to choose 485 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen 486 # will still accept a match between prototype and implementation in such cases. 487 488 STRICT_PROTO_MATCHING = NO 489 451 490 # The GENERATE_TODOLIST tag can be used to enable (YES) or 452 491 # disable (NO) the todo list. This list is created by putting \todo … … 479 518 480 519 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 481 # the initial value of a variable or defineconsists of for it to appear in520 # the initial value of a variable or macro consists of for it to appear in 482 521 # the documentation. If the initializer consists of more lines than specified 483 522 # here it will be hidden. Use a value of 0 to hide initializers completely. 484 # The appearance of the initializer of individual variables and defines in the523 # The appearance of the initializer of individual variables and macros in the 485 524 # documentation can be controlled using \showinitializer or \hideinitializer 486 525 # command in the documentation regardless of this setting. … … 522 561 FILE_VERSION_FILTER = 523 562 524 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by525 # doxygen. The layout file controls the global structure of the generated output files526 # in an output format independent way. The create the layout file that represents527 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a528 # file name after the option, if omitted DoxygenLayout.xml will be used as the name529 # of the layout file.563 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 564 # by doxygen. The layout file controls the global structure of the generated 565 # output files in an output format independent way. The create the layout file 566 # that represents doxygen's defaults, run doxygen with the -l option. 567 # You can optionally specify a file name after the option, if omitted 568 # DoxygenLayout.xml will be used as the name of the layout file. 530 569 531 570 LAYOUT_FILE = 571 572 # The CITE_BIB_FILES tag can be used to specify one or more bib files 573 # containing the references data. This must be a list of .bib files. The 574 # .bib extension is automatically appended if omitted. Using this command 575 # requires the bibtex tool to be installed. See also 576 # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style 577 # of the bibliography can be controlled using LATEX_BIB_STYLE. 578 579 CITE_BIB_FILES = 532 580 533 581 #--------------------------------------------------------------------------- … … 559 607 WARN_IF_DOC_ERROR = YES 560 608 561 # Th is WARN_NO_PARAMDOC option can beabled to get warnings for609 # The WARN_NO_PARAMDOC option can be enabled to get warnings for 562 610 # functions that are documented, but have no documentation for their parameters 563 611 # or return value. If set to NO (the default) doxygen will only warn about … … 580 628 # to stderr. 581 629 582 WARN_LOGFILE = 630 WARN_LOGFILE = warning.log 583 631 584 632 #--------------------------------------------------------------------------- … … 591 639 # with spaces. 592 640 593 INPUT = ../source 641 INPUT = ../source \ 642 mainpage.h 594 643 595 644 # This tag can be used to specify the character encoding of the source files … … 605 654 # and *.h) to filter out the source-files in the directories. If left 606 655 # blank the following patterns are tested: 607 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 608 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 656 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 657 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 658 # *.f90 *.f *.for *.vhd *.vhdl 609 659 610 660 FILE_PATTERNS = *.c \ … … 637 687 *.f90 \ 638 688 *.f \ 689 *.for \ 639 690 *.vhd \ 640 691 *.vhdl … … 648 699 # The EXCLUDE tag can be used to specify files and/or directories that should 649 700 # excluded from the INPUT source files. This way you can easily exclude a 650 # subdirectory from a directory tree whose root is specified with the INPUT tag. 701 # subdirectory from a directory tree whose root is specified with the INPUT tag. 702 # Note that relative paths are relative to directory from which doxygen is run. 651 703 652 704 EXCLUDE = 653 705 654 706 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 655 # directories that are symbolic links (a Unix file system feature) are excluded707 # directories that are symbolic links (a Unix file system feature) are excluded 656 708 # from the input. 657 709 … … 664 716 # for example use the pattern */test/* 665 717 666 EXCLUDE_PATTERNS = 718 EXCLUDE_PATTERNS = */.svn 667 719 668 720 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names … … 714 766 # filter if there is a match. The filters are a list of the form: 715 767 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 716 # info on how filters are used. If FILTER_PATTERNS is empty , INPUT_FILTER717 # is applied to all files.768 # info on how filters are used. If FILTER_PATTERNS is empty or if 769 # non of the patterns match the file name, INPUT_FILTER is applied. 718 770 719 771 FILTER_PATTERNS = … … 724 776 725 777 FILTER_SOURCE_FILES = NO 778 779 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 780 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) 781 # and it is also possible to disable source filtering for a specific pattern 782 # using *.ext= (so without naming a filter). This option only has effect when 783 # FILTER_SOURCE_FILES is enabled. 784 785 FILTER_SOURCE_PATTERNS = 726 786 727 787 #--------------------------------------------------------------------------- … … 788 848 # contains a lot of classes, structs, unions or interfaces. 789 849 790 ALPHABETICAL_INDEX = NO850 ALPHABETICAL_INDEX = YES 791 851 792 852 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then … … 826 886 # The HTML_HEADER tag can be used to specify a personal HTML header for 827 887 # each generated HTML page. If it is left blank doxygen will generate a 828 # standard header. 888 # standard header. Note that when using a custom header you are responsible 889 # for the proper inclusion of any scripts and style sheets that doxygen 890 # needs, which is dependent on the configuration options used. 891 # It is adviced to generate a default header using "doxygen -w html 892 # header.html footer.html stylesheet.css YourConfigFile" and then modify 893 # that header. Note that the header is subject to change so you typically 894 # have to redo this when upgrading to a newer version of doxygen or when 895 # changing the value of configuration settings such as GENERATE_TREEVIEW! 829 896 830 897 HTML_HEADER = … … 844 911 845 912 HTML_STYLESHEET = 913 914 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 915 # other source files which should be copied to the HTML output directory. Note 916 # that these files will be copied to the base HTML output directory. Use the 917 # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 918 # files. In the HTML_STYLESHEET file, use the file name only. Also note that 919 # the files will be copied as-is; there are no commands or markers available. 920 921 HTML_EXTRA_FILES = 922 923 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 924 # Doxygen will adjust the colors in the stylesheet and background images 925 # according to this color. Hue is specified as an angle on a colorwheel, 926 # see http://en.wikipedia.org/wiki/Hue for more information. 927 # For instance the value 0 represents red, 60 is yellow, 120 is green, 928 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 929 # The allowed range is 0 to 359. 930 931 HTML_COLORSTYLE_HUE = 220 932 933 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 934 # the colors in the HTML output. For a value of 0 the output will use 935 # grayscales only. A value of 255 will produce the most vivid colors. 936 937 HTML_COLORSTYLE_SAT = 100 938 939 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 940 # the luminance component of the colors in the HTML output. Values below 941 # 100 gradually make the output lighter, whereas values above 100 make 942 # the output darker. The value divided by 100 is the actual gamma applied, 943 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 944 # and 100 does not change the gamma. 945 946 HTML_COLORSTYLE_GAMMA = 80 846 947 847 948 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML … … 873 974 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 874 975 # it at startup. 875 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. 976 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 977 # for more information. 876 978 877 979 GENERATE_DOCSET = NO … … 891 993 DOCSET_BUNDLE_ID = org.doxygen.Project 892 994 995 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify 996 # the documentation publisher. This should be a reverse domain-name style 997 # string, e.g. com.mycompany.MyDocSet.documentation. 998 999 DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1000 1001 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. 1002 1003 DOCSET_PUBLISHER_NAME = Publisher 1004 893 1005 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 894 1006 # will be generated that can be used as input for tools like the … … 935 1047 TOC_EXPAND = NO 936 1048 937 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER938 # are set, an additional index file will be generated that can be used as input for939 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated940 # HTML documentation.1049 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1050 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 1051 # that can be used as input for Qt's qhelpgenerator to generate a 1052 # Qt Compressed Help (.qch) of the generated HTML documentation. 941 1053 942 1054 GENERATE_QHP = NO … … 960 1072 QHP_VIRTUAL_FOLDER = doc 961 1073 962 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.963 # For more information please see1074 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 1075 # add. For more information please see 964 1076 # http://doc.trolltech.com/qthelpproject.html#custom-filters 965 1077 966 1078 QHP_CUST_FILTER_NAME = 967 1079 968 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see 969 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. 1080 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 1081 # custom filter to add. For more information please see 1082 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> 1083 # Qt Help Project / Custom Filters</a>. 970 1084 971 1085 QHP_CUST_FILTER_ATTRS = 972 1086 973 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's 1087 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1088 # project's 974 1089 # filter section matches. 975 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>. 1090 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> 1091 # Qt Help Project / Filter Attributes</a>. 976 1092 977 1093 QHP_SECT_FILTER_ATTRS = … … 985 1101 986 1102 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files 987 # will be generated, which together with the HTML files, form an Eclipse help 1103 # will be generated, which together with the HTML files, form an Eclipse help 988 1104 # plugin. To install this plugin and make it available under the help contents 989 1105 # menu in Eclipse, the contents of the directory containing the HTML and XML 990 1106 # files needs to be copied into the plugins directory of eclipse. The name of 991 1107 # the directory within the plugins directory should be the same as 992 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 1108 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 993 1109 # the help appears. 994 1110 … … 1007 1123 DISABLE_INDEX = NO 1008 1124 1009 # This tag can be used to set the number of enum values (range [1..20]) 1010 # that doxygen will group on one line in the generated HTML documentation. 1125 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 1126 # (range [0,1..20]) that doxygen will group on one line in the generated HTML 1127 # documentation. Note that a value of 0 will completely suppress the enum 1128 # values from appearing in the overview section. 1011 1129 1012 1130 ENUM_VALUES_PER_LINE = 4 … … 1033 1151 TREEVIEW_WIDTH = 250 1034 1152 1153 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 1154 # links to external symbols imported via tag files in a separate window. 1155 1156 EXT_LINKS_IN_WINDOW = NO 1157 1035 1158 # Use this tag to change the font size of Latex formulas included 1036 1159 # as images in the HTML documentation. The default is 10. Note that … … 1041 1164 FORMULA_FONTSIZE = 10 1042 1165 1043 # When the SEARCHENGINE tag is enabled doxygen will generate a search box 1166 # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1167 # generated for formulas are transparent PNGs. Transparent PNGs are 1168 # not supported properly for IE 6.0, but are supported on all modern browsers. 1169 # Note that when changing this option you need to delete any form_*.png files 1170 # in the HTML output before the changes have effect. 1171 1172 FORMULA_TRANSPARENT = YES 1173 1174 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 1175 # (see http://www.mathjax.org) which uses client side Javascript for the 1176 # rendering instead of using prerendered bitmaps. Use this if you do not 1177 # have LaTeX installed or if you want to formulas look prettier in the HTML 1178 # output. When enabled you also need to install MathJax separately and 1179 # configure the path to it using the MATHJAX_RELPATH option. 1180 1181 USE_MATHJAX = NO 1182 1183 # When MathJax is enabled you need to specify the location relative to the 1184 # HTML output directory using the MATHJAX_RELPATH option. The destination 1185 # directory should contain the MathJax.js script. For instance, if the mathjax 1186 # directory is located at the same level as the HTML output directory, then 1187 # MATHJAX_RELPATH should be ../mathjax. The default value points to the 1188 # mathjax.org site, so you can quickly see the result without installing 1189 # MathJax, but it is strongly recommended to install a local copy of MathJax 1190 # before deployment. 1191 1192 MATHJAX_RELPATH = http://www.mathjax.org/mathjax 1193 1194 # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension 1195 # names that should be enabled during MathJax rendering. 1196 1197 MATHJAX_EXTENSIONS = 1198 1199 # When the SEARCHENGINE tag is enabled doxygen will generate a search box 1044 1200 # for the HTML output. The underlying search engine uses javascript 1045 # and DHTML and should work on any modern browser. Note that when using 1046 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 1201 # and DHTML and should work on any modern browser. Note that when using 1202 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 1047 1203 # (GENERATE_DOCSET) there is already a search function so this one should 1048 1204 # typically be disabled. For large projects the javascript based search engine … … 1051 1207 SEARCHENGINE = YES 1052 1208 1053 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1054 # implemented using a PHP enabled web server instead of at the web client 1209 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1210 # implemented using a PHP enabled web server instead of at the web client 1055 1211 # using Javascript. Doxygen will generate the search PHP script and index 1056 # file to put on the web server. The advantage of the server 1057 # based approach is that it scales better to large projects and allows 1058 # full text search. The disadvan ces isthat it is more difficult to setup1212 # file to put on the web server. The advantage of the server 1213 # based approach is that it scales better to large projects and allows 1214 # full text search. The disadvantages are that it is more difficult to setup 1059 1215 # and does not have live searching capabilities. 1060 1216 … … 1097 1253 1098 1254 # The PAPER_TYPE tag can be used to set the paper type that is used 1099 # by the printer. Possible values are: a4, a4wide,letter, legal and1255 # by the printer. Possible values are: a4, letter, legal and 1100 1256 # executive. If left blank a4wide will be used. 1101 1257 1102 PAPER_TYPE = a4 wide1258 PAPER_TYPE = a4 1103 1259 1104 1260 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX … … 1114 1270 LATEX_HEADER = 1115 1271 1272 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for 1273 # the generated latex document. The footer should contain everything after 1274 # the last chapter. If it is left blank doxygen will generate a 1275 # standard footer. Notice: only use this tag if you know what you are doing! 1276 1277 LATEX_FOOTER = 1278 1116 1279 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1117 1280 # is prepared for conversion to pdf (using ps2pdf). The pdf file will … … 1140 1303 LATEX_HIDE_INDICES = NO 1141 1304 1142 # If LATEX_SOURCE_CODE is set to YES then doxygen will include 1143 # source code with syntax highlighting in the LaTeX output. 1144 # Note that which sources are shown also depends on other settings 1305 # If LATEX_SOURCE_CODE is set to YES then doxygen will include 1306 # source code with syntax highlighting in the LaTeX output. 1307 # Note that which sources are shown also depends on other settings 1145 1308 # such as SOURCE_BROWSER. 1146 1309 1147 1310 LATEX_SOURCE_CODE = NO 1311 1312 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1313 # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See 1314 # http://en.wikipedia.org/wiki/BibTeX for more info. 1315 1316 LATEX_BIB_STYLE = plain 1148 1317 1149 1318 #--------------------------------------------------------------------------- … … 1312 1481 # way by setting EXPAND_ONLY_PREDEF to YES. 1313 1482 1314 MACRO_EXPANSION = NO1483 MACRO_EXPANSION = YES 1315 1484 1316 1485 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES … … 1321 1490 1322 1491 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1323 # in the INCLUDE_PATH (see below) will be search ifa #include is found.1492 # pointed to by INCLUDE_PATH will be searched when a #include is found. 1324 1493 1325 1494 SEARCH_INCLUDES = YES … … 1329 1498 # the preprocessor. 1330 1499 1331 INCLUDE_PATH = 1332 1500 INCLUDE_PATH = ../source/Lib/ 1501 1502 # ../source/Lib/TLibCommon \ 1503 # ../source/Lib/TLibEncoder \ 1504 # ../source/Lib/TLibDecoder \ 1505 # ../source/Lib/libmd5 \ 1506 # ../source/Lib/TLibVideoIO 1507 # 1333 1508 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1334 1509 # patterns (like *.h and *.hpp) to filter out the header-files in the … … 1351 1526 # this tag can be used to specify a list of macro names that should be expanded. 1352 1527 # The macro definition that is found in the sources will be used. 1353 # Use the PREDEFINED tag if you want to use a different macro definition. 1528 # Use the PREDEFINED tag if you want to use a different macro definition that 1529 # overrules the definition found in the source code. 1354 1530 1355 1531 EXPAND_AS_DEFINED = 1356 1532 1357 1533 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1358 # doxygen's preprocessor will remove all function-like macros that are alone 1359 # on a line, have an all uppercase name, and do not end with a semicolon. Such 1360 # function macros are typically used for boiler-plate code, and will confuse 1361 # the parser if not removed. 1534 # doxygen's preprocessor will remove all references to function-like macros 1535 # that are alone on a line, have an all uppercase name, and do not end with a 1536 # semicolon, because these will confuse the parser if not removed. 1362 1537 1363 1538 SKIP_FUNCTION_MACROS = YES … … 1413 1588 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1414 1589 # or super classes. Setting the tag to NO turns the diagrams off. Note that 1415 # this option is superseded by the HAVE_DOT option below. This is only a 1416 # fallback. It is recommended to install and use dot, since it yields more 1417 # powerful graphs. 1418 1419 CLASS_DIAGRAMS = YES 1590 # this option also works with HAVE_DOT disabled, but it is recommended to 1591 # install and use dot, since it yields more powerful graphs. 1592 1593 CLASS_DIAGRAMS = NO 1420 1594 1421 1595 # You can define message sequence charts within doxygen comments using the \msc … … 1439 1613 # have no effect if this option is set to NO (the default) 1440 1614 1441 HAVE_DOT = NO 1442 1443 # By default doxygen will write a font called FreeSans.ttf to the output 1444 # directory and reference it in all dot files that doxygen generates. This 1445 # font does not include all possible unicode characters however, so when you need 1446 # these (or just want a differently looking font) you can specify the font name 1447 # using DOT_FONTNAME. You need need to make sure dot is able to find the font, 1448 # which can be done by putting it in a standard location or by setting the 1449 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 1450 # containing the font. 1451 1452 DOT_FONTNAME = FreeSans 1615 HAVE_DOT = YES 1616 1617 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 1618 # allowed to run in parallel. When set to 0 (the default) doxygen will 1619 # base this on the number of processors available in the system. You can set it 1620 # explicitly to a value larger than 0 to get control over the balance 1621 # between CPU load and processing speed. 1622 1623 DOT_NUM_THREADS = 0 1624 1625 # By default doxygen will use the Helvetica font for all dot files that 1626 # doxygen generates. When you want a differently looking font you can specify 1627 # the font name using DOT_FONTNAME. You need to make sure dot is able to find 1628 # the font, which can be done by putting it in a standard location or by setting 1629 # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the 1630 # directory containing the font. 1631 1632 DOT_FONTNAME = Helvetica 1453 1633 1454 1634 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. … … 1457 1637 DOT_FONTSIZE = 10 1458 1638 1459 # By default doxygen will tell dot to use the output directory to look for the 1460 # FreeSans.ttf font (which doxygen will put there itself). If you specify a 1461 # different font using DOT_FONTNAME you can set the path where dot 1462 # can find it using this tag. 1639 # By default doxygen will tell dot to use the Helvetica font. 1640 # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to 1641 # set the path where dot can find it. 1463 1642 1464 1643 DOT_FONTPATH = … … 1525 1704 1526 1705 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1527 # will g raphical hierarchy of all classes instead of a textual one.1706 # will generate a graphical hierarchy of all classes instead of a textual one. 1528 1707 1529 1708 GRAPHICAL_HIERARCHY = YES … … 1537 1716 1538 1717 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1539 # generated by dot. Possible values are png, jpg, or gif 1540 # If left blank png will be used. 1718 # generated by dot. Possible values are svg, png, jpg, or gif. 1719 # If left blank png will be used. If you choose svg you need to set 1720 # HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1721 # visible in IE 9+ (other browsers do not have this requirement). 1541 1722 1542 1723 DOT_IMAGE_FORMAT = png 1724 1725 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 1726 # enable generation of interactive SVG images that allow zooming and panning. 1727 # Note that this requires a modern browser other than Internet Explorer. 1728 # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you 1729 # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1730 # visible. Older versions of IE do not have SVG support. 1731 1732 INTERACTIVE_SVG = NO 1543 1733 1544 1734 # The tag DOT_PATH can be used to specify the path where the dot tool can be … … 1552 1742 1553 1743 DOTFILE_DIRS = 1744 1745 # The MSCFILE_DIRS tag can be used to specify one or more directories that 1746 # contain msc files that are included in the documentation (see the 1747 # \mscfile command). 1748 1749 MSCFILE_DIRS = 1554 1750 1555 1751 # 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.
