Changeset 24918
- Timestamp:
- Jul 24, 2009, 7:20:29 AM (17 years ago)
- File:
-
- 1 edited
-
trunk/Doxyfile (modified) (37 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/Doxyfile
r21360 r24918 1 # Doxyfile 1.5. 41 # Doxyfile 1.5.8 2 2 3 3 # This file describes the settings to be used by the documentation system … … 15 15 #--------------------------------------------------------------------------- 16 16 17 # This tag specifies the encoding used for all characters in the config file that18 # follow. The default is UTF-8 which is also the encoding used for all text before19 # t he first occurrence of this tag. Doxygen uses libiconv (or the iconv built into20 # libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of21 # possible encodings.17 # This tag specifies the encoding used for all characters in the config file 18 # that follow. The default is UTF-8 which is also the encoding used for all 19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the 20 # iconv built into libc) for the transcoding. See 21 # http://www.gnu.org/software/libiconv for the list of possible encodings. 22 22 23 23 DOXYFILE_ENCODING = UTF-8 … … 55 55 # The default language is English, other supported languages are: 56 56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 57 # Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, 58 # Italian, Japanese, Japanese-en (Japanese with English messages), Korean, 59 # Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, 60 # Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. 57 # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, 58 # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), 59 # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, 60 # Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene, 61 # Spanish, Swedish, and Ukrainian. 61 62 62 63 OUTPUT_LANGUAGE = English … … 155 156 MULTILINE_CPP_IS_BRIEF = NO 156 157 157 # If the DETAILS_AT_TOP tag is set to YES then Doxygen158 # will output the detailed description near the top, like JavaDoc.159 # If set to NO, the detailed description appears after the member160 # documentation.161 162 DETAILS_AT_TOP = YES163 164 158 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 165 159 # member inherits the documentation from any documented member that it … … 196 190 197 191 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 198 # sources only. Doxygen will then generate output that is more tailored for Java.199 # For instance, namespaces will be presented as packages, qualified scopes200 # will look different, etc.192 # sources only. Doxygen will then generate output that is more tailored for 193 # Java. For instance, namespaces will be presented as packages, qualified 194 # scopes will look different, etc. 201 195 202 196 OPTIMIZE_OUTPUT_JAVA = NO 203 197 204 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to 205 # include (a tag file for) the STL sources as input, then you should 198 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 199 # sources only. Doxygen will then generate output that is more tailored for 200 # Fortran. 201 202 OPTIMIZE_FOR_FORTRAN = NO 203 204 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 205 # sources. Doxygen will then generate output that is tailored for 206 # VHDL. 207 208 OPTIMIZE_OUTPUT_VHDL = NO 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 221 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 222 # to include (a tag file for) the STL sources as input, then you should 206 223 # set this tag to YES in order to let doxygen match functions declarations and 207 224 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. … … 211 228 BUILTIN_STL_SUPPORT = NO 212 229 213 # If you use Microsoft's C++/CLI language, you should set this option to YES to 230 # If you use Microsoft's C++/CLI language, you should set this option to YES to 214 231 # enable parsing support. 215 232 … … 221 238 222 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 223 249 224 250 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC … … 237 263 SUBGROUPING = NO 238 264 239 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct (or union) is240 # documented as structwith the name of the typedef. So265 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 266 # is documented as struct, union, or enum with the name of the typedef. So 241 267 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 242 268 # with name TypeT. When disabled the typedef will appear as a member of a file, 243 269 # namespace, or class. And the struct will be named TypeS. This can typically 244 # be useful for C code where the coding convention is that all structs are245 # type def'ed and only the typedef is referenced never the struct'sname.270 # be useful for C code in case the coding convention dictates that all compound 271 # types are typedef'ed and only the typedef is referenced, never the tag name. 246 272 247 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 248 290 249 291 #--------------------------------------------------------------------------- … … 281 323 EXTRACT_LOCAL_METHODS = NO 282 324 283 # If this flag is set to YES, the members of anonymous namespaces will be extracted 284 # and appear in the documentation as a namespace called 'anonymous_namespace{file}', 285 # where file will be replaced with the base name of the file that contains the anonymous 286 # namespace. By default anonymous namespace are hidden. 325 # If this flag is set to YES, the members of anonymous namespaces will be 326 # extracted and appear in the documentation as a namespace called 327 # 'anonymous_namespace{file}', where file will be replaced with the base 328 # name of the file that contains the anonymous namespace. By default 329 # anonymous namespace are hidden. 287 330 288 331 EXTRACT_ANON_NSPACES = NO … … 363 406 SORT_BRIEF_DOCS = NO 364 407 408 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 409 # hierarchy of group names into alphabetical order. If set to NO (the default) 410 # the group names will appear in their defined order. 411 412 SORT_GROUP_NAMES = NO 413 365 414 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 366 415 # sorted by fully-qualified names, including namespaces. If set to 367 416 # NO (the default), the class list will be sorted only by class name, 368 417 # not including the namespace part. 369 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 418 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 370 419 # Note: This option applies only to the class list, not to the 371 420 # alphabetical list. … … 424 473 SHOW_DIRECTORIES = YES 425 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 426 488 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 427 # doxygen should invoke to get the current version for each file (typically from the428 # version control system). Doxygen will invoke the program by executing (via489 # doxygen should invoke to get the current version for each file (typically from 490 # the version control system). Doxygen will invoke the program by executing (via 429 491 # popen()) the command <command> <input-file>, where <command> is the value of 430 492 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file … … 433 495 434 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 = 435 506 436 507 #--------------------------------------------------------------------------- … … 494 565 # with spaces. 495 566 496 INPUT = mainpage.dox \ 497 ippdb/src \ 498 Nebulous/nebclient/src \ 499 ppArith/src \ 500 ppConfigDump/src \ 501 ppImage/src \ 502 ppMerge/src \ 503 ppStack/src \ 504 ppSub/src \ 505 psLib/src \ 506 psastro/src \ 507 psphot/src \ 508 pswarp/src \ 509 psModules/src 510 511 # This tag can be used to specify the character encoding of the source files that 512 # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default 513 # input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. 514 # See http://www.gnu.org/software/libiconv for the list of possible encodings. 567 INPUT = mainpage.dox \ 568 ippdb/src \ 569 Nebulous/nebclient/src \ 570 ppArith/src \ 571 ppConfigDump/src \ 572 ppImage/src \ 573 ppMerge/src \ 574 ppStack/src \ 575 ppSub/src \ 576 psLib/src \ 577 psastro/src \ 578 psphot/src \ 579 pswarp/src \ 580 psModules/src 581 582 # This tag can be used to specify the character encoding of the source files 583 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 584 # also the default input encoding. Doxygen uses libiconv (or the iconv built 585 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 586 # the list of possible encodings. 515 587 516 588 INPUT_ENCODING = UTF-8 … … 523 595 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 524 596 525 FILE_PATTERNS = *.c \526 *.h\527 *.in597 FILE_PATTERNS = *.c \ 598 *.h \ 599 *.in 528 600 529 601 # The RECURSIVE tag can be used to turn specify whether or not subdirectories … … 554 626 555 627 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 556 # (namespaces, classes, functions, etc.) that should be excluded from the output. 557 # The symbol name can be a fully qualified name, a word, or if the wildcard * is used, 558 # a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test 628 # (namespaces, classes, functions, etc.) that should be excluded from the 629 # output. The symbol name can be a fully qualified name, a word, or if the 630 # wildcard * is used, a substring. Examples: ANamespace, AClass, 631 # AClass::ANamespace, ANamespace::*Test 559 632 560 633 EXCLUDE_SYMBOLS = … … 591 664 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 592 665 # input file. Doxygen will then use the output that the filter program writes 593 # to standard output. If FILTER_PATTERNS is specified, this tag will be 666 # to standard output. 667 # If FILTER_PATTERNS is specified, this tag will be 594 668 # ignored. 595 669 … … 597 671 598 672 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 599 # basis. Doxygen will compare the file name with each pattern and apply the 600 # filter if there is a match. The filters are a list of the form: 673 # basis. 674 # Doxygen will compare the file name with each pattern and apply the 675 # filter if there is a match. 676 # The filters are a list of the form: 601 677 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 602 678 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER … … 618 694 # be generated. Documented entities will be cross-referenced with these sources. 619 695 # Note: To get rid of all source code in the generated output, make sure also 620 # VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH 621 # then you must also enable this option. If you don't then doxygen will produce 622 # a warning and turn it on anyway 696 # VERBATIM_HEADERS is set to NO. 623 697 624 698 SOURCE_BROWSER = YES … … 635 709 STRIP_CODE_COMMENTS = NO 636 710 637 # If the REFERENCED_BY_RELATION tag is set to YES (the default)711 # If the REFERENCED_BY_RELATION tag is set to YES 638 712 # then for each documented function all documented 639 713 # functions referencing it will be listed. … … 641 715 REFERENCED_BY_RELATION = YES 642 716 643 # If the REFERENCES_RELATION tag is set to YES (the default)717 # If the REFERENCES_RELATION tag is set to YES 644 718 # then for each documented function all documented entities 645 719 # called/used by that function will be listed. … … 647 721 REFERENCES_RELATION = YES 648 722 649 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 650 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 651 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 652 # link to the source code. Otherwise they will link to the documentstion. 723 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 724 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 725 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 726 # link to the source code. 727 # Otherwise they will link to the documentation. 653 728 654 729 REFERENCES_LINK_SOURCE = YES … … 739 814 HTML_ALIGN_MEMBERS = YES 740 815 741 # If the GENERATE_HTMLHELP tag is set to YES, additional index files742 # will be generated that can be used as input for tools like the743 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)744 # of the generated HTML documentation.745 746 GENERATE_HTMLHELP = NO747 748 816 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 749 817 # documentation will contain sections that can be hidden and shown after the … … 754 822 HTML_DYNAMIC_SECTIONS = NO 755 823 824 # If the GENERATE_DOCSET tag is set to YES, additional index files 825 # will be generated that can be used as input for Apple's Xcode 3 826 # integrated development environment, introduced with OSX 10.5 (Leopard). 827 # To create a documentation set, doxygen will generate a Makefile in the 828 # HTML output directory. Running make will produce the docset in that 829 # directory and running "make install" will install the docset in 830 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 831 # it at startup. 832 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. 833 834 GENERATE_DOCSET = NO 835 836 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 837 # feed. A documentation feed provides an umbrella under which multiple 838 # documentation sets from a single provider (such as a company or product suite) 839 # can be grouped. 840 841 DOCSET_FEEDNAME = "Doxygen generated docs" 842 843 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 844 # should uniquely identify the documentation set bundle. This should be a 845 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 846 # will append .docset to the name. 847 848 DOCSET_BUNDLE_ID = org.doxygen.Project 849 850 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 851 # will be generated that can be used as input for tools like the 852 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 853 # of the generated HTML documentation. 854 855 GENERATE_HTMLHELP = NO 856 756 857 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 757 858 # be used to specify the file name of the resulting .chm file. You … … 774 875 GENERATE_CHI = NO 775 876 877 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 878 # is used to encode HtmlHelp index (hhk), content (hhc) and project file 879 # content. 880 881 CHM_INDEX_ENCODING = 882 776 883 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 777 884 # controls whether a binary table of contents is generated (YES) or a … … 785 892 TOC_EXPAND = YES 786 893 894 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER 895 # are set, an additional index file will be generated that can be used as input for 896 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated 897 # HTML documentation. 898 899 GENERATE_QHP = NO 900 901 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can 902 # be used to specify the file name of the resulting .qch file. 903 # The path specified is relative to the HTML output folder. 904 905 QCH_FILE = 906 907 # The QHP_NAMESPACE tag specifies the namespace to use when generating 908 # Qt Help Project output. For more information please see 909 # http://doc.trolltech.com/qthelpproject.html#namespace 910 911 QHP_NAMESPACE = 912 913 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 914 # Qt Help Project output. For more information please see 915 # http://doc.trolltech.com/qthelpproject.html#virtual-folders 916 917 QHP_VIRTUAL_FOLDER = doc 918 919 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. 920 # For more information please see 921 # http://doc.trolltech.com/qthelpproject.html#custom-filters 922 923 QHP_CUST_FILTER_NAME = 924 925 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see 926 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. 927 928 QHP_CUST_FILTER_ATTRS = 929 930 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's 931 # filter section matches. 932 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>. 933 934 QHP_SECT_FILTER_ATTRS = 935 936 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 937 # be used to specify the location of Qt's qhelpgenerator. 938 # If non-empty doxygen will try to run qhelpgenerator on the generated 939 # .qhp file. 940 941 QHG_LOCATION = 942 787 943 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 788 944 # top of each HTML page. The value NO (the default) enables the index and … … 796 952 ENUM_VALUES_PER_LINE = 10 797 953 798 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be 799 # generated containing a tree-like index structure (just like the one that 954 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 955 # structure should be generated to display hierarchical information. 956 # If the tag value is set to FRAME, a side panel will be generated 957 # containing a tree-like index structure (just like the one that 800 958 # is generated for HTML Help). For this to work a browser that supports 801 959 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 802 960 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 803 # probably better off using the HTML help feature. 961 # probably better off using the HTML help feature. Other possible values 962 # for this tag are: HIERARCHIES, which will generate the Groups, Directories, 963 # and Class Hierarchy pages using a tree view instead of an ordered list; 964 # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which 965 # disables this behavior completely. For backwards compatibility with previous 966 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE 967 # respectively. 804 968 805 969 GENERATE_TREEVIEW = NO … … 810 974 811 975 TREEVIEW_WIDTH = 250 976 977 # Use this tag to change the font size of Latex formulas included 978 # as images in the HTML documentation. The default is 10. Note that 979 # when you change the font size after a successful doxygen run you need 980 # to manually remove any form_*.png images from the HTML output directory 981 # to force them to be regenerated. 982 983 FORMULA_FONTSIZE = 10 812 984 813 985 #--------------------------------------------------------------------------- … … 1023 1195 1024 1196 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1025 # nicely formatted so it can be parsed by a human reader. This is useful 1026 # if you want to understand what is going on. On the other hand, if this 1197 # nicely formatted so it can be parsed by a human reader. 1198 # This is useful 1199 # if you want to understand what is going on. 1200 # On the other hand, if this 1027 1201 # tag is set to NO the size of the Perl module output will be much smaller 1028 1202 # and Perl will parse it just the same. … … 1111 1285 # can be added for each tagfile. The format of a tag file without 1112 1286 # this location is as follows: 1113 # TAGFILES = file1 file2 ... 1287 # 1288 # TAGFILES = file1 file2 ... 1114 1289 # Adding location for the tag files is done as follows: 1115 # TAGFILES = file1=loc1 "file2 = loc2" ... 1290 # 1291 # TAGFILES = file1=loc1 "file2 = loc2" ... 1116 1292 # where "loc1" and "loc2" can be relative or absolute paths or 1117 1293 # URLs. If a location is present for each tag, the installdox tool 1118 # does not have to be run to correct the links. 1119 # Note that each tag file must have a unique name 1120 # (where the name does NOT include the path) 1294 # does not have to be run to correct the links. 1295 # Note that each tag file must have a unique name 1296 # (where the name does NOT include the path) 1121 1297 # If a tag file is not located in the directory in which doxygen 1122 1298 # is run, you must also specify the path to the tagfile here. … … 1160 1336 1161 1337 # You can define message sequence charts within doxygen comments using the \msc 1162 # command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to 1163 # produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to 1164 # specify the directory where the mscgen tool resides. If left empty the tool is assumed to 1165 # be found in the default search path. 1338 # command. Doxygen will then run the mscgen tool (see 1339 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 1340 # documentation. The MSCGEN_PATH tag allows you to specify the directory where 1341 # the mscgen tool resides. If left empty the tool is assumed to be found in the 1342 # default search path. 1166 1343 1167 1344 MSCGEN_PATH = … … 1180 1357 HAVE_DOT = YES 1181 1358 1359 # By default doxygen will write a font called FreeSans.ttf to the output 1360 # directory and reference it in all dot files that doxygen generates. This 1361 # font does not include all possible unicode characters however, so when you need 1362 # these (or just want a differently looking font) you can specify the font name 1363 # using DOT_FONTNAME. You need need to make sure dot is able to find the font, 1364 # which can be done by putting it in a standard location or by setting the 1365 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 1366 # containing the font. 1367 1368 DOT_FONTNAME = FreeSans 1369 1370 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 1371 # The default size is 10pt. 1372 1373 DOT_FONTSIZE = 10 1374 1375 # By default doxygen will tell dot to use the output directory to look for the 1376 # FreeSans.ttf font (which doxygen will put there itself). If you specify a 1377 # different font using DOT_FONTNAME you can set the path where dot 1378 # can find it using this tag. 1379 1380 DOT_FONTPATH = 1381 1182 1382 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1183 1383 # will generate a graph for each documented class showing the direct and … … 1224 1424 INCLUDED_BY_GRAPH = YES 1225 1425 1226 # If the CALL_GRAPH , SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will1227 # generate a call dependency graph for every global function or class method.1228 # Note that enabling this option will significantly increase the time of a run.1229 # So in most cases it will be better to enable call graphs for selected1230 # f unctions only using the \callgraph command.1426 # If the CALL_GRAPH and HAVE_DOT options are set to YES then 1427 # doxygen will generate a call dependency graph for every global function 1428 # or class method. Note that enabling this option will significantly increase 1429 # the time of a run. So in most cases it will be better to enable call graphs 1430 # for selected functions only using the \callgraph command. 1231 1431 1232 1432 CALL_GRAPH = NO 1233 1433 1234 # If the CALLER_GRAPH , SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will1235 # generate a caller dependency graph for every global function or class method.1236 # Note that enabling this option will significantly increase the time of a run.1237 # So in most cases it will be better to enable caller graphs for selected1238 # functions only using the \callergraph command.1434 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 1435 # doxygen will generate a caller dependency graph for every global function 1436 # or class method. Note that enabling this option will significantly increase 1437 # the time of a run. So in most cases it will be better to enable caller 1438 # graphs for selected functions only using the \callergraph command. 1239 1439 1240 1440 CALLER_GRAPH = NO … … 1247 1447 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1248 1448 # then doxygen will show the dependencies a directory has on other directories 1249 # in a graphical way. The dependency relations are determined by the #include 1449 # in a graphical way. The dependency relations are determined by the #include 1250 1450 # relations between the files in the directories. 1251 1451 … … 1253 1453 1254 1454 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1255 # generated by dot. Possible values are png, jpg, or gif 1455 # generated by dot. Possible values are png, jpg, or gif 1256 1456 # If left blank png will be used. 1257 1457 … … 1269 1469 DOTFILE_DIRS = 1270 1470 1271 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of1471 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1272 1472 # nodes that will be shown in the graph. If the number of nodes in a graph 1273 1473 # becomes larger than this value, doxygen will truncate the graph, which is 1274 # visualized by representing a node as a red box. Note that doxygen if the number1275 # of direct children of the root node in a graph is already larger than1276 # MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note1474 # visualized by representing a node as a red box. Note that doxygen if the 1475 # number of direct children of the root node in a graph is already larger than 1476 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 1277 1477 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 1278 1478 … … 1290 1490 1291 1491 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1292 # background. This is disabled by default, which results in a white background.1293 # Warning: Depending on the platform used, enabling this option may lead to1294 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to1295 # read).1492 # background. This is disabled by default, because dot on Windows does not 1493 # seem to support this out of the box. Warning: Depending on the platform used, 1494 # enabling this option may lead to badly anti-aliased labels on the edges of 1495 # a graph (i.e. they become hard to read). 1296 1496 1297 1497 DOT_TRANSPARENT = YES … … 1317 1517 1318 1518 #--------------------------------------------------------------------------- 1319 # Configuration::additions related to the search engine1519 # Options related to the search engine 1320 1520 #--------------------------------------------------------------------------- 1321 1521
Note:
See TracChangeset
for help on using the changeset viewer.
