Changeset 988 for vendor/current/lib/talloc/doxy.config
- Timestamp:
- Nov 24, 2016, 1:14:11 PM (9 years ago)
- File:
-
- 1 edited
-
vendor/current/lib/talloc/doxy.config (modified) (55 diffs)
Legend:
- Unmodified
- Added
- Removed
-
vendor/current/lib/talloc/doxy.config
r740 r988 1 # Doxyfile 1. 6.11 # Doxyfile 1.8.0 2 2 3 3 # This file describes the settings to be used by the documentation system 4 # doxygen (www.doxygen.org) for a project 4 # doxygen (www.doxygen.org) for a project. 5 5 # 6 # All text after a hash (#) is considered a comment and will be ignored 6 # All text after a hash (#) is considered a comment and will be ignored. 7 7 # The format is: 8 8 # TAG = value [value, ...] 9 9 # For lists items can also be appended using: 10 10 # TAG += value [value, ...] 11 # Values that contain spaces should be placed between quotes (" ") 11 # Values that contain spaces should be placed between quotes (" "). 12 12 13 13 #--------------------------------------------------------------------------- … … 23 23 DOXYFILE_ENCODING = UTF-8 24 24 25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 26 # by quotes) that should identify the project. 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. 27 28 28 29 PROJECT_NAME = talloc … … 33 34 34 35 PROJECT_NUMBER = 2.0 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 … … 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 … … 192 206 ALIASES = 193 207 208 # This tag can be used to specify a number of word-keyword mappings (TCL only). 209 # A mapping has the form "name=value". For example adding 210 # "class=itcl::class" will allow you to use the command class in the 211 # itcl::class meaning. 212 213 TCL_SUBST = 214 194 215 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 195 216 # sources only. Doxygen will then generate output that is more tailored for C. … … 218 239 OPTIMIZE_OUTPUT_VHDL = NO 219 240 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 of 224 # 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 treat 226 # .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 set FILE_PATTERNS otherwise the files are not read by doxygen. 241 # Doxygen selects the parser to use depending on the extension of the files it 242 # parses. With this tag you can assign which parser to use for a given extension. 243 # Doxygen has a built-in mapping, but you can override or extend it using this 244 # tag. The format is ext=language, where ext is a file extension, and language 245 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, 246 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make 247 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C 248 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions 249 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. 228 250 229 251 EXTENSION_MAPPING = 252 253 # If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all 254 # comments according to the Markdown format, which allows for more readable 255 # documentation. See http://daringfireball.net/projects/markdown/ for details. 256 # The output of markdown processing is further processed by doxygen, so you 257 # can mix doxygen, HTML, and XML commands with Markdown formatting. 258 # Disable only in case of backward compatibilities issues. 259 260 MARKDOWN_SUPPORT = YES 230 261 231 262 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want … … 233 264 # set this tag to YES in order to let doxygen match functions declarations and 234 265 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 235 # func(std::string) {}). This also make the inheritance and collaboration266 # func(std::string) {}). This also makes the inheritance and collaboration 236 267 # diagrams that involve STL classes more complete and accurate. 237 268 … … 251 282 # For Microsoft's IDL there are propget and propput attributes to indicate getter 252 283 # and setter methods for a property. Setting this option to YES (the default) 253 # will make doxygen toreplace the get and set methods by a property in the284 # will make doxygen replace the get and set methods by a property in the 254 285 # documentation. This will only work if the methods are indeed getting or 255 286 # setting a simple type. If this is not the case, or you want to show the … … 272 303 273 304 SUBGROUPING = YES 305 306 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and 307 # unions are shown inside the group in which they are included (e.g. using 308 # @ingroup) instead of on a separate page (for HTML and Man pages) or 309 # section (for LaTeX and RTF). 310 311 INLINE_GROUPED_CLASSES = NO 312 313 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and 314 # unions with only public data fields will be shown inline in the documentation 315 # of the scope in which they are defined (i.e. file, namespace, or group 316 # documentation), provided this scope is documented. If set to NO (the default), 317 # structs, classes, and unions are shown on a separate page (for HTML and Man 318 # pages) or section (for LaTeX and RTF). 319 320 INLINE_SIMPLE_STRUCTS = NO 274 321 275 322 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum … … 289 336 # probably good enough. For larger projects a too small cache size can cause 290 337 # doxygen to be busy swapping symbols to and from disk most of the time 291 # causing a significant performance penal ity.338 # causing a significant performance penalty. 292 339 # If the system has enough physical memory increasing the cache will improve the 293 340 # performance by keeping more symbols in memory. Note that the value works on 294 # a logarithmic scale so increasing the size by one will roug ly double the341 # a logarithmic scale so increasing the size by one will roughly double the 295 342 # memory usage. The cache size is given by this formula: 296 343 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 297 # corresponding to a cache size of 2^16 = 65536 symbols 344 # corresponding to a cache size of 2^16 = 65536 symbols. 298 345 299 346 SYMBOL_CACHE_SIZE = 0 347 348 # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be 349 # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given 350 # their name and scope. Since this can be an expensive process and often the 351 # same symbol appear multiple times in the code, doxygen keeps a cache of 352 # pre-resolved symbols. If the cache is too small doxygen will become slower. 353 # If the cache is too large, memory is wasted. The cache size is given by this 354 # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, 355 # corresponding to a cache size of 2^16 = 65536 symbols. 356 357 LOOKUP_CACHE_SIZE = 0 300 358 301 359 #--------------------------------------------------------------------------- … … 315 373 EXTRACT_PRIVATE = NO 316 374 375 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation. 376 377 EXTRACT_PACKAGE = NO 378 317 379 # If the EXTRACT_STATIC tag is set to YES all static members of a file 318 380 # will be included in the documentation. … … 337 399 # 'anonymous_namespace{file}', where file will be replaced with the base 338 400 # name of the file that contains the anonymous namespace. By default 339 # anonymous namespace are hidden.401 # anonymous namespaces are hidden. 340 402 341 403 EXTRACT_ANON_NSPACES = NO … … 397 459 SHOW_INCLUDE_FILES = YES 398 460 461 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 462 # will list include files with double quotes in the documentation 463 # rather than with sharp brackets. 464 465 FORCE_LOCAL_INCLUDES = NO 466 399 467 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 400 468 # is inserted in the documentation for inline members. … … 416 484 SORT_BRIEF_DOCS = NO 417 485 418 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 486 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 487 # will sort the (brief and detailed) documentation of class members so that 488 # constructors and destructors are listed first. If set to NO (the default) 489 # the constructors will appear in the respective orders defined by 490 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 491 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 492 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 419 493 420 494 SORT_MEMBERS_CTORS_1ST = NO … … 436 510 SORT_BY_SCOPE_NAME = NO 437 511 512 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to 513 # do proper type resolution of all parameters of a function it will reject a 514 # match between the prototype and the implementation of a member function even 515 # if there is only one candidate or it is obvious which candidate to choose 516 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen 517 # will still accept a match between prototype and implementation in such cases. 518 519 STRICT_PROTO_MATCHING = NO 520 438 521 # The GENERATE_TODOLIST tag can be used to enable (YES) or 439 522 # disable (NO) the todo list. This list is created by putting \todo … … 466 549 467 550 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 468 # the initial value of a variable or defineconsists of for it to appear in551 # the initial value of a variable or macro consists of for it to appear in 469 552 # the documentation. If the initializer consists of more lines than specified 470 553 # here it will be hidden. Use a value of 0 to hide initializers completely. 471 # The appearance of the initializer of individual variables and defines in the554 # The appearance of the initializer of individual variables and macros in the 472 555 # documentation can be controlled using \showinitializer or \hideinitializer 473 556 # command in the documentation regardless of this setting. … … 480 563 481 564 SHOW_USED_FILES = YES 482 483 # If the sources in your project are distributed over multiple directories484 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy485 # in the documentation. The default is NO.486 487 SHOW_DIRECTORIES = NO488 565 489 566 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. … … 510 587 FILE_VERSION_FILTER = 511 588 512 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by513 # doxygen. The layout file controls the global structure of the generated output files514 # in an output format independent way. The create the layout file that represents515 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a516 # file name after the option, if omitted DoxygenLayout.xml will be used as the name517 # of the layout file.589 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 590 # by doxygen. The layout file controls the global structure of the generated 591 # output files in an output format independent way. The create the layout file 592 # that represents doxygen's defaults, run doxygen with the -l option. 593 # You can optionally specify a file name after the option, if omitted 594 # DoxygenLayout.xml will be used as the name of the layout file. 518 595 519 596 LAYOUT_FILE = 597 598 # The CITE_BIB_FILES tag can be used to specify one or more bib files 599 # containing the references data. This must be a list of .bib files. The 600 # .bib extension is automatically appended if omitted. Using this command 601 # requires the bibtex tool to be installed. See also 602 # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style 603 # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this 604 # feature you need bibtex and perl available in the search path. 605 606 CITE_BIB_FILES = 520 607 521 608 #--------------------------------------------------------------------------- … … 547 634 WARN_IF_DOC_ERROR = YES 548 635 549 # Th is WARN_NO_PARAMDOC option can beabled to get warnings for636 # The WARN_NO_PARAMDOC option can be enabled to get warnings for 550 637 # functions that are documented, but have no documentation for their parameters 551 638 # or return value. If set to NO (the default) doxygen will only warn about … … 579 666 # with spaces. 580 667 581 INPUT = . doc 668 INPUT = . \ 669 doc 582 670 583 671 # This tag can be used to specify the character encoding of the source files … … 593 681 # and *.h) to filter out the source-files in the directories. If left 594 682 # blank the following patterns are tested: 595 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 596 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 683 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 684 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 685 # *.f90 *.f *.for *.vhd *.vhdl 597 686 598 687 FILE_PATTERNS = *.cpp \ … … 610 699 RECURSIVE = NO 611 700 612 # The EXCLUDE tag can be used to specify files and/or directories that should 701 # The EXCLUDE tag can be used to specify files and/or directories that should be 613 702 # excluded from the INPUT source files. This way you can easily exclude a 614 703 # subdirectory from a directory tree whose root is specified with the INPUT tag. 704 # Note that relative paths are relative to the directory from which doxygen is 705 # run. 615 706 616 707 EXCLUDE = 617 708 618 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or619 # directories that are symbolic links (a Unix file system feature) are excluded709 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 710 # directories that are symbolic links (a Unix file system feature) are excluded 620 711 # from the input. 621 712 … … 628 719 # for example use the pattern */test/* 629 720 630 EXCLUDE_PATTERNS = */.git/* \ 631 */.svn/* \ 632 */cmake/* \ 633 */build/* 721 EXCLUDE_PATTERNS = */.git/* 634 722 635 723 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names … … 665 753 # the \image command). 666 754 667 IMAGE_PATH = 755 IMAGE_PATH = doc 668 756 669 757 # The INPUT_FILTER tag can be used to specify a program that doxygen should … … 684 772 # The filters are a list of the form: 685 773 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 686 # info on how filters are used. If FILTER_PATTERNS is empty , INPUT_FILTER687 # is applied to all files.774 # info on how filters are used. If FILTER_PATTERNS is empty or if 775 # non of the patterns match the file name, INPUT_FILTER is applied. 688 776 689 777 FILTER_PATTERNS = … … 694 782 695 783 FILTER_SOURCE_FILES = NO 784 785 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 786 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) 787 # and it is also possible to disable source filtering for a specific pattern 788 # using *.ext= (so without naming a filter). This option only has effect when 789 # FILTER_SOURCE_FILES is enabled. 790 791 FILTER_SOURCE_PATTERNS = 696 792 697 793 #--------------------------------------------------------------------------- … … 783 879 GENERATE_HTML = YES 784 880 785 # If the HTML_FOOTER_DESCRIPTION tag is set to YES, Doxygen will786 # add generated date, project name and doxygen version to HTML footer.787 788 HTML_FOOTER_DESCRIPTION= NO789 790 881 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 791 882 # If a relative path is entered the value of OUTPUT_DIRECTORY will be … … 802 893 # The HTML_HEADER tag can be used to specify a personal HTML header for 803 894 # each generated HTML page. If it is left blank doxygen will generate a 804 # standard header. 895 # standard header. Note that when using a custom header you are responsible 896 # for the proper inclusion of any scripts and style sheets that doxygen 897 # needs, which is dependent on the configuration options used. 898 # It is advised to generate a default header using "doxygen -w html 899 # header.html footer.html stylesheet.css YourConfigFile" and then modify 900 # that header. Note that the header is subject to change so you typically 901 # have to redo this when upgrading to a newer version of doxygen or when 902 # changing the value of configuration settings such as GENERATE_TREEVIEW! 805 903 806 904 HTML_HEADER = … … 817 915 # will generate a default style sheet. Note that doxygen will try to copy 818 916 # the style sheet file to the HTML output directory, so don't put your own 819 # style sheet in the HTML output directory as well, or it will be erased!917 # style sheet in the HTML output directory as well, or it will be erased! 820 918 821 919 HTML_STYLESHEET = 920 921 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 922 # other source files which should be copied to the HTML output directory. Note 923 # that these files will be copied to the base HTML output directory. Use the 924 # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 925 # files. In the HTML_STYLESHEET file, use the file name only. Also note that 926 # the files will be copied as-is; there are no commands or markers available. 927 928 HTML_EXTRA_FILES = 929 930 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 931 # Doxygen will adjust the colors in the style sheet and background images 932 # according to this color. Hue is specified as an angle on a colorwheel, 933 # see http://en.wikipedia.org/wiki/Hue for more information. 934 # For instance the value 0 represents red, 60 is yellow, 120 is green, 935 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 936 # The allowed range is 0 to 359. 937 938 HTML_COLORSTYLE_HUE = 220 939 940 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 941 # the colors in the HTML output. For a value of 0 the output will use 942 # grayscales only. A value of 255 will produce the most vivid colors. 943 944 HTML_COLORSTYLE_SAT = 100 945 946 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 947 # the luminance component of the colors in the HTML output. Values below 948 # 100 gradually make the output lighter, whereas values above 100 make 949 # the output darker. The value divided by 100 is the actual gamma applied, 950 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 951 # and 100 does not change the gamma. 952 953 HTML_COLORSTYLE_GAMMA = 80 954 955 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 956 # page will contain the date and time when the page was generated. Setting 957 # this to NO can help when comparing the output of multiple runs. 958 959 HTML_TIMESTAMP = NO 822 960 823 961 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, … … 843 981 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 844 982 # it at startup. 845 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. 983 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 984 # for more information. 846 985 847 986 GENERATE_DOCSET = NO … … 861 1000 DOCSET_BUNDLE_ID = org.doxygen.Project 862 1001 1002 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify 1003 # the documentation publisher. This should be a reverse domain-name style 1004 # string, e.g. com.mycompany.MyDocSet.documentation. 1005 1006 DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1007 1008 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. 1009 1010 DOCSET_PUBLISHER_NAME = Publisher 1011 863 1012 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 864 1013 # will be generated that can be used as input for tools like the … … 905 1054 TOC_EXPAND = NO 906 1055 907 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER908 # are set, an additional index file will be generated that can be used as input for909 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated910 # HTML documentation.1056 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1057 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 1058 # that can be used as input for Qt's qhelpgenerator to generate a 1059 # Qt Compressed Help (.qch) of the generated HTML documentation. 911 1060 912 1061 GENERATE_QHP = NO … … 930 1079 QHP_VIRTUAL_FOLDER = doc 931 1080 932 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.933 # For more information please see1081 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 1082 # add. For more information please see 934 1083 # http://doc.trolltech.com/qthelpproject.html#custom-filters 935 1084 936 1085 QHP_CUST_FILTER_NAME = 937 1086 938 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see 939 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. 1087 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 1088 # custom filter to add. For more information please see 1089 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> 1090 # Qt Help Project / Custom Filters</a>. 940 1091 941 1092 QHP_CUST_FILTER_ATTRS = 942 1093 943 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's 1094 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1095 # project's 944 1096 # filter section matches. 945 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>. 1097 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> 1098 # Qt Help Project / Filter Attributes</a>. 946 1099 947 1100 QHP_SECT_FILTER_ATTRS = … … 954 1107 QHG_LOCATION = 955 1108 956 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 957 # top of each HTML page. The value NO (the default) enables the index and 958 # the value YES disables it. 1109 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files 1110 # will be generated, which together with the HTML files, form an Eclipse help 1111 # plugin. To install this plugin and make it available under the help contents 1112 # menu in Eclipse, the contents of the directory containing the HTML and XML 1113 # files needs to be copied into the plugins directory of eclipse. The name of 1114 # the directory within the plugins directory should be the same as 1115 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 1116 # the help appears. 1117 1118 GENERATE_ECLIPSEHELP = NO 1119 1120 # A unique identifier for the eclipse help plugin. When installing the plugin 1121 # the directory name containing the HTML and XML files should also have 1122 # this name. 1123 1124 ECLIPSE_DOC_ID = org.doxygen.Project 1125 1126 # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) 1127 # at top of each HTML page. The value NO (the default) enables the index and 1128 # the value YES disables it. Since the tabs have the same information as the 1129 # navigation tree you can set this option to NO if you already set 1130 # GENERATE_TREEVIEW to YES. 959 1131 960 1132 DISABLE_INDEX = NO 961 962 # This tag can be used to set the number of enum values (range [1..20])963 # that doxygen will group on one line in the generated HTML documentation.964 965 ENUM_VALUES_PER_LINE = 4966 1133 967 1134 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index … … 972 1139 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 973 1140 # Windows users are probably better off using the HTML help feature. 1141 # Since the tree basically has the same information as the tab index you 1142 # could consider to set DISABLE_INDEX to NO when enabling this option. 974 1143 975 1144 GENERATE_TREEVIEW = NONE 976 1145 977 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, 978 # and Class Hierarchy pages using a tree view instead of an ordered list. 979 980 USE_INLINE_TREES = NO 1146 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 1147 # (range [0,1..20]) that doxygen will group on one line in the generated HTML 1148 # documentation. Note that a value of 0 will completely suppress the enum 1149 # values from appearing in the overview section. 1150 1151 ENUM_VALUES_PER_LINE = 4 981 1152 982 1153 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be … … 985 1156 986 1157 TREEVIEW_WIDTH = 250 1158 1159 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 1160 # links to external symbols imported via tag files in a separate window. 1161 1162 EXT_LINKS_IN_WINDOW = NO 987 1163 988 1164 # Use this tag to change the font size of Latex formulas included … … 994 1170 FORMULA_FONTSIZE = 10 995 1171 996 # When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript 997 # and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP) 998 # there is already a search function so this one should typically 999 # be disabled. 1172 # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1173 # generated for formulas are transparent PNGs. Transparent PNGs are 1174 # not supported properly for IE 6.0, but are supported on all modern browsers. 1175 # Note that when changing this option you need to delete any form_*.png files 1176 # in the HTML output before the changes have effect. 1177 1178 FORMULA_TRANSPARENT = YES 1179 1180 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 1181 # (see http://www.mathjax.org) which uses client side Javascript for the 1182 # rendering instead of using prerendered bitmaps. Use this if you do not 1183 # have LaTeX installed or if you want to formulas look prettier in the HTML 1184 # output. When enabled you may also need to install MathJax separately and 1185 # configure the path to it using the MATHJAX_RELPATH option. 1186 1187 USE_MATHJAX = NO 1188 1189 # When MathJax is enabled you need to specify the location relative to the 1190 # HTML output directory using the MATHJAX_RELPATH option. The destination 1191 # directory should contain the MathJax.js script. For instance, if the mathjax 1192 # directory is located at the same level as the HTML output directory, then 1193 # MATHJAX_RELPATH should be ../mathjax. The default value points to 1194 # the MathJax Content Delivery Network so you can quickly see the result without 1195 # installing MathJax. 1196 # However, it is strongly recommended to install a local 1197 # copy of MathJax from http://www.mathjax.org before deployment. 1198 1199 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1200 1201 # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension 1202 # names that should be enabled during MathJax rendering. 1203 1204 MATHJAX_EXTENSIONS = 1205 1206 # When the SEARCHENGINE tag is enabled doxygen will generate a search box 1207 # for the HTML output. The underlying search engine uses javascript 1208 # and DHTML and should work on any modern browser. Note that when using 1209 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 1210 # (GENERATE_DOCSET) there is already a search function so this one should 1211 # typically be disabled. For large projects the javascript based search engine 1212 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 1000 1213 1001 1214 SEARCHENGINE = NO 1215 1216 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1217 # implemented using a PHP enabled web server instead of at the web client 1218 # using Javascript. Doxygen will generate the search PHP script and index 1219 # file to put on the web server. The advantage of the server 1220 # based approach is that it scales better to large projects and allows 1221 # full text search. The disadvantages are that it is more difficult to setup 1222 # and does not have live searching capabilities. 1223 1224 SERVER_BASED_SEARCH = NO 1002 1225 1003 1226 #--------------------------------------------------------------------------- … … 1018 1241 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1019 1242 # invoked. If left blank `latex' will be used as the default command name. 1243 # Note that when enabling USE_PDFLATEX this option is only used for 1244 # generating bitmaps for formulas in the HTML output, but not in the 1245 # Makefile that is written to the output directory. 1020 1246 1021 1247 LATEX_CMD_NAME = latex … … 1034 1260 1035 1261 # The PAPER_TYPE tag can be used to set the paper type that is used 1036 # by the printer. Possible values are: a4, a4wide,letter, legal and1262 # by the printer. Possible values are: a4, letter, legal and 1037 1263 # executive. If left blank a4wide will be used. 1038 1264 … … 1051 1277 LATEX_HEADER = 1052 1278 1279 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for 1280 # the generated latex document. The footer should contain everything after 1281 # the last chapter. If it is left blank doxygen will generate a 1282 # standard footer. Notice: only use this tag if you know what you are doing! 1283 1284 LATEX_FOOTER = 1285 1053 1286 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1054 1287 # is prepared for conversion to pdf (using ps2pdf). The pdf file will … … 1077 1310 LATEX_HIDE_INDICES = NO 1078 1311 1079 # If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER. 1312 # If LATEX_SOURCE_CODE is set to YES then doxygen will include 1313 # source code with syntax highlighting in the LaTeX output. 1314 # Note that which sources are shown also depends on other settings 1315 # such as SOURCE_BROWSER. 1080 1316 1081 1317 LATEX_SOURCE_CODE = NO 1318 1319 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1320 # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See 1321 # http://en.wikipedia.org/wiki/BibTeX for more info. 1322 1323 LATEX_BIB_STYLE = plain 1082 1324 1083 1325 #--------------------------------------------------------------------------- … … 1112 1354 RTF_HYPERLINKS = NO 1113 1355 1114 # Load style sheet definitions from file. Syntax is similar to doxygen's1356 # Load style sheet definitions from file. Syntax is similar to doxygen's 1115 1357 # config file, i.e. a series of assignments. You only have to provide 1116 1358 # replacements, missing definitions are set to their default value. … … 1257 1499 1258 1500 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1259 # in the INCLUDE_PATH (see below) will be search ifa #include is found.1501 # pointed to by INCLUDE_PATH will be searched when a #include is found. 1260 1502 1261 1503 SEARCH_INCLUDES = YES … … 1282 1524 # instead of the = operator. 1283 1525 1284 PREDEFINED = DOXYGEN PRINTF_ATTRIBUTE(x,y)= 1526 PREDEFINED = DOXYGEN \ 1527 PRINTF_ATTRIBUTE(x,y)= 1285 1528 1286 1529 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1287 1530 # this tag can be used to specify a list of macro names that should be expanded. 1288 1531 # The macro definition that is found in the sources will be used. 1289 # Use the PREDEFINED tag if you want to use a different macro definition. 1532 # Use the PREDEFINED tag if you want to use a different macro definition that 1533 # overrules the definition found in the source code. 1290 1534 1291 1535 EXPAND_AS_DEFINED = 1292 1536 1293 1537 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1294 # doxygen's preprocessor will remove all function-like macros that are alone 1295 # on a line, have an all uppercase name, and do not end with a semicolon. Such 1296 # function macros are typically used for boiler-plate code, and will confuse 1297 # the parser if not removed. 1538 # doxygen's preprocessor will remove all references to function-like macros 1539 # that are alone on a line, have an all uppercase name, and do not end with a 1540 # semicolon, because these will confuse the parser if not removed. 1298 1541 1299 1542 SKIP_FUNCTION_MACROS = YES … … 1303 1546 #--------------------------------------------------------------------------- 1304 1547 1305 # The TAGFILES option can be used to specify one or more tagfiles. 1306 # Optionally an initial location of the external documentation 1307 # can be added for each tagfile. The format of a tag file without 1308 # this location is as follows: 1548 # The TAGFILES option can be used to specify one or more tagfiles. For each 1549 # tag file the location of the external documentation should be added. The 1550 # format of a tag file without this location is as follows: 1309 1551 # 1310 1552 # TAGFILES = file1 file2 ... … … 1312 1554 # 1313 1555 # TAGFILES = file1=loc1 "file2 = loc2" ... 1314 # where "loc1" and "loc2" can be relative or absolute paths or 1315 # URLs. If a location is present for each tag, the installdox tool 1316 # does not have to be run to correct the links. 1317 # Note that each tag file must have a unique name 1318 # (where the name does NOT include the path) 1319 # If a tag file is not located in the directory in which doxygen 1320 # is run, you must also specify the path to the tagfile here. 1556 # where "loc1" and "loc2" can be relative or absolute paths 1557 # or URLs. Note that each tag file must have a unique name (where the name does 1558 # NOT include the path). If a tag file is not located in the directory in which 1559 # doxygen is run, you must also specify the path to the tagfile here. 1321 1560 1322 1561 TAGFILES = … … 1351 1590 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1352 1591 # or super classes. Setting the tag to NO turns the diagrams off. Note that 1353 # this option is superseded by the HAVE_DOT option below. This is only a 1354 # fallback. It is recommended to install and use dot, since it yields more 1355 # powerful graphs. 1592 # this option also works with HAVE_DOT disabled, but it is recommended to 1593 # install and use dot, since it yields more powerful graphs. 1356 1594 1357 1595 CLASS_DIAGRAMS = YES … … 1379 1617 HAVE_DOT = NO 1380 1618 1381 # By default doxygen will write a font called FreeSans.ttf to the output 1382 # directory and reference it in all dot files that doxygen generates. This 1383 # font does not include all possible unicode characters however, so when you need 1384 # these (or just want a differently looking font) you can specify the font name 1385 # using DOT_FONTNAME. You need need to make sure dot is able to find the font, 1386 # which can be done by putting it in a standard location or by setting the 1387 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 1388 # containing the font. 1619 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 1620 # allowed to run in parallel. When set to 0 (the default) doxygen will 1621 # base this on the number of processors available in the system. You can set it 1622 # explicitly to a value larger than 0 to get control over the balance 1623 # between CPU load and processing speed. 1624 1625 DOT_NUM_THREADS = 0 1626 1627 # By default doxygen will use the Helvetica font for all dot files that 1628 # doxygen generates. When you want a differently looking font you can specify 1629 # the font name using DOT_FONTNAME. You need to make sure dot is able to find 1630 # the font, which can be done by putting it in a standard location or by setting 1631 # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the 1632 # directory containing the font. 1389 1633 1390 1634 DOT_FONTNAME = FreeSans … … 1395 1639 DOT_FONTSIZE = 10 1396 1640 1397 # By default doxygen will tell dot to use the output directory to look for the 1398 # FreeSans.ttf font (which doxygen will put there itself). If you specify a 1399 # different font using DOT_FONTNAME you can set the path where dot 1400 # can find it using this tag. 1641 # By default doxygen will tell dot to use the Helvetica font. 1642 # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to 1643 # set the path where dot can find it. 1401 1644 1402 1645 DOT_FONTPATH = … … 1405 1648 # will generate a graph for each documented class showing the direct and 1406 1649 # indirect inheritance relations. Setting this tag to YES will force the 1407 # theCLASS_DIAGRAMS tag to NO.1650 # CLASS_DIAGRAMS tag to NO. 1408 1651 1409 1652 CLASS_GRAPH = YES … … 1426 1669 1427 1670 UML_LOOK = NO 1671 1672 # If the UML_LOOK tag is enabled, the fields and methods are shown inside 1673 # the class node. If there are many fields or methods and many nodes the 1674 # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS 1675 # threshold limits the number of items for each type to make the size more 1676 # managable. Set this to 0 for no limit. Note that the threshold may be 1677 # exceeded by 50% before the limit is enforced. 1678 1679 UML_LIMIT_NUM_FIELDS = 10 1428 1680 1429 1681 # If set to YES, the inheritance and collaboration graphs will show the … … 1463 1715 1464 1716 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1465 # will g raphical hierarchy of all classes instead of a textual one.1717 # will generate a graphical hierarchy of all classes instead of a textual one. 1466 1718 1467 1719 GRAPHICAL_HIERARCHY = YES 1468 1720 1469 # If the DIRECTORY_GRAPH , SHOW_DIRECTORIESand HAVE_DOT tags are set to YES1721 # If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES 1470 1722 # then doxygen will show the dependencies a directory has on other directories 1471 1723 # in a graphical way. The dependency relations are determined by the #include … … 1475 1727 1476 1728 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1477 # generated by dot. Possible values are png, jpg, or gif 1478 # If left blank png will be used. 1729 # generated by dot. Possible values are svg, png, jpg, or gif. 1730 # If left blank png will be used. If you choose svg you need to set 1731 # HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1732 # visible in IE 9+ (other browsers do not have this requirement). 1479 1733 1480 1734 DOT_IMAGE_FORMAT = png 1735 1736 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 1737 # enable generation of interactive SVG images that allow zooming and panning. 1738 # Note that this requires a modern browser other than Internet Explorer. 1739 # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you 1740 # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1741 # visible. Older versions of IE do not have SVG support. 1742 1743 INTERACTIVE_SVG = NO 1481 1744 1482 1745 # The tag DOT_PATH can be used to specify the path where the dot tool can be … … 1490 1753 1491 1754 DOTFILE_DIRS = 1755 1756 # The MSCFILE_DIRS tag can be used to specify one or more directories that 1757 # contain msc files that are included in the documentation (see the 1758 # \mscfile command). 1759 1760 MSCFILE_DIRS = 1492 1761 1493 1762 # 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.
