Develop and Download Open Source Software

beego_tools

Browse Subversion Repository

/[beego]/Doxyfile

Diff of /Doxyfile

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 116 by satofumi, Sun Oct 21 01:35:46 2007 UTC revision 117 by satofumi, Sun Oct 21 05:55:26 2007 UTC
# Line 1  Line 1 
1  # Doxyfile 1.4.6  # Doxyfile 1.5.3
2    
3  # This file describes the settings to be used by the documentation system  # This file describes the settings to be used by the documentation system
4  # doxygen (www.doxygen.org) for a project  # doxygen (www.doxygen.org) for a project
# Line 14  Line 14 
14  # Project related configuration options  # Project related configuration options
15  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
16    
17    # This tag specifies the encoding used for all characters in the config file that
18    # follow. The default is UTF-8 which is also the encoding used for all text before
19    # the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into
20    # libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
21    # possible encodings.
22    
23    DOXYFILE_ENCODING      = UTF-8
24    
25  # The PROJECT_NAME tag is a single word (or a sequence of words surrounded  # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26  # by quotes) that should identify the project.  # by quotes) that should identify the project.
27    
# Line 45  CREATE_SUBDIRS         = NO Line 53  CREATE_SUBDIRS         = NO
53  # documentation generated by doxygen is written. Doxygen will use this  # documentation generated by doxygen is written. Doxygen will use this
54  # information to generate all constant output in the proper language.  # information to generate all constant output in the proper language.
55  # The default language is English, other supported languages are:  # The default language is English, other supported languages are:
56  # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,  # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57  # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,  # Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,
58  # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,  # Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
59  # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,  # Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
60  # Swedish, and Ukrainian.  # Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
61    
62  OUTPUT_LANGUAGE        = Japanese-en  OUTPUT_LANGUAGE        = Japanese-en
63    
 # 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 encoding (this is the default for the Windows binary),  
 # whereas setting the tag to NO uses a Unix-style encoding (the default for  
 # all platforms other than Windows).  
   
 USE_WINDOWS_ENCODING   = NO  
   
