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-7.3/doc/doxygen.conf (file contents), Revision 1029 by michael, Sun Nov 8 13:10:50 2009 UTC vs.
ircd-hybrid-8/doc/Doxyfile (file contents), Revision 1419 by michael, Sun May 27 08:52:13 2012 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 570 | Line 583 | WARN_LOGFILE           =
583  
584   INPUT                  = include \
585                           modules \
573                         servlink \
586                           src
587  
588   # This tag can be used to specify the character encoding of the source files
# Line 601 | Line 613 | RECURSIVE              = YES
613   # excluded from the INPUT source files. This way you can easily exclude a
614   # subdirectory from a directory tree whose root is specified with the INPUT tag.
615  
616 < EXCLUDE                = src/ircd_parser.c \
617 <                         src/ircd_parser.h \
618 <                         src/ircd_lexer.c
616 > EXCLUDE                = src/conf_parser.c \
617 >                         src/conf_parser.h \
618 >                         src/conf_lexer.c
619  
620   # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
621   # directories that are symbolic links (a Unix filesystem feature) are excluded
# Line 802 | Line 814 | HTML_FOOTER            =
814  
815   HTML_STYLESHEET        =
816  
817 + # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
818 + # Doxygen will adjust the colors in the stylesheet and background images
819 + # according to this color. Hue is specified as an angle on a colorwheel,
820 + # see http://en.wikipedia.org/wiki/Hue for more information.
821 + # For instance the value 0 represents red, 60 is yellow, 120 is green,
822 + # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
823 + # The allowed range is 0 to 359.
824 +
825 + HTML_COLORSTYLE_HUE    = 220
826 +
827 + # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
828 + # the colors in the HTML output. For a value of 0 the output will use
829 + # grayscales only. A value of 255 will produce the most vivid colors.
830 +
831 + HTML_COLORSTYLE_SAT    = 100
832 +
833 + # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
834 + # the luminance component of the colors in the HTML output. Values below
835 + # 100 gradually make the output lighter, whereas values above 100 make
836 + # the output darker. The value divided by 100 is the actual gamma applied,
837 + # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
838 + # and 100 does not change the gamma.
839 +
840 + HTML_COLORSTYLE_GAMMA  = 80
841 +
842 + # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
843 + # page will contain the date and time when the page was generated. Setting
844 + # this to NO can help when comparing the output of multiple runs.
845 +
846 + HTML_TIMESTAMP         = YES
847 +
848   # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
849   # files or namespaces will be aligned in HTML using tables. If set to
850   # NO a bullet list will be used.
# Line 824 | Line 867 | HTML_DYNAMIC_SECTIONS  = YES
867   # directory and running "make install" will install the docset in
868   # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
869   # it at startup.
870 < # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
870 > # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
871 > # for more information.
872  
873   GENERATE_DOCSET        = NO
874  
# Line 842 | Line 886 | DOCSET_FEEDNAME        = "Doxygen genera
886  
887   DOCSET_BUNDLE_ID       = org.doxygen.Project
888  
889 + # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
890 + # the documentation publisher. This should be a reverse domain-name style
891 + # string, e.g. com.mycompany.MyDocSet.documentation.
892 +
893 + DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
894 +
895 + # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
896 +
897 + DOCSET_PUBLISHER_NAME  = Publisher
898 +
899   # If the GENERATE_HTMLHELP tag is set to YES, additional index files
900   # will be generated that can be used as input for tools like the
901   # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
# Line 886 | Line 940 | BINARY_TOC             = NO
940  
941   TOC_EXPAND             = NO
942  
943 < # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
944 < # are set, an additional index file will be generated that can be used as input for
945 < # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
946 < # HTML documentation.
943 > # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
944 > # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
945 > # that can be used as input for Qt's qhelpgenerator to generate a
946 > # Qt Compressed Help (.qch) of the generated HTML documentation.
947  
948   GENERATE_QHP           = NO
949  
# Line 911 | Line 965 | QHP_NAMESPACE          =
965  
966   QHP_VIRTUAL_FOLDER     = doc
967  
968 < # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
969 < # For more information please see
968 > # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
969 > # add. For more information please see
970   # http://doc.trolltech.com/qthelpproject.html#custom-filters
971  
972   QHP_CUST_FILTER_NAME   =
973  
974 < # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
975 < # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
974 > # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
975 > # custom filter to add. For more information please see
976 > # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
977 > # Qt Help Project / Custom Filters</a>.
978  
979   QHP_CUST_FILTER_ATTRS  =
980  
981 < # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
981 > # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
982 > # project's
983   # filter section matches.
984 < # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
984 > # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
985 > # Qt Help Project / Filter Attributes</a>.
986  
987   QHP_SECT_FILTER_ATTRS  =
988  
# Line 935 | Line 993 | QHP_SECT_FILTER_ATTRS  =
993  
994   QHG_LOCATION           =
995  
996 + # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
997 + #  will be generated, which together with the HTML files, form an Eclipse help
998 + # plugin. To install this plugin and make it available under the help contents
999 + # menu in Eclipse, the contents of the directory containing the HTML and XML
1000 + # files needs to be copied into the plugins directory of eclipse. The name of
1001 + # the directory within the plugins directory should be the same as
1002 + # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1003 + # the help appears.
1004 +
1005 + GENERATE_ECLIPSEHELP   = NO
1006 +
1007 + # A unique identifier for the eclipse help plugin. When installing the plugin
1008 + # the directory name containing the HTML and XML files should also have
1009 + # this name.
1010 +
1011 + ECLIPSE_DOC_ID         = org.doxygen.Project
1012 +
1013   # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1014   # top of each HTML page. The value NO (the default) enables the index and
1015   # the value YES disables it.
# Line 967 | Line 1042 | USE_INLINE_TREES       = YES
1042  
1043   TREEVIEW_WIDTH         = 250
1044  
1045 + # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1046 + # links to external symbols imported via tag files in a separate window.
1047 +
1048 + EXT_LINKS_IN_WINDOW    = NO
1049 +
1050   # Use this tag to change the font size of Latex formulas included
1051   # as images in the HTML documentation. The default is 10. Note that
1052   # when you change the font size after a successful doxygen run you need
# Line 975 | Line 1055 | TREEVIEW_WIDTH         = 250
1055  
1056   FORMULA_FONTSIZE       = 10
1057  
1058 < # When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
1059 < # and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
1060 < # there is already a search function so this one should typically
1061 < # be disabled.
1058 > # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1059 > # generated for formulas are transparent PNGs. Transparent PNGs are
1060 > # not supported properly for IE 6.0, but are supported on all modern browsers.
1061 > # Note that when changing this option you need to delete any form_*.png files
1062 > # in the HTML output before the changes have effect.
1063 >
1064 > FORMULA_TRANSPARENT    = YES
1065 >
1066 > # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1067 > # for the HTML output. The underlying search engine uses javascript
1068 > # and DHTML and should work on any modern browser. Note that when using
1069 > # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1070 > # (GENERATE_DOCSET) there is already a search function so this one should
1071 > # typically be disabled. For large projects the javascript based search engine
1072 > # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1073  
1074   SEARCHENGINE           = YES
1075  
1076 + # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1077 + # implemented using a PHP enabled web server instead of at the web client
1078 + # using Javascript. Doxygen will generate the search PHP script and index
1079 + # file to put on the web server. The advantage of the server
1080 + # based approach is that it scales better to large projects and allows
1081 + # full text search. The disadvances is that it is more difficult to setup
1082 + # and does not have live searching capabilities.
1083 +
1084 + SERVER_BASED_SEARCH    = NO
1085 +
1086   #---------------------------------------------------------------------------
1087   # configuration options related to the LaTeX output
1088   #---------------------------------------------------------------------------
# Line 999 | Line 1100 | LATEX_OUTPUT           = latex
1100  
1101   # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1102   # invoked. If left blank `latex' will be used as the default command name.
1103 + # Note that when enabling USE_PDFLATEX this option is only used for
1104 + # generating bitmaps for formulas in the HTML output, but not in the
1105 + # Makefile that is written to the output directory.
1106  
1107   LATEX_CMD_NAME         = latex
1108  
# Line 1058 | Line 1162 | LATEX_BATCHMODE        = YES
1162  
1163   LATEX_HIDE_INDICES     = NO
1164  
1165 < # 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.
1165 > # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1166 > # source code with syntax highlighting in the LaTeX output.
1167 > # Note that which sources are shown also depends on other settings
1168 > # such as SOURCE_BROWSER.
1169  
1170   LATEX_SOURCE_CODE      = NO
1171  
# Line 1360 | Line 1467 | HIDE_UNDOC_RELATIONS   = YES
1467  
1468   HAVE_DOT               = YES
1469  
1470 + # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1471 + # allowed to run in parallel. When set to 0 (the default) doxygen will
1472 + # base this on the number of processors available in the system. You can set it
1473 + # explicitly to a value larger than 0 to get control over the balance
1474 + # between CPU load and processing speed.
1475 +
1476 + DOT_NUM_THREADS        = 0
1477 +
1478   # By default doxygen will write a font called FreeSans.ttf to the output
1479   # directory and reference it in all dot files that doxygen generates. This
1480   # 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)