Chromium Code Reviews| OLD | NEW |
|---|---|
| 1 # Copyright (c) 2011 The Chromium Authors. All rights reserved. | 1 # Copyright (c) 2011 The Chromium Authors. All rights reserved. |
| 2 # Use of this source code is governed by a BSD-style license that can be | 2 # Use of this source code is governed by a BSD-style license that can be |
| 3 # found in the LICENSE file. | 3 # found in the LICENSE file. |
| 4 | 4 |
| 5 # Doxyfile 1.7.2 | 5 # Doxyfile 1.7.4 |
| 6 | 6 |
| 7 # This file describes the settings to be used by the documentation system | 7 # This file describes the settings to be used by the documentation system |
| 8 # doxygen (www.doxygen.org) for a project | 8 # doxygen (www.doxygen.org) for a project |
| 9 # | 9 # |
| 10 # All text after a hash (#) is considered a comment and will be ignored | 10 # All text after a hash (#) is considered a comment and will be ignored |
| 11 # The format is: | 11 # The format is: |
| 12 # TAG = value [value, ...] | 12 # TAG = value [value, ...] |
| 13 # For lists items can also be appended using: | 13 # For lists items can also be appended using: |
| 14 # TAG += value [value, ...] | 14 # TAG += value [value, ...] |
| 15 # Values that contain spaces should be placed between quotes (" ") | 15 # Values that contain spaces should be placed between quotes (" ") |
| (...skipping 14 matching lines...) Expand all Loading... | |
| 30 # by quotes) that should identify the project. | 30 # by quotes) that should identify the project. |
| 31 | 31 |
| 32 PROJECT_NAME = | 32 PROJECT_NAME = |
| 33 | 33 |
| 34 # The PROJECT_NUMBER tag can be used to enter a project or revision number. | 34 # The PROJECT_NUMBER tag can be used to enter a project or revision number. |
| 35 # This could be handy for archiving the generated documentation or | 35 # This could be handy for archiving the generated documentation or |
| 36 # if some version control system is used. | 36 # if some version control system is used. |
| 37 | 37 |
| 38 PROJECT_NUMBER = | 38 PROJECT_NUMBER = |
| 39 | 39 |
| 40 # Using the PROJECT_BRIEF tag one can provide an optional one line description | |
| 41 # for a project that appears at the top of each page and should give viewer | |
| 42 # a quick idea about the purpose of the project. Keep the description short. | |
| 43 | |
| 44 PROJECT_BRIEF = | |
| 45 | |
| 46 # With the PROJECT_LOGO tag one can specify an logo or icon that is | |
| 47 # included in the documentation. The maximum height of the logo should not | |
| 48 # exceed 55 pixels and the maximum width should not exceed 200 pixels. | |
| 49 # Doxygen will copy the logo to the output directory. | |
| 50 | |
| 51 PROJECT_LOGO = | |
| 52 | |
| 40 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) | 53 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) |
| 41 # base path where the generated documentation will be put. | 54 # base path where the generated documentation will be put. |
| 42 # If a relative path is entered, it will be relative to the location | 55 # If a relative path is entered, it will be relative to the location |
| 43 # where doxygen was started. If left blank the current directory will be used. | 56 # where doxygen was started. If left blank the current directory will be used. |
| 44 | 57 |
| 45 OUTPUT_DIRECTORY = PepperCRefDocs | 58 OUTPUT_DIRECTORY = PepperCRefDocs |
| 46 | 59 |
| 47 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create | 60 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create |
| 48 # 4096 sub-directories (in 2 levels) under the output directory of each output | 61 # 4096 sub-directories (in 2 levels) under the output directory of each output |
| 49 # format and will distribute the generated files over these directories. | 62 # format and will distribute the generated files over these directories. |
| 50 # Enabling this option can be useful when feeding doxygen a huge amount of | 63 # Enabling this option can be useful when feeding doxygen a huge amount of |
| 51 # source files, where putting all generated files in the same directory would | 64 # source files, where putting all generated files in the same directory would |
| 52 # otherwise cause performance problems for the file system. | 65 # otherwise cause performance problems for the file system. |
| 53 | 66 |
| 54 CREATE_SUBDIRS = NO | 67 CREATE_SUBDIRS = NO |
| 55 | 68 |
| 56 # The OUTPUT_LANGUAGE tag is used to specify the language in which all | 69 # The OUTPUT_LANGUAGE tag is used to specify the language in which all |
| 57 # documentation generated by doxygen is written. Doxygen will use this | 70 # documentation generated by doxygen is written. Doxygen will use this |
| 58 # information to generate all constant output in the proper language. | 71 # information to generate all constant output in the proper language. |
| 59 # The default language is English, other supported languages are: | 72 # The default language is English, other supported languages are: |
| 60 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, | 73 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, |
| 61 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, | 74 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, |
| 62 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English | 75 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English |
| 63 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, | 76 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, |
| 64 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, | 77 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, |
| 65 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. | 78 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. |
| 66 | 79 |
| 67 OUTPUT_LANGUAGE = English | 80 OUTPUT_LANGUAGE = English |
| 68 | 81 |
| 69 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will | 82 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will |
| 70 # include brief member descriptions after the members that are listed in | 83 # include brief member descriptions after the members that are listed in |
| 71 # the file and class documentation (similar to JavaDoc). | 84 # the file and class documentation (similar to JavaDoc). |
| 72 # Set to NO to disable this. | 85 # Set to NO to disable this. |
| 73 | 86 |
| 74 BRIEF_MEMBER_DESC = NO | 87 BRIEF_MEMBER_DESC = NO |
| (...skipping 195 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 270 DISTRIBUTE_GROUP_DOC = NO | 283 DISTRIBUTE_GROUP_DOC = NO |
| 271 | 284 |
| 272 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of | 285 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of |
| 273 # the same type (for instance a group of public functions) to be put as a | 286 # the same type (for instance a group of public functions) to be put as a |
| 274 # subgroup of that type (e.g. under the Public Functions section). Set it to | 287 # subgroup of that type (e.g. under the Public Functions section). Set it to |
| 275 # NO to prevent subgrouping. Alternatively, this can be done per class using | 288 # NO to prevent subgrouping. Alternatively, this can be done per class using |
| 276 # the \nosubgrouping command. | 289 # the \nosubgrouping command. |
| 277 | 290 |
| 278 SUBGROUPING = YES | 291 SUBGROUPING = YES |
| 279 | 292 |
| 293 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and | |
| 294 # unions are shown inside the group in which they are included (e.g. using | |
| 295 # @ingroup) instead of on a separate page (for HTML and Man pages) or | |
| 296 # section (for LaTeX and RTF). | |
| 297 | |
| 298 INLINE_GROUPED_CLASSES = NO | |
| 299 | |
| 280 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum | 300 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum |
| 281 # is documented as struct, union, or enum with the name of the typedef. So | 301 # is documented as struct, union, or enum with the name of the typedef. So |
| 282 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct | 302 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct |
| 283 # with name TypeT. When disabled the typedef will appear as a member of a file, | 303 # with name TypeT. When disabled the typedef will appear as a member of a file, |
| 284 # namespace, or class. And the struct will be named TypeS. This can typically | 304 # namespace, or class. And the struct will be named TypeS. This can typically |
| 285 # be useful for C code in case the coding convention dictates that all compound | 305 # be useful for C code in case the coding convention dictates that all compound |
| 286 # types are typedef'ed and only the typedef is referenced, never the tag name. | 306 # types are typedef'ed and only the typedef is referenced, never the tag name. |
| 287 | 307 |
| 288 TYPEDEF_HIDES_STRUCT = NO | 308 TYPEDEF_HIDES_STRUCT = NO |
| 289 | 309 |
| 290 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to | 310 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to |
| 291 # determine which symbols to keep in memory and which to flush to disk. | 311 # determine which symbols to keep in memory and which to flush to disk. |
| 292 # When the cache is full, less often used symbols will be written to disk. | 312 # When the cache is full, less often used symbols will be written to disk. |
| 293 # For small to medium size projects (<1000 input files) the default value is | 313 # For small to medium size projects (<1000 input files) the default value is |
| 294 # probably good enough. For larger projects a too small cache size can cause | 314 # probably good enough. For larger projects a too small cache size can cause |
| 295 # doxygen to be busy swapping symbols to and from disk most of the time | 315 # doxygen to be busy swapping symbols to and from disk most of the time |
| 296 # causing a significant performance penality. | 316 # causing a significant performance penalty. |
| 297 # If the system has enough physical memory increasing the cache will improve the | 317 # If the system has enough physical memory increasing the cache will improve the |
| 298 # performance by keeping more symbols in memory. Note that the value works on | 318 # performance by keeping more symbols in memory. Note that the value works on |
| 299 # a logarithmic scale so increasing the size by one will roughly double the | 319 # a logarithmic scale so increasing the size by one will roughly double the |
| 300 # memory usage. The cache size is given by this formula: | 320 # memory usage. The cache size is given by this formula: |
| 301 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, | 321 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, |
| 302 # corresponding to a cache size of 2^16 = 65536 symbols | 322 # corresponding to a cache size of 2^16 = 65536 symbols |
| 303 | 323 |
| 304 SYMBOL_CACHE_SIZE = 0 | 324 SYMBOL_CACHE_SIZE = 0 |
| 305 | 325 |
| 306 #--------------------------------------------------------------------------- | 326 #--------------------------------------------------------------------------- |
| (...skipping 138 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 445 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be | 465 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be |
| 446 # sorted by fully-qualified names, including namespaces. If set to | 466 # sorted by fully-qualified names, including namespaces. If set to |
| 447 # NO (the default), the class list will be sorted only by class name, | 467 # NO (the default), the class list will be sorted only by class name, |
| 448 # not including the namespace part. | 468 # not including the namespace part. |
| 449 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. | 469 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. |
| 450 # Note: This option applies only to the class list, not to the | 470 # Note: This option applies only to the class list, not to the |
| 451 # alphabetical list. | 471 # alphabetical list. |
| 452 | 472 |
| 453 SORT_BY_SCOPE_NAME = NO | 473 SORT_BY_SCOPE_NAME = NO |
| 454 | 474 |
| 475 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to | |
| 476 # do proper type resolution of all parameters of a function it will reject a | |
| 477 # match between the prototype and the implementation of a member function even | |
| 478 # if there is only one candidate or it is obvious which candidate to choose | |
| 479 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen | |
| 480 # will still accept a match between prototype and implementation in such cases. | |
| 481 | |
| 482 STRICT_PROTO_MATCHING = NO | |
| 483 | |
| 455 # The GENERATE_TODOLIST tag can be used to enable (YES) or | 484 # The GENERATE_TODOLIST tag can be used to enable (YES) or |
| 456 # disable (NO) the todo list. This list is created by putting \todo | 485 # disable (NO) the todo list. This list is created by putting \todo |
| 457 # commands in the documentation. | 486 # commands in the documentation. |
| 458 | 487 |
| 459 GENERATE_TODOLIST = YES | 488 GENERATE_TODOLIST = YES |
| 460 | 489 |
| 461 # The GENERATE_TESTLIST tag can be used to enable (YES) or | 490 # The GENERATE_TESTLIST tag can be used to enable (YES) or |
| 462 # disable (NO) the test list. This list is created by putting \test | 491 # disable (NO) the test list. This list is created by putting \test |
| 463 # commands in the documentation. | 492 # commands in the documentation. |
| 464 | 493 |
| (...skipping 139 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 604 # the list of possible encodings. | 633 # the list of possible encodings. |
| 605 | 634 |
| 606 INPUT_ENCODING = UTF-8 | 635 INPUT_ENCODING = UTF-8 |
| 607 | 636 |
| 608 # If the value of the INPUT tag contains directories, you can use the | 637 # If the value of the INPUT tag contains directories, you can use the |
| 609 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp | 638 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
| 610 # and *.h) to filter out the source-files in the directories. If left | 639 # and *.h) to filter out the source-files in the directories. If left |
| 611 # blank the following patterns are tested: | 640 # blank the following patterns are tested: |
| 612 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh | 641 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh |
| 613 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py | 642 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py |
| 614 # *.f90 *.f *.vhd *.vhdl | 643 # *.f90 *.f *.for *.vhd *.vhdl |
| 615 | 644 |
| 616 FILE_PATTERNS = *.h \ | 645 FILE_PATTERNS = *.h \ |
| 617 *.dox | 646 *.dox |
| 618 | 647 |
| 619 # The RECURSIVE tag can be used to turn specify whether or not subdirectories | 648 # The RECURSIVE tag can be used to turn specify whether or not subdirectories |
| 620 # should be searched for input files as well. Possible values are YES and NO. | 649 # should be searched for input files as well. Possible values are YES and NO. |
| 621 # If left blank NO is used. | 650 # If left blank NO is used. |
| 622 | 651 |
| 623 RECURSIVE = NO | 652 RECURSIVE = NO |
| 624 | 653 |
| 625 # The EXCLUDE tag can be used to specify files and/or directories that should | 654 # The EXCLUDE tag can be used to specify files and/or directories that should |
| 626 # excluded from the INPUT source files. This way you can easily exclude a | 655 # excluded from the INPUT source files. This way you can easily exclude a |
| 627 # subdirectory from a directory tree whose root is specified with the INPUT tag. | 656 # subdirectory from a directory tree whose root is specified with the INPUT tag. |
| 628 | 657 |
| 629 EXCLUDE = ./pp_macros.h | 658 EXCLUDE = ./pp_macros.h |
| 630 | 659 |
| 631 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or | 660 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or |
| 632 # directories that are symbolic links (a Unix filesystem feature) are excluded | 661 # directories that are symbolic links (a Unix file system feature) are excluded |
| 633 # from the input. | 662 # from the input. |
| 634 | 663 |
| 635 EXCLUDE_SYMLINKS = NO | 664 EXCLUDE_SYMLINKS = NO |
| 636 | 665 |
| 637 # If the value of the INPUT tag contains directories, you can use the | 666 # If the value of the INPUT tag contains directories, you can use the |
| 638 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude | 667 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude |
| 639 # certain files from those directories. Note that the wildcards are matched | 668 # certain files from those directories. Note that the wildcards are matched |
| 640 # against the file with absolute path, so to exclude all test directories | 669 # against the file with absolute path, so to exclude all test directories |
| 641 # for example use the pattern */test/* | 670 # for example use the pattern */test/* |
| 642 | 671 |
| (...skipping 40 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 683 # input file. Doxygen will then use the output that the filter program writes | 712 # input file. Doxygen will then use the output that the filter program writes |
| 684 # to standard output. If FILTER_PATTERNS is specified, this tag will be | 713 # to standard output. If FILTER_PATTERNS is specified, this tag will be |
| 685 # ignored. | 714 # ignored. |
| 686 | 715 |
| 687 INPUT_FILTER = | 716 INPUT_FILTER = |
| 688 | 717 |
| 689 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern | 718 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern |
| 690 # basis. Doxygen will compare the file name with each pattern and apply the | 719 # basis. Doxygen will compare the file name with each pattern and apply the |
| 691 # filter if there is a match. The filters are a list of the form: | 720 # filter if there is a match. The filters are a list of the form: |
| 692 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further | 721 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further |
| 693 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER | 722 # info on how filters are used. If FILTER_PATTERNS is empty or if |
| 694 # is applied to all files. | 723 # non of the patterns match the file name, INPUT_FILTER is applied. |
| 695 | 724 |
| 696 FILTER_PATTERNS = | 725 FILTER_PATTERNS = |
| 697 | 726 |
| 698 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using | 727 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
| 699 # INPUT_FILTER) will be used to filter the input files when producing source | 728 # INPUT_FILTER) will be used to filter the input files when producing source |
| 700 # files to browse (i.e. when SOURCE_BROWSER is set to YES). | 729 # files to browse (i.e. when SOURCE_BROWSER is set to YES). |
| 701 | 730 |
| 702 FILTER_SOURCE_FILES = NO | 731 FILTER_SOURCE_FILES = NO |
| 703 | 732 |
| 733 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file | |
| 734 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) | |
| 735 # and it is also possible to disable source filtering for a specific pattern | |
| 736 # using *.ext= (so without naming a filter). This option only has effect when | |
| 737 # FILTER_SOURCE_FILES is enabled. | |
| 738 | |
| 739 FILTER_SOURCE_PATTERNS = | |
| 740 | |
| 704 #--------------------------------------------------------------------------- | 741 #--------------------------------------------------------------------------- |
| 705 # configuration options related to source browsing | 742 # configuration options related to source browsing |
| 706 #--------------------------------------------------------------------------- | 743 #--------------------------------------------------------------------------- |
| 707 | 744 |
| 708 # If the SOURCE_BROWSER tag is set to YES then a list of source files will | 745 # If the SOURCE_BROWSER tag is set to YES then a list of source files will |
| 709 # be generated. Documented entities will be cross-referenced with these sources. | 746 # be generated. Documented entities will be cross-referenced with these sources. |
| 710 # Note: To get rid of all source code in the generated output, make sure also | 747 # Note: To get rid of all source code in the generated output, make sure also |
| 711 # VERBATIM_HEADERS is set to NO. | 748 # VERBATIM_HEADERS is set to NO. |
| 712 | 749 |
| 713 SOURCE_BROWSER = NO | 750 SOURCE_BROWSER = NO |
| (...skipping 81 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 795 HTML_OUTPUT = html | 832 HTML_OUTPUT = html |
| 796 | 833 |
| 797 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for | 834 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for |
| 798 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank | 835 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank |
| 799 # doxygen will generate files with .html extension. | 836 # doxygen will generate files with .html extension. |
| 800 | 837 |
| 801 HTML_FILE_EXTENSION = .html | 838 HTML_FILE_EXTENSION = .html |
| 802 | 839 |
| 803 # The HTML_HEADER tag can be used to specify a personal HTML header for | 840 # The HTML_HEADER tag can be used to specify a personal HTML header for |
| 804 # each generated HTML page. If it is left blank doxygen will generate a | 841 # each generated HTML page. If it is left blank doxygen will generate a |
| 805 # standard header. | 842 # standard header. Note that when using a custom header you are responsible |
| 843 # for the proper inclusion of any scripts and style sheets that doxygen | |
| 844 # needs, which is dependent on the configuration options used. | |
| 845 # It is adviced to generate a default header using "doxygen -w html | |
| 846 # header.html footer.html stylesheet.css YourConfigFile" and then modify | |
| 847 # that header. Note that the header is subject to change so you typically | |
| 848 # have to redo this when upgrading to a newer version of doxygen or when | |
| 849 # changing the value of configuration settings such as GENERATE_TREEVIEW! | |
| 806 | 850 |
| 807 HTML_HEADER = documentation/header.html | 851 HTML_HEADER = documentation/header.html |
| 808 | 852 |
| 809 # The HTML_FOOTER tag can be used to specify a personal HTML footer for | 853 # The HTML_FOOTER tag can be used to specify a personal HTML footer for |
| 810 # each generated HTML page. If it is left blank doxygen will generate a | 854 # each generated HTML page. If it is left blank doxygen will generate a |
| 811 # standard footer. | 855 # standard footer. |
| 812 | 856 |
| 813 HTML_FOOTER = documentation/footer.html | 857 HTML_FOOTER = documentation/footer.html |
| 814 | 858 |
| 815 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading | 859 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading |
| 816 # style sheet that is used by each HTML page. It can be used to | 860 # style sheet that is used by each HTML page. It can be used to |
| 817 # fine-tune the look of the HTML output. If the tag is left blank doxygen | 861 # fine-tune the look of the HTML output. If the tag is left blank doxygen |
| 818 # will generate a default style sheet. Note that doxygen will try to copy | 862 # will generate a default style sheet. Note that doxygen will try to copy |
| 819 # the style sheet file to the HTML output directory, so don't put your own | 863 # the style sheet file to the HTML output directory, so don't put your own |
| 820 # stylesheet in the HTML output directory as well, or it will be erased! | 864 # stylesheet in the HTML output directory as well, or it will be erased! |
| 821 | 865 |
| 822 HTML_STYLESHEET = documentation/stylesheet.css | 866 HTML_STYLESHEET = documentation/stylesheet.css |
| 823 | 867 |
| 868 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or | |
| 869 # other source files which should be copied to the HTML output directory. Note | |
| 870 # that these files will be copied to the base HTML output directory. Use the | |
| 871 # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these | |
| 872 # files. In the HTML_STYLESHEET file, use the file name only. Also note that | |
| 873 # the files will be copied as-is; there are no commands or markers available. | |
| 874 | |
| 875 HTML_EXTRA_FILES = | |
| 876 | |
| 824 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. | 877 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. |
| 825 # Doxygen will adjust the colors in the stylesheet and background images | 878 # Doxygen will adjust the colors in the stylesheet and background images |
| 826 # according to this color. Hue is specified as an angle on a colorwheel, | 879 # according to this color. Hue is specified as an angle on a colorwheel, |
| 827 # see http://en.wikipedia.org/wiki/Hue for more information. | 880 # see http://en.wikipedia.org/wiki/Hue for more information. |
| 828 # For instance the value 0 represents red, 60 is yellow, 120 is green, | 881 # For instance the value 0 represents red, 60 is yellow, 120 is green, |
| 829 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. | 882 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. |
| 830 # The allowed range is 0 to 359. | 883 # The allowed range is 0 to 359. |
| 831 | 884 |
| 832 HTML_COLORSTYLE_HUE = 217 | 885 HTML_COLORSTYLE_HUE = 217 |
| 833 | 886 |
| (...skipping 182 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 1016 # this name. | 1069 # this name. |
| 1017 | 1070 |
| 1018 ECLIPSE_DOC_ID = org.doxygen.Project | 1071 ECLIPSE_DOC_ID = org.doxygen.Project |
| 1019 | 1072 |
| 1020 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at | 1073 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at |
| 1021 # top of each HTML page. The value NO (the default) enables the index and | 1074 # top of each HTML page. The value NO (the default) enables the index and |
| 1022 # the value YES disables it. | 1075 # the value YES disables it. |
| 1023 | 1076 |
| 1024 DISABLE_INDEX = NO | 1077 DISABLE_INDEX = NO |
| 1025 | 1078 |
| 1026 # This tag can be used to set the number of enum values (range [0,1..20]) | 1079 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values |
| 1027 # that doxygen will group on one line in the generated HTML documentation. | 1080 # (range [0,1..20]) that doxygen will group on one line in the generated HTML |
| 1028 # Note that a value of 0 will completely suppress the enum values from | 1081 # documentation. Note that a value of 0 will completely suppress the enum |
| 1029 # appearing in the overview section. | 1082 # values from appearing in the overview section. |
| 1030 | 1083 |
| 1031 ENUM_VALUES_PER_LINE = 0 | 1084 ENUM_VALUES_PER_LINE = 0 |
| 1032 | 1085 |
| 1033 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index | 1086 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index |
| 1034 # structure should be generated to display hierarchical information. | 1087 # structure should be generated to display hierarchical information. |
| 1035 # If the tag value is set to YES, a side panel will be generated | 1088 # If the tag value is set to YES, a side panel will be generated |
| 1036 # containing a tree-like index structure (just like the one that | 1089 # containing a tree-like index structure (just like the one that |
| 1037 # is generated for HTML Help). For this to work a browser that supports | 1090 # is generated for HTML Help). For this to work a browser that supports |
| 1038 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). | 1091 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). |
| 1039 # Windows users are probably better off using the HTML help feature. | 1092 # Windows users are probably better off using the HTML help feature. |
| (...skipping 118 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 1158 | 1211 |
| 1159 EXTRA_PACKAGES = | 1212 EXTRA_PACKAGES = |
| 1160 | 1213 |
| 1161 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for | 1214 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for |
| 1162 # the generated latex document. The header should contain everything until | 1215 # the generated latex document. The header should contain everything until |
| 1163 # the first chapter. If it is left blank doxygen will generate a | 1216 # the first chapter. If it is left blank doxygen will generate a |
| 1164 # standard header. Notice: only use this tag if you know what you are doing! | 1217 # standard header. Notice: only use this tag if you know what you are doing! |
| 1165 | 1218 |
| 1166 LATEX_HEADER = | 1219 LATEX_HEADER = |
| 1167 | 1220 |
| 1221 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for | |
| 1222 # the generated latex document. The footer should contain everything after | |
| 1223 # the last chapter. If it is left blank doxygen will generate a | |
| 1224 # standard footer. Notice: only use this tag if you know what you are doing! | |
| 1225 | |
| 1226 LATEX_FOOTER = | |
| 1227 | |
| 1168 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated | 1228 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated |
| 1169 # is prepared for conversion to pdf (using ps2pdf). The pdf file will | 1229 # is prepared for conversion to pdf (using ps2pdf). The pdf file will |
| 1170 # contain links (just like the HTML output) instead of page references | 1230 # contain links (just like the HTML output) instead of page references |
| 1171 # This makes the output suitable for online browsing using a pdf viewer. | 1231 # This makes the output suitable for online browsing using a pdf viewer. |
| 1172 | 1232 |
| 1173 PDF_HYPERLINKS = YES | 1233 PDF_HYPERLINKS = YES |
| 1174 | 1234 |
| 1175 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of | 1235 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of |
| 1176 # plain latex in the generated Makefile. Set this option to YES to get a | 1236 # plain latex in the generated Makefile. Set this option to YES to get a |
| 1177 # higher quality PDF documentation. | 1237 # higher quality PDF documentation. |
| (...skipping 187 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 1365 | 1425 |
| 1366 MACRO_EXPANSION = YES | 1426 MACRO_EXPANSION = YES |
| 1367 | 1427 |
| 1368 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES | 1428 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES |
| 1369 # then the macro expansion is limited to the macros specified with the | 1429 # then the macro expansion is limited to the macros specified with the |
| 1370 # PREDEFINED and EXPAND_AS_DEFINED tags. | 1430 # PREDEFINED and EXPAND_AS_DEFINED tags. |
| 1371 | 1431 |
| 1372 EXPAND_ONLY_PREDEF = YES | 1432 EXPAND_ONLY_PREDEF = YES |
| 1373 | 1433 |
| 1374 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files | 1434 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files |
| 1375 # in the INCLUDE_PATH (see below) will be search if a #include is found. | 1435 # pointed to by INCLUDE_PATH will be searched when a #include is found. |
| 1376 | 1436 |
| 1377 SEARCH_INCLUDES = YES | 1437 SEARCH_INCLUDES = YES |
| 1378 | 1438 |
| 1379 # The INCLUDE_PATH tag can be used to specify one or more directories that | 1439 # The INCLUDE_PATH tag can be used to specify one or more directories that |
| 1380 # contain include files that are not input files but should be processed by | 1440 # contain include files that are not input files but should be processed by |
| 1381 # the preprocessor. | 1441 # the preprocessor. |
| 1382 | 1442 |
| 1383 INCLUDE_PATH = | 1443 INCLUDE_PATH = |
| 1384 | 1444 |
| 1385 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard | 1445 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard |
| (...skipping 17 matching lines...) Expand all Loading... | |
| 1403 EXTERN_C_BEGIN= \ | 1463 EXTERN_C_BEGIN= \ |
| 1404 EXTERN_C_END= \ | 1464 EXTERN_C_END= \ |
| 1405 PP_COMPILE_ASSERT_SIZE_IN_BYTES= \ | 1465 PP_COMPILE_ASSERT_SIZE_IN_BYTES= \ |
| 1406 PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES= \ | 1466 PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES= \ |
| 1407 PP_INLINE= \ | 1467 PP_INLINE= \ |
| 1408 PP_EXPORT | 1468 PP_EXPORT |
| 1409 | 1469 |
| 1410 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then | 1470 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then |
| 1411 # this tag can be used to specify a list of macro names that should be expanded. | 1471 # this tag can be used to specify a list of macro names that should be expanded. |
| 1412 # The macro definition that is found in the sources will be used. | 1472 # The macro definition that is found in the sources will be used. |
| 1413 # Use the PREDEFINED tag if you want to use a different macro definition. | 1473 # Use the PREDEFINED tag if you want to use a different macro definition that |
| 1474 # overrules the definition found in the source code. | |
| 1414 | 1475 |
| 1415 EXPAND_AS_DEFINED = | 1476 EXPAND_AS_DEFINED = |
| 1416 | 1477 |
| 1417 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then | 1478 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then |
| 1418 # doxygen's preprocessor will remove all function-like macros that are alone | 1479 # doxygen's preprocessor will remove all references to function-like macros |
| 1419 # on a line, have an all uppercase name, and do not end with a semicolon. Such | 1480 # that are alone on a line, have an all uppercase name, and do not end with a |
| 1420 # function macros are typically used for boiler-plate code, and will confuse | 1481 # semicolon, because these will confuse the parser if not removed. |
| 1421 # the parser if not removed. | |
| 1422 | 1482 |
| 1423 SKIP_FUNCTION_MACROS = YES | 1483 SKIP_FUNCTION_MACROS = YES |
| 1424 | 1484 |
| 1425 #--------------------------------------------------------------------------- | 1485 #--------------------------------------------------------------------------- |
| 1426 # Configuration::additions related to external references | 1486 # Configuration::additions related to external references |
| 1427 #--------------------------------------------------------------------------- | 1487 #--------------------------------------------------------------------------- |
| 1428 | 1488 |
| 1429 # The TAGFILES option can be used to specify one or more tagfiles. | 1489 # The TAGFILES option can be used to specify one or more tagfiles. |
| 1430 # Optionally an initial location of the external documentation | 1490 # Optionally an initial location of the external documentation |
| 1431 # can be added for each tagfile. The format of a tag file without | 1491 # can be added for each tagfile. The format of a tag file without |
| (...skipping 68 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 1500 HAVE_DOT = YES | 1560 HAVE_DOT = YES |
| 1501 | 1561 |
| 1502 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is | 1562 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is |
| 1503 # allowed to run in parallel. When set to 0 (the default) doxygen will | 1563 # allowed to run in parallel. When set to 0 (the default) doxygen will |
| 1504 # base this on the number of processors available in the system. You can set it | 1564 # base this on the number of processors available in the system. You can set it |
| 1505 # explicitly to a value larger than 0 to get control over the balance | 1565 # explicitly to a value larger than 0 to get control over the balance |
| 1506 # between CPU load and processing speed. | 1566 # between CPU load and processing speed. |
| 1507 | 1567 |
| 1508 DOT_NUM_THREADS = 4 | 1568 DOT_NUM_THREADS = 4 |
| 1509 | 1569 |
| 1510 # By default doxygen will write a font called FreeSans.ttf to the output | 1570 # By default doxygen will write a font called Helvetica to the output |
| 1511 # directory and reference it in all dot files that doxygen generates. This | 1571 # directory and reference it in all dot files that doxygen generates. |
| 1512 # font does not include all possible unicode characters however, so when you nee d | 1572 # When you want a differently looking font you can specify the font name |
| 1513 # these (or just want a differently looking font) you can specify the font name | 1573 # using DOT_FONTNAME. You need to make sure dot is able to find the font, |
| 1514 # using DOT_FONTNAME. You need need to make sure dot is able to find the font, | |
| 1515 # which can be done by putting it in a standard location or by setting the | 1574 # which can be done by putting it in a standard location or by setting the |
| 1516 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory | 1575 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory |
| 1517 # containing the font. | 1576 # containing the font. |
| 1518 | 1577 |
| 1519 DOT_FONTNAME = FreeSans.ttf | 1578 DOT_FONTNAME = FreeSans.ttf |
| 1520 | 1579 |
| 1521 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. | 1580 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. |
| 1522 # The default size is 10pt. | 1581 # The default size is 10pt. |
| 1523 | 1582 |
| 1524 DOT_FONTSIZE = 10 | 1583 DOT_FONTSIZE = 10 |
| (...skipping 71 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 1596 GRAPHICAL_HIERARCHY = NO | 1655 GRAPHICAL_HIERARCHY = NO |
| 1597 | 1656 |
| 1598 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES | 1657 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES |
| 1599 # then doxygen will show the dependencies a directory has on other directories | 1658 # then doxygen will show the dependencies a directory has on other directories |
| 1600 # in a graphical way. The dependency relations are determined by the #include | 1659 # in a graphical way. The dependency relations are determined by the #include |
| 1601 # relations between the files in the directories. | 1660 # relations between the files in the directories. |
| 1602 | 1661 |
| 1603 DIRECTORY_GRAPH = YES | 1662 DIRECTORY_GRAPH = YES |
| 1604 | 1663 |
| 1605 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images | 1664 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images |
| 1606 # generated by dot. Possible values are png, jpg, or gif. | 1665 # generated by dot. Possible values are svg, png, jpg, or gif. |
| 1607 # If left blank png will be used. | 1666 # If left blank png will be used. |
| 1608 | 1667 |
| 1609 DOT_IMAGE_FORMAT = png | 1668 DOT_IMAGE_FORMAT = png |
| 1610 | 1669 |
| 1611 # The tag DOT_PATH can be used to specify the path where the dot tool can be | 1670 # The tag DOT_PATH can be used to specify the path where the dot tool can be |
| 1612 # found. If left blank, it is assumed the dot tool can be found in the path. | 1671 # found. If left blank, it is assumed the dot tool can be found in the path. |
| 1613 | 1672 |
| 1614 DOT_PATH = | 1673 DOT_PATH = /usr/local/graphviz-2.14/bin |
|
Matt Ball
2011/06/23 19:21:50
If possible, I'd prefer that this hard-coded path
jond
2011/06/28 15:36:42
I talked to Josie about this one. She wants the de
| |
| 1615 | 1674 |
| 1616 # The DOTFILE_DIRS tag can be used to specify one or more directories that | 1675 # The DOTFILE_DIRS tag can be used to specify one or more directories that |
| 1617 # contain dot files that are included in the documentation (see the | 1676 # contain dot files that are included in the documentation (see the |
| 1618 # \dotfile command). | 1677 # \dotfile command). |
| 1619 | 1678 |
| 1620 DOTFILE_DIRS = | 1679 DOTFILE_DIRS = |
| 1621 | 1680 |
| 1622 # The MSCFILE_DIRS tag can be used to specify one or more directories that | 1681 # The MSCFILE_DIRS tag can be used to specify one or more directories that |
| 1623 # contain msc files that are included in the documentation (see the | 1682 # contain msc files that are included in the documentation (see the |
| 1624 # \mscfile command). | 1683 # \mscfile command). |
| (...skipping 39 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 1664 # generate a legend page explaining the meaning of the various boxes and | 1723 # generate a legend page explaining the meaning of the various boxes and |
| 1665 # arrows in the dot generated graphs. | 1724 # arrows in the dot generated graphs. |
| 1666 | 1725 |
| 1667 GENERATE_LEGEND = YES | 1726 GENERATE_LEGEND = YES |
| 1668 | 1727 |
| 1669 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will | 1728 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will |
| 1670 # remove the intermediate dot files that are used to generate | 1729 # remove the intermediate dot files that are used to generate |
| 1671 # the various graphs. | 1730 # the various graphs. |
| 1672 | 1731 |
| 1673 DOT_CLEANUP = YES | 1732 DOT_CLEANUP = YES |
| OLD | NEW |