64  # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will  # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
65  # include brief member descriptions after the members that are listed in  # include brief member descriptions after the members that are listed in
66  # the file and class documentation (similar to JavaDoc).  # the file and class documentation (similar to JavaDoc).
# Line 135  SHORT_NAMES            = NO Line 133  SHORT_NAMES            = NO
133  # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen  # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
134  # will interpret the first line (until the first dot) of a JavaDoc-style  # will interpret the first line (until the first dot) of a JavaDoc-style
135  # comment as the brief description. If set to NO, the JavaDoc  # comment as the brief description. If set to NO, the JavaDoc
136  # comments will behave just like the Qt-style comments (thus requiring an  # comments will behave just like regular Qt-style comments
137  # explicit @brief command for a brief description.  # (thus requiring an explicit @brief command for a brief description.)
138    
139  JAVADOC_AUTOBRIEF      = NO  JAVADOC_AUTOBRIEF      = NO
140    
141    # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
142    # interpret the first line (until the first dot) of a Qt-style
143    # comment as the brief description. If set to NO, the comments
144    # will behave just like regular Qt-style comments (thus requiring
145    # an explicit \brief command for a brief description.)
146    
147    QT_AUTOBRIEF           = NO
148    
149  # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen  # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
150  # treat a multi-line C++ special comment block (i.e. a block of //! or ///  # treat a multi-line C++ special comment block (i.e. a block of //! or ///
151  # comments) as a brief description. This used to be the default behaviour.  # comments) as a brief description. This used to be the default behaviour.
# Line 204  OPTIMIZE_OUTPUT_JAVA   = NO Line 210  OPTIMIZE_OUTPUT_JAVA   = NO
210    
211  BUILTIN_STL_SUPPORT    = NO  BUILTIN_STL_SUPPORT    = NO
212    
213    # If you use Microsoft's C++/CLI language, you should set this option to YES to
214    # enable parsing support.
215    
216    CPP_CLI_SUPPORT        = NO
217    
218  # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC  # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
219  # tag is set to YES, then doxygen will reuse the documentation of the first  # tag is set to YES, then doxygen will reuse the documentation of the first
220  # member in the group (if any) for the other members of the group. By default  # member in the group (if any) for the other members of the group. By default
# Line 253  EXTRACT_LOCAL_CLASSES  = YES Line 264  EXTRACT_LOCAL_CLASSES  = YES
264    
265  EXTRACT_LOCAL_METHODS  = NO  EXTRACT_LOCAL_METHODS  = NO
266    
267    # If this flag is set to YES, the members of anonymous namespaces will be extracted
268    # and appear in the documentation as a namespace called 'anonymous_namespace{file}',
269    # where file will be replaced with the base name of the file that contains the anonymous
270    # namespace. By default anonymous namespace are hidden.
271    
272    EXTRACT_ANON_NSPACES   = NO
273    
274  # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all  # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
275  # undocumented members of documented classes, files or namespaces.  # undocumented members of documented classes, files or namespaces.
276  # If set to NO (the default) these members will be included in the  # If set to NO (the default) these members will be included in the
# Line 442  WARN_NO_PARAMDOC       = NO Line 460  WARN_NO_PARAMDOC       = NO
460  # $version, which will be replaced by the version of the file (if it could  # $version, which will be replaced by the version of the file (if it could
461  # be obtained via FILE_VERSION_FILTER)  # be obtained via FILE_VERSION_FILTER)
462    
463  WARN_FORMAT            = "$file:$line: $text"  WARN_FORMAT            = "$file:$line: $text "
464    
465  # The WARN_LOGFILE tag can be used to specify a file to which warning  # The WARN_LOGFILE tag can be used to specify a file to which warning
466  # and error messages should be written. If left blank the output is written  # and error messages should be written. If left blank the output is written
# Line 461  WARN_LOGFILE           = Line 479  WARN_LOGFILE           =
479    
480  INPUT                  =  INPUT                  =
481    
482    # This tag can be used to specify the character encoding of the source files that
483    # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
484    # input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
485    # See http://www.gnu.org/software/libiconv for the list of possible encodings.
486    
487    INPUT_ENCODING         = UTF-8
488    
489  # If the value of the INPUT tag contains directories, you can use the  # If the value of the INPUT tag contains directories, you can use the
490  # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp  # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
491  # and *.h) to filter out the source-files in the directories. If left  # and *.h) to filter out the source-files in the directories. If left
# Line 468  INPUT                  = Line 493  INPUT                  =
493  # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx  # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
494  # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py  # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
495    
496  FILE_PATTERNS          = *.h *.cpp *.dox  FILE_PATTERNS          = *.h \
497                             *.cpp \
498                             *.rb \
499                             *.dox
500    
501  # The RECURSIVE tag can be used to turn specify whether or not subdirectories  # The RECURSIVE tag can be used to turn specify whether or not subdirectories
502  # should be searched for input files as well. Possible values are YES and NO.  # should be searched for input files as well. Possible values are YES and NO.
# Line 494  EXCLUDE_SYMLINKS       = NO Line 522  EXCLUDE_SYMLINKS       = NO
522  # against the file with absolute path, so to exclude all test directories  # against the file with absolute path, so to exclude all test directories
523  # for example use the pattern */test/*  # for example use the pattern */test/*
524    
525  EXCLUDE_PATTERNS       =  EXCLUDE_PATTERNS       = */old_gui/* # */Test*.h */Test*.cpp
526    
527    # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
528    # (namespaces, classes, functions, etc.) that should be excluded from the output.
529    # The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
530    # a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
531    
532    EXCLUDE_SYMBOLS        =
533    
534  # The EXAMPLE_PATH tag can be used to specify one or more files or  # The EXAMPLE_PATH tag can be used to specify one or more files or
535  # directories that contain example code fragments that are included (see  # directories that contain example code fragments that are included (see
# Line 520  EXAMPLE_RECURSIVE      = NO Line 555  EXAMPLE_RECURSIVE      = NO
555  # directories that contain image that are included in the documentation (see  # directories that contain image that are included in the documentation (see
556  # the \image command).  # the \image command).
557    
558  IMAGE_PATH             =  IMAGE_PATH             = img/
559    
560  # The INPUT_FILTER tag can be used to specify a program that doxygen should  # The INPUT_FILTER tag can be used to specify a program that doxygen should
561  # invoke to filter for each input file. Doxygen will invoke the filter program  # invoke to filter for each input file. Doxygen will invoke the filter program
# Line 530  IMAGE_PATH             = Line 565  IMAGE_PATH             =
565  # to standard output.  If FILTER_PATTERNS is specified, this tag will be  # to standard output.  If FILTER_PATTERNS is specified, this tag will be
566  # ignored.  # ignored.
567    
568  INPUT_FILTER           = "/usr/bin/nkf -S -e"  INPUT_FILTER           = "/usr/bin/nkf -S -w"
569    
570  # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern  # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
571  # basis.  Doxygen will compare the file name with each pattern and apply the  # basis.  Doxygen will compare the file name with each pattern and apply the
# Line 554  FILTER_SOURCE_FILES    = NO Line 589  FILTER_SOURCE_FILES    = NO
589  # If the SOURCE_BROWSER tag is set to YES then a list of source files will  # If the SOURCE_BROWSER tag is set to YES then a list of source files will
590  # be generated. Documented entities will be cross-referenced with these sources.  # be generated. Documented entities will be cross-referenced with these sources.
591  # Note: To get rid of all source code in the generated output, make sure also  # Note: To get rid of all source code in the generated output, make sure also
592  # VERBATIM_HEADERS is set to NO.  # VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH
593    # then you must also enable this option. If you don't then doxygen will produce
594    # a warning and turn it on anyway
595    
596  SOURCE_BROWSER         = NO  SOURCE_BROWSER         = NO
597    
# Line 581  REFERENCED_BY_RELATION = YES Line 618  REFERENCED_BY_RELATION = YES
618    
619  REFERENCES_RELATION    = YES  REFERENCES_RELATION    = YES
620    
621    # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
622    # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
623    # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
624    # link to the source code.  Otherwise they will link to the documentstion.
625    
626    REFERENCES_LINK_SOURCE = YES
627    
628  # If the USE_HTAGS tag is set to YES then the references to source code  # If the USE_HTAGS tag is set to YES then the references to source code
629  # will point to the HTML generated by the htags(1) tool instead of doxygen  # will point to the HTML generated by the htags(1) tool instead of doxygen
630  # built-in source browser. The htags tool is part of GNU's global source  # built-in source browser. The htags tool is part of GNU's global source
# Line 673  HTML_ALIGN_MEMBERS     = YES Line 717  HTML_ALIGN_MEMBERS     = YES
717    
718  GENERATE_HTMLHELP      = NO  GENERATE_HTMLHELP      = NO
719    
720    # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
721    # documentation will contain sections that can be hidden and shown after the
722    # page has loaded. For this to work a browser that supports
723    # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
724    # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
725    
726    HTML_DYNAMIC_SECTIONS  = NO
727    
728  # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can  # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
729  # be used to specify the file name of the resulting .chm file. You  # be used to specify the file name of the resulting .chm file. You
730  # can add a path in front of the file if the result should not be  # can add a path in front of the file if the result should not be
# Line 1041  SKIP_FUNCTION_MACROS   = YES Line 1093  SKIP_FUNCTION_MACROS   = YES
1093  # If a tag file is not located in the directory in which doxygen  # If a tag file is not located in the directory in which doxygen
1094  # is run, you must also specify the path to the tagfile here.  # is run, you must also specify the path to the tagfile here.
1095    
1096  TAGFILES               =  TAGFILES               =
 #TAGFILES               = "tools/sloader/sloader.tag =tools/sloader/doxygen_html/"  
1097    
1098  # When a file name is specified after GENERATE_TAGFILE, doxygen will create  # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1099  # a tag file that is based on the input files it reads.  # a tag file that is based on the input files it reads.
# Line 1079  PERL_PATH              = /usr/bin/perl Line 1130  PERL_PATH              = /usr/bin/perl
1130    
1131  CLASS_DIAGRAMS         = YES  CLASS_DIAGRAMS         = YES
1132    
1133    # You can define message sequence charts within doxygen comments using the \msc
1134    # command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
1135    # produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
1136    # specify the directory where the mscgen tool resides. If left empty the tool is assumed to
1137    # be found in the default search path.
1138    
1139    MSCGEN_PATH            =
1140    
1141  # If set to YES, the inheritance and collaboration graphs will hide  # If set to YES, the inheritance and collaboration graphs will hide
1142  # inheritance and usage relations if the target is undocumented  # inheritance and usage relations if the target is undocumented
1143  # or is not a class.  # or is not a class.
# Line 1090  HIDE_UNDOC_RELATIONS   = YES Line 1149  HIDE_UNDOC_RELATIONS   = YES
1149  # toolkit from AT&T and Lucent Bell Labs. The other options in this section  # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1150  # have no effect if this option is set to NO (the default)  # have no effect if this option is set to NO (the default)
1151    
1152  HAVE_DOT               = NO  HAVE_DOT               = YES
1153    
1154  # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen  # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1155  # will generate a graph for each documented class showing the direct and  # will generate a graph for each documented class showing the direct and
# Line 1136  INCLUDE_GRAPH          = YES Line 1195  INCLUDE_GRAPH          = YES
1195    
1196  INCLUDED_BY_GRAPH      = YES  INCLUDED_BY_GRAPH      = YES
1197    
1198  # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will  # If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
1199  # generate a call dependency graph for every global function or class method.  # generate a call dependency graph for every global function or class method.
1200  # Note that enabling this option will significantly increase the time of a run.  # Note that enabling this option will significantly increase the time of a run.
1201  # So in most cases it will be better to enable call graphs for selected  # So in most cases it will be better to enable call graphs for selected
# Line 1144  INCLUDED_BY_GRAPH      = YES Line 1203  INCLUDED_BY_GRAPH      = YES
1203    
1204  CALL_GRAPH             = NO  CALL_GRAPH             = NO
1205    
1206    # If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
1207    # generate a caller dependency graph for every global function or class method.
1208    # Note that enabling this option will significantly increase the time of a run.
1209    # So in most cases it will be better to enable caller graphs for selected
1210    # functions only using the \callergraph command.
1211    
1212    CALLER_GRAPH           = NO
1213    
1214  # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen  # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1215  # will graphical hierarchy of all classes instead of a textual one.  # will graphical hierarchy of all classes instead of a textual one.
1216    
# Line 1173  DOT_PATH               = Line 1240  DOT_PATH               =
1240    
1241  DOTFILE_DIRS           =  DOTFILE_DIRS           =
1242    
1243  # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width  # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1244  # (in pixels) of the graphs generated by dot. If a graph becomes larger than  # nodes that will be shown in the graph. If the number of nodes in a graph
1245  # this value, doxygen will try to truncate the graph, so that it fits within  # becomes larger than this value, doxygen will truncate the graph, which is
1246  # the specified constraint. Beware that most browsers cannot cope with very  # visualized by representing a node as a red box. Note that doxygen if the number
1247  # large images.  # of direct children of the root node in a graph is already larger than
1248    # MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note
1249  MAX_DOT_GRAPH_WIDTH    = 1024  # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
   
 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height  
 # (in pixels) of the graphs generated by dot. If a graph becomes larger than  
 # this value, doxygen will try to truncate the graph, so that it fits within  
 # the specified constraint. Beware that most browsers cannot cope with very  
 # large images.  
1250    
1251  MAX_DOT_GRAPH_HEIGHT   = 1024  DOT_GRAPH_MAX_NODES    = 50
1252    
1253  # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the  # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1254  # graphs generated by dot. A depth value of 3 means that only nodes reachable  # graphs generated by dot. A depth value of 3 means that only nodes reachable
1255  # from the root by following a path via at most 3 edges will be shown. Nodes  # from the root by following a path via at most 3 edges will be shown. Nodes
1256  # that lay further from the root node will be omitted. Note that setting this  # that lay further from the root node will be omitted. Note that setting this
1257  # option to 1 or 2 may greatly reduce the computation time needed for large  # option to 1 or 2 may greatly reduce the computation time needed for large
1258  # code bases. Also note that a graph may be further truncated if the graph's  # code bases. Also note that the size of a graph can be further restricted by
1259  # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH  # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
 # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),  
 # the graph is not depth-constrained.  
1260    
1261  MAX_DOT_GRAPH_DEPTH    = 0  MAX_DOT_GRAPH_DEPTH    = 0
1262    
# Line 1235  DOT_CLEANUP            = YES Line 1294  DOT_CLEANUP            = YES
1294  # The SEARCHENGINE tag specifies whether or not a search engine should be  # The SEARCHENGINE tag specifies whether or not a search engine should be
1295  # used. If set to NO the values of all tags below this one will be ignored.  # used. If set to NO the values of all tags below this one will be ignored.
1296    
1297  SEARCHENGINE           = NO  SEARCHENGINE           = YES
Legend:
Removed from v.116  
changed lines
  Added in v.117
Back to OSDN">Back to OSDN
 ViewVC Help
Powered by ViewVC 1.1.26  
About OSDN
Find Software
Develop Software
Help