ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/svn/ircd-hybrid/branches/8.2.x/doc/Doxyfile
(Generate patch)

Comparing ircd-hybrid-8/doc/doxygen.conf (file contents):
Revision 1156 by michael, Tue Aug 9 20:29:20 2011 UTC vs.
Revision 1223 by michael, Sun Sep 18 11:40:06 2011 UTC

# Line 1 | Line 1
1 < # Doxyfile 1.6.1
1 > # Doxyfile 1.7.1
2  
3   # This file describes the settings to be used by the documentation system
4   # doxygen (www.doxygen.org) for a project
# Line 25 | Line 25 | DOXYFILE_ENCODING      = UTF-8
25   # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26   # by quotes) that should identify the project.
27  
28 < PROJECT_NAME           = ircd-hybrid
28 > PROJECT_NAME           = ircd-hybrid-8
29  
30   # The PROJECT_NUMBER tag can be used to enter a project or revision number.
31   # This could be handy for archiving the generated documentation or
32   # if some version control system is used.
33  
34 < PROJECT_NUMBER         = 7.3
34 > PROJECT_NUMBER         =
35  
36   # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37   # base path where the generated documentation will be put.
# Line 207 | Line 207 | OPTIMIZE_FOR_FORTRAN   = NO
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. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
210 > # Doxygen selects the parser to use depending on the extension of the files it
211 > # parses. 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
213 > # tag. The format is ext=language, where ext is a file extension, and language
214 > # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
215 > # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
216 > # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
217 > # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
218 > # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
219  
220   EXTENSION_MAPPING      =
221  
# Line 386 | Line 387 | HIDE_SCOPE_NAMES       = NO
387  
388   SHOW_INCLUDE_FILES     = YES
389  
390 + # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
391 + # will list include files with double quotes in the documentation
392 + # rather than with sharp brackets.
393 +
394 + FORCE_LOCAL_INCLUDES   = NO
395 +
396   # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
397   # is inserted in the documentation for inline members.
398  
# Line 405 | Line 412 | SORT_MEMBER_DOCS       = YES
412  
413   SORT_BRIEF_DOCS        = NO
414  
415 < # 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.
415 > # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
416 > # will sort the (brief and detailed) documentation of class members so that
417 > # constructors and destructors are listed first. If set to NO (the default)
418 > # the constructors will appear in the respective orders defined by
419 > # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
420 > # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
421 > # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
422  
423   SORT_MEMBERS_CTORS_1ST = NO
424  
# Line 499 | Line 512 | SHOW_NAMESPACES        = YES
512  
513   FILE_VERSION_FILTER    =
514  
515 < # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
516 < # doxygen. The layout file controls the global structure of the generated output files
517 < # in an output format independent way. The create the layout file that represents
518 < # doxygen's defaults, run doxygen with the -l option. You can optionally specify a
519 < # file name after the option, if omitted DoxygenLayout.xml will be used as the name
520 < # of the layout file.
515 > # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
516 > # by doxygen. The layout file controls the global structure of the generated
517 > # output files in an output format independent way. The create the layout file
518 > # that represents doxygen's defaults, run doxygen with the -l option.
519 > # You can optionally specify a file name after the option, if omitted
520 > # DoxygenLayout.xml will be used as the name of the layout file.
521  
522   LAYOUT_FILE            =
523  
# Line 802 | Line 815 | HTML_FOOTER            =
815  
816   HTML_STYLESHEET        =
817  
818 + # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
819 + # Doxygen will adjust the colors in the stylesheet and background images
820 + # according to this color. Hue is specified as an angle on a colorwheel,
821 + # see http://en.wikipedia.org/wiki/Hue for more information.
822 + # For instance the value 0 represents red, 60 is yellow, 120 is green,
823 + # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
824 + # The allowed range is 0 to 359.
825 +
826 + HTML_COLORSTYLE_HUE    = 220
827 +
828 + # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
829 + # the colors in the HTML output. For a value of 0 the output will use
830 + # grayscales only. A value of 255 will produce the most vivid colors.
831 +
832 + HTML_COLORSTYLE_SAT    = 100
833 +
834 + # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
835 + # the luminance component of the colors in the HTML output. Values below
836 + # 100 gradually make the output lighter, whereas values above 100 make
837 + # the output darker. The value divided by 100 is the actual gamma applied,
838 + # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
839 + # and 100 does not change the gamma.
840 +
841 + HTML_COLORSTYLE_GAMMA  = 80
842 +
843 + # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
844 + # page will contain the date and time when the page was generated. Setting
845 + # this to NO can help when comparing the output of multiple runs.
846 +
847 + HTML_TIMESTAMP         = YES
848 +
849   # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
850   # files or namespaces will be aligned in HTML using tables. If set to
851   # NO a bullet list will be used.
# Line 824 | Line 868 | HTML_DYNAMIC_SECTIONS  = YES
868   # directory and running "make install" will install the docset in
869   # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
870   # it at startup.
871 < # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
871 > # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
872 > # for more information.
873  
874   GENERATE_DOCSET        = NO
875  
# Line 842 | Line 887 | DOCSET_FEEDNAME        = "Doxygen genera
887  
888   DOCSET_BUNDLE_ID       = org.doxygen.Project
889  
890 + # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
891 + # the documentation publisher. This should be a reverse domain-name style
892 + # string, e.g. com.mycompany.MyDocSet.documentation.
893 +
894 + DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
895 +
896 + # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
897 +
898 + DOCSET_PUBLISHER_NAME  = Publisher
899 +
900   # If the GENERATE_HTMLHELP tag is set to YES, additional index files
901   # will be generated that can be used as input for tools like the
902   # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
# Line 886 | Line 941 | BINARY_TOC             = NO
941  
942   TOC_EXPAND             = NO
943  
944 < # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
945 < # are set, an additional index file will be generated that can be used as input for
946 < # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
947 < # HTML documentation.
944 > # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
945 > # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
946 > # that can be used as input for Qt's qhelpgenerator to generate a
947 > # Qt Compressed Help (.qch) of the generated HTML documentation.
948  
949   GENERATE_QHP           = NO
950  
# Line 911 | Line 966 | QHP_NAMESPACE          =
966  
967   QHP_VIRTUAL_FOLDER     = doc
968  
969 < # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
970 < # For more information please see
969 > # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
970 > # add. For more information please see
971   # http://doc.trolltech.com/qthelpproject.html#custom-filters
972  
973   QHP_CUST_FILTER_NAME   =
974  
975 < # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
976 < # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
975 > # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
976 > # custom filter to add. For more information please see
977 > # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
978 > # Qt Help Project / Custom Filters</a>.
979  
980   QHP_CUST_FILTER_ATTRS  =
981  
982 < # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
982 > # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
983 > # project's
984   # filter section matches.
985 < # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
985 > # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
986 > # Qt Help Project / Filter Attributes</a>.
987  
988   QHP_SECT_FILTER_ATTRS  =
989  
# Line 935 | Line 994 | QHP_SECT_FILTER_ATTRS  =
994  
995   QHG_LOCATION           =
996  
997 + # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
998 + #  will be generated, which together with the HTML files, form an Eclipse help
999 + # plugin. To install this plugin and make it available under the help contents
1000 + # menu in Eclipse, the contents of the directory containing the HTML and XML
1001 + # files needs to be copied into the plugins directory of eclipse. The name of
1002 + # the directory within the plugins directory should be the same as
1003 + # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1004 + # the help appears.
1005 +
1006 + GENERATE_ECLIPSEHELP   = NO
1007 +
1008 + # A unique identifier for the eclipse help plugin. When installing the plugin
1009 + # the directory name containing the HTML and XML files should also have
1010 + # this name.
1011 +
1012 + ECLIPSE_DOC_ID         = org.doxygen.Project
1013 +
1014   # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1015   # top of each HTML page. The value NO (the default) enables the index and
1016   # the value YES disables it.
# Line 967 | Line 1043 | USE_INLINE_TREES       = YES
1043  
1044   TREEVIEW_WIDTH         = 250
1045  
1046 + # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1047 + # links to external symbols imported via tag files in a separate window.
1048 +
1049 + EXT_LINKS_IN_WINDOW    = NO
1050 +
1051   # Use this tag to change the font size of Latex formulas included
1052   # as images in the HTML documentation. The default is 10. Note that
1053   # when you change the font size after a successful doxygen run you need
# Line 975 | Line 1056 | TREEVIEW_WIDTH         = 250
1056  
1057   FORMULA_FONTSIZE       = 10
1058  
1059 < # When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
1060 < # and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
1061 < # there is already a search function so this one should typically
1062 < # be disabled.
1059 > # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1060 > # generated for formulas are transparent PNGs. Transparent PNGs are
1061 > # not supported properly for IE 6.0, but are supported on all modern browsers.
1062 > # Note that when changing this option you need to delete any form_*.png files
1063 > # in the HTML output before the changes have effect.
1064 >
1065 > FORMULA_TRANSPARENT    = YES
1066 >
1067 > # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1068 > # for the HTML output. The underlying search engine uses javascript
1069 > # and DHTML and should work on any modern browser. Note that when using
1070 > # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1071 > # (GENERATE_DOCSET) there is already a search function so this one should
1072 > # typically be disabled. For large projects the javascript based search engine
1073 > # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1074  
1075   SEARCHENGINE           = YES
1076  
1077 + # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1078 + # implemented using a PHP enabled web server instead of at the web client
1079 + # using Javascript. Doxygen will generate the search PHP script and index
1080 + # file to put on the web server. The advantage of the server
1081 + # based approach is that it scales better to large projects and allows
1082 + # full text search. The disadvances is that it is more difficult to setup
1083 + # and does not have live searching capabilities.
1084 +
1085 + SERVER_BASED_SEARCH    = NO
1086 +
1087   #---------------------------------------------------------------------------
1088   # configuration options related to the LaTeX output
1089   #---------------------------------------------------------------------------
# Line 999 | Line 1101 | LATEX_OUTPUT           = latex
1101  
1102   # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1103   # invoked. If left blank `latex' will be used as the default command name.
1104 + # Note that when enabling USE_PDFLATEX this option is only used for
1105 + # generating bitmaps for formulas in the HTML output, but not in the
1106 + # Makefile that is written to the output directory.
1107  
1108   LATEX_CMD_NAME         = latex
1109  
# Line 1058 | Line 1163 | LATEX_BATCHMODE        = YES
1163  
1164   LATEX_HIDE_INDICES     = NO
1165  
1166 < # 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.
1166 > # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1167 > # source code with syntax highlighting in the LaTeX output.
1168 > # Note that which sources are shown also depends on other settings
1169 > # such as SOURCE_BROWSER.
1170  
1171   LATEX_SOURCE_CODE      = NO
1172  
# Line 1360 | Line 1468 | HIDE_UNDOC_RELATIONS   = YES
1468  
1469   HAVE_DOT               = YES
1470  
1471 + # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1472 + # allowed to run in parallel. When set to 0 (the default) doxygen will
1473 + # base this on the number of processors available in the system. You can set it
1474 + # explicitly to a value larger than 0 to get control over the balance
1475 + # between CPU load and processing speed.
1476 +
1477 + DOT_NUM_THREADS        = 0
1478 +
1479   # By default doxygen will write a font called FreeSans.ttf to the output
1480   # directory and reference it in all dot files that doxygen generates. This
1481   # font does not include all possible unicode characters however, so when you need

Diff Legend

Removed lines
+ Added lines
< Changed lines (old)
> Changed lines (new)