[ogs-changes] dist/c++/doc Doxyfile.in,1.1,1.2
Status: Alpha
Brought to you by:
elemings
Menu
▾
▴
[ogs-changes] dist/c++/doc Doxyfile.in,1.1,1.2
|
From: <ele...@us...> - 2003-04-15 16:59:02
|
Update of /cvsroot/ogs/dist/c++/doc In directory sc8-pr-cvs1:/tmp/cvs-serv20206/c++/doc Modified Files: Doxyfile.in Log Message: See C++ ChangeLog (Apr 15) for details. Index: Doxyfile.in =================================================================== RCS file: /cvsroot/ogs/dist/c++/doc/Doxyfile.in,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** Doxyfile.in 13 Apr 2003 05:31:56 -0000 1.1 --- Doxyfile.in 15 Apr 2003 16:58:28 -0000 1.2 *************** *** 1,3 **** ! # Doxyfile 1.2.18 # This file describes the settings to be used by the documentation system --- 1,3 ---- ! # Doxyfile 1.3 # This file describes the settings to be used by the documentation system *************** *** 44,47 **** --- 44,57 ---- OUTPUT_LANGUAGE = English + # This tag can be used to specify the encoding used in the generated output. + # The encoding is not always determined by the language that is chosen, + # but also whether or not the output is meant for Windows or non-Windows users. + # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES + # forces the Windows enconding, (this is the default for the Windows binary), + # whereas setting the tag to NO uses a Unix-style encoding (the default for the + # all platforms other than Windows). + + USE_WINDOWS_ENCODING = NO + # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in # documentation are documented, even if no documentation was available. *************** *** 89,92 **** --- 99,109 ---- HIDE_FRIEND_COMPOUNDS = NO + # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any + # documentation blocks found inside the body of a function. + # If set to NO (the default) these blocks will be appended to the + # function's detailed documentation block. + + HIDE_IN_BODY_DOCS = NO + # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will # include brief member descriptions after the members that are listed in *************** *** 136,145 **** INTERNAL_DOCS = NO - # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct - # doxygen to hide any special comment blocks from generated source code - # fragments. Normal C and C++ comments will always remain visible. - - STRIP_CODE_COMMENTS = YES - # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate # file names in lower case letters. If set to YES upper case letters are also --- 153,156 ---- *************** *** 246,250 **** # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or ! # disable (NO) the deprecated list. This list is created by putting \deprecated commands in the documentation. GENERATE_DEPRECATEDLIST= YES --- 257,262 ---- # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or ! # disable (NO) the deprecated list. This list is created by putting ! # \deprecated commands in the documentation. GENERATE_DEPRECATEDLIST= YES *************** *** 315,318 **** --- 327,337 ---- WARN_IF_UNDOCUMENTED = YES + # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for + # potential errors in the documentation, such as not documenting some + # parameters in a documented function, or documenting parameters that + # don't exist or using markup commands wrongly. + + WARN_IF_DOC_ERROR = YES + # The WARN_FORMAT tag determines the format of the warning messages that # doxygen can produce. The string should contain the $file, $line, and $text *************** *** 444,447 **** --- 463,472 ---- INLINE_SOURCES = NO + # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct + # doxygen to hide any special comment blocks from generated source code + # fragments. Normal C and C++ comments will always remain visible. + + STRIP_CODE_COMMENTS = YES + # If the REFERENCED_BY_RELATION tag is set to YES (the default) # then for each documented function all documented *************** *** 577,584 **** # generated containing a tree-like index structure (just like the one that # is generated for HTML Help). For this to work a browser that supports ! # JavaScript and frames is required (for instance Mozilla, Netscape 4.0+, ! # or Internet explorer 4.0+). Note that for large projects the tree generation ! # can take a very long time. In such cases it is better to disable this feature. ! # Windows users are probably better off using the HTML help feature. GENERATE_TREEVIEW = NO --- 602,608 ---- # generated containing a tree-like index structure (just like the one that # is generated for HTML Help). For this to work a browser that supports ! # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, ! # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are ! # probably better off using the HTML help feature. GENERATE_TREEVIEW = NO *************** *** 605,609 **** LATEX_OUTPUT = latex ! # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked. If left blank `latex' will be used as the default command name. LATEX_CMD_NAME = latex --- 629,634 ---- LATEX_OUTPUT = latex ! # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be ! # invoked. If left blank `latex' will be used as the default command name. LATEX_CMD_NAME = latex *************** *** 659,662 **** --- 684,693 ---- LATEX_BATCHMODE = NO + # If LATEX_HIDE_INDICES is set to YES then doxygen will not + # include the index chapters (such as File Index, Compound Index, etc.) + # in the output. + + LATEX_HIDE_INDICES = NO + #--------------------------------------------------------------------------- # configuration options related to the RTF output *************** *** 766,769 **** --- 797,833 ---- #--------------------------------------------------------------------------- + # configuration options related to the Perl module output + #--------------------------------------------------------------------------- + + # If the GENERATE_PERLMOD tag is set to YES Doxygen will + # generate a Perl module file that captures the structure of + # the code including all documentation. Note that this + # feature is still experimental and incomplete at the + # moment. + + GENERATE_PERLMOD = NO + + # If the PERLMOD_LATEX tag is set to YES Doxygen will generate + # the necessary Makefile rules, Perl scripts and LaTeX code to be able + # to generate PDF and DVI output from the Perl module output. + + PERLMOD_LATEX = NO + + # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be + # nicely formatted so it can be parsed by a human reader. This is useful + # if you want to understand what is going on. On the other hand, if this + # tag is set to NO the size of the Perl module output will be much smaller + # and Perl will parse it just the same. + + PERLMOD_PRETTY = YES + + # The names of the make variables in the generated doxyrules.make file + # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. + # This is useful so different doxyrules.make files included by the same + # Makefile don't overwrite each other's variables. + + PERLMOD_MAKEVAR_PREFIX = + + #--------------------------------------------------------------------------- # Configuration options related to the preprocessor #--------------------------------------------------------------------------- *************** *** 797,801 **** # the preprocessor. ! INCLUDE_PATH = .. # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard --- 861,865 ---- # the preprocessor. ! INCLUDE_PATH = @top_srcdir@ # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard *************** *** 814,818 **** PREDEFINED = __cplusplus ! # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then # this tag can be used to specify a list of macro names that should be expanded. # The macro definition that is found in the sources will be used. --- 878,882 ---- PREDEFINED = __cplusplus ! # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then # this tag can be used to specify a list of macro names that should be expanded. # The macro definition that is found in the sources will be used. *************** *** 833,837 **** #--------------------------------------------------------------------------- ! # The TAGFILES tag can be used to specify one or more tagfiles. TAGFILES = --- 897,914 ---- #--------------------------------------------------------------------------- ! # The TAGFILES option can be used to specify one or more tagfiles. ! # Optionally an initial location of the external documentation ! # can be added for each tagfile. The format of a tag file without ! # this location is as follows: ! # TAGFILES = file1 file2 ... ! # Adding location for the tag files is done as follows: ! # TAGFILES = file1=loc1 "file2 = loc2" ... ! # where "loc1" and "loc2" can be relative or absolute paths or ! # URLs. If a location is present for each tag, the installdox tool ! # does not have to be run to correct the links. ! # Note that each tag file must have a unique name ! # (where the name does NOT include the path) ! # If a tag file is not located in the directory in which doxygen ! # is run, you must also specify the path to the tagfile here. TAGFILES = *************** *** 954,957 **** --- 1031,1045 ---- MAX_DOT_GRAPH_HEIGHT = 1024 + + # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the + # graphs generated by dot. A depth value of 3 means that only nodes reachable + # from the root by following a path via at most 3 edges will be shown. Nodes that + # lay further from the root node will be omitted. Note that setting this option to + # 1 or 2 may greatly reduce the computation time needed for large code bases. Also + # note that a graph may be further truncated if the graph's image dimensions are + # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). + # If 0 is used fot the depth value (the default), the graph is not depth constraint. + + MAX_DOT_GRAPH_DEPTH = 0 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will |