update to doxygen v1.4.0
authorklao
Sun, 09 Jan 2005 20:10:58 +0000
changeset 1065340fe3cbb145
parent 1064 5f0a20861a77
child 1066 520769d825f2
update to doxygen v1.4.0
src/work/Doxyfile
     1.1 --- a/src/work/Doxyfile	Sun Jan 09 20:08:53 2005 +0000
     1.2 +++ b/src/work/Doxyfile	Sun Jan 09 20:10:58 2005 +0000
     1.3 @@ -1,4 +1,4 @@
     1.4 -# Doxyfile 1.3.6
     1.5 +# Doxyfile 1.4.0
     1.6  
     1.7  # This file describes the settings to be used by the documentation system
     1.8  # doxygen (www.doxygen.org) for a project
     1.9 @@ -32,14 +32,24 @@
    1.10  
    1.11  OUTPUT_DIRECTORY       = 
    1.12  
    1.13 +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
    1.14 +# 4096 sub-directories (in 2 levels) under the output directory of each output 
    1.15 +# format and will distribute the generated files over these directories. 
    1.16 +# Enabling this option can be useful when feeding doxygen a huge amount of 
    1.17 +# source files, where putting all generated files in the same directory would 
    1.18 +# otherwise cause performance problems for the file system.
    1.19 +
    1.20 +CREATE_SUBDIRS         = NO
    1.21 +
    1.22  # The OUTPUT_LANGUAGE tag is used to specify the language in which all 
    1.23  # documentation generated by doxygen is written. Doxygen will use this 
    1.24  # information to generate all constant output in the proper language. 
    1.25  # The default language is English, other supported languages are: 
    1.26 -# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, 
    1.27 -# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en 
    1.28 -# (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese, 
    1.29 -# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
    1.30 +# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, 
    1.31 +# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, 
    1.32 +# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, 
    1.33 +# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, 
    1.34 +# Swedish, and Ukrainian.
    1.35  
    1.36  OUTPUT_LANGUAGE        = English
    1.37  
    1.38 @@ -70,11 +80,12 @@
    1.39  # This tag implements a quasi-intelligent brief description abbreviator 
    1.40  # that is used to form the text in various listings. Each string 
    1.41  # in this list, if found as the leading text of the brief description, will be 
    1.42 -# stripped from the text and the result after processing the whole list, is used 
    1.43 -# as the annotated text. Otherwise, the brief description is used as-is. If left 
    1.44 -# blank, the following values are used ("$name" is automatically replaced with the 
    1.45 -# name of the entity): "The $name class" "The $name widget" "The $name file" 
    1.46 -# "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
    1.47 +# stripped from the text and the result after processing the whole list, is 
    1.48 +# used as the annotated text. Otherwise, the brief description is used as-is. 
    1.49 +# If left blank, the following values are used ("$name" is automatically 
    1.50 +# replaced with the name of the entity): "The $name class" "The $name widget" 
    1.51 +# "The $name file" "is" "provides" "specifies" "contains" 
    1.52 +# "represents" "a" "an" "the"
    1.53  
    1.54  ABBREVIATE_BRIEF       = 
    1.55  
    1.56 @@ -84,10 +95,10 @@
    1.57  
    1.58  ALWAYS_DETAILED_SEC    = NO
    1.59  
    1.60 -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited 
    1.61 -# members of a class in the documentation of that class as if those members were 
    1.62 -# ordinary class members. Constructors, destructors and assignment operators of 
    1.63 -# the base classes will not be shown.
    1.64 +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
    1.65 +# inherited members of a class in the documentation of that class as if those 
    1.66 +# members were ordinary class members. Constructors, destructors and assignment 
    1.67 +# operators of the base classes will not be shown.
    1.68  
    1.69  INLINE_INHERITED_MEMB  = NO
    1.70  
    1.71 @@ -100,12 +111,21 @@
    1.72  # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
    1.73  # can be used to strip a user-defined part of the path. Stripping is 
    1.74  # only done if one of the specified strings matches the left-hand part of 
    1.75 -# the path. It is allowed to use relative paths in the argument list. 
    1.76 +# the path. The tag can be used to show relative paths in the file list. 
    1.77  # If left blank the directory from which doxygen is run is used as the 
    1.78  # path to strip.
    1.79  
    1.80  STRIP_FROM_PATH        = 
    1.81  
    1.82 +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
    1.83 +# the path mentioned in the documentation of a class, which tells 
    1.84 +# the reader which header file to include in order to use a class. 
    1.85 +# If left blank only the name of the header file containing the class 
    1.86 +# definition is used. Otherwise one should specify the include paths that 
    1.87 +# are normally passed to the compiler using the -I flag.
    1.88 +
    1.89 +STRIP_FROM_INC_PATH    = 
    1.90 +
    1.91  # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
    1.92  # (but less readable) file names. This can be useful is your file systems 
    1.93  # doesn't support long names like on DOS, Mac, or CD-ROM.
    1.94 @@ -162,8 +182,8 @@
    1.95  
    1.96  ALIASES                = 
    1.97  
    1.98 -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 
    1.99 -# only. Doxygen will then generate output that is more tailored for C. 
   1.100 +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
   1.101 +# sources only. Doxygen will then generate output that is more tailored for C. 
   1.102  # For instance, some of the names that are used will be different. The list 
   1.103  # of all members will be omitted, etc.
   1.104  
   1.105 @@ -211,6 +231,13 @@
   1.106  
   1.107  EXTRACT_LOCAL_CLASSES  = YES
   1.108  
   1.109 +# This flag is only useful for Objective-C code. When set to YES local 
   1.110 +# methods, which are defined in the implementation section but not in 
   1.111 +# the interface are included in the documentation. 
   1.112 +# If set to NO (the default) only methods in the interface are included.
   1.113 +
   1.114 +EXTRACT_LOCAL_METHODS  = NO
   1.115 +
   1.116  # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
   1.117  # undocumented members of documented classes, files or namespaces. 
   1.118  # If set to NO (the default) these members will be included in the 
   1.119 @@ -251,7 +278,7 @@
   1.120  # file names in lower-case letters. If set to YES upper-case letters are also 
   1.121  # allowed. This is useful if you have classes or files whose names only differ 
   1.122  # in case and if your file system supports case sensitive file names. Windows 
   1.123 -# users are advised to set this option to NO.
   1.124 +# and Mac users are advised to set this option to NO.
   1.125  
   1.126  CASE_SENSE_NAMES       = YES
   1.127  
   1.128 @@ -341,6 +368,22 @@
   1.129  
   1.130  SHOW_USED_FILES        = YES
   1.131  
   1.132 +# If the sources in your project are distributed over multiple directories 
   1.133 +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
   1.134 +# in the documentation.
   1.135 +
   1.136 +SHOW_DIRECTORIES       = YES
   1.137 +
   1.138 +# The FILE_VERSION_FILTER tag can be used to specify a program or script that 
   1.139 +# doxygen should invoke to get the current version for each file (typically from the 
   1.140 +# version control system). Doxygen will invoke the program by executing (via 
   1.141 +# popen()) the command <command> <input-file>, where <command> is the value of 
   1.142 +# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
   1.143 +# provided by doxygen. Whatever the progam writes to standard output 
   1.144 +# is used as the file version. See the manual for examples.
   1.145 +
   1.146 +FILE_VERSION_FILTER    = 
   1.147 +
   1.148  #---------------------------------------------------------------------------
   1.149  # configuration options related to warning and progress messages
   1.150  #---------------------------------------------------------------------------
   1.151 @@ -369,10 +412,20 @@
   1.152  
   1.153  WARN_IF_DOC_ERROR      = YES
   1.154  
   1.155 +# This WARN_NO_PARAMDOC option can be abled to get warnings for 
   1.156 +# functions that are documented, but have no documentation for their parameters 
   1.157 +# or return value. If set to NO (the default) doxygen will only warn about 
   1.158 +# wrong or incomplete parameter documentation, but not about the absence of 
   1.159 +# documentation.
   1.160 +
   1.161 +WARN_NO_PARAMDOC       = NO
   1.162 +
   1.163  # The WARN_FORMAT tag determines the format of the warning messages that 
   1.164  # doxygen can produce. The string should contain the $file, $line, and $text 
   1.165  # tags, which will be replaced by the file and line number from which the 
   1.166 -# warning originated and the warning text.
   1.167 +# warning originated and the warning text. Optionally the format may contain 
   1.168 +# $version, which will be replaced by the version of the file (if it could 
   1.169 +# be obtained via FILE_VERSION_FILTER)
   1.170  
   1.171  WARN_FORMAT            = "$file:$line: $text"
   1.172  
   1.173 @@ -392,31 +445,31 @@
   1.174  # with spaces.
   1.175  
   1.176  INPUT                  = ../../doc/mainpage.dox \
   1.177 -			 ../../doc/graphs.dox \
   1.178 -                         ../../doc/maps.dox ../../doc/coding_style.dox \
   1.179 +                         ../../doc/graphs.dox \
   1.180 +                         ../../doc/maps.dox \
   1.181 +                         ../../doc/coding_style.dox \
   1.182                           ../../doc/groups.dox \
   1.183                           ../lemon \
   1.184                           ../lemon/concept \
   1.185                           ../test/test_tools.h \
   1.186                           klao/debug.h \
   1.187                           jacint/max_flow.h \
   1.188 -                         jacint/max_matching.h \ 
   1.189 -			 marci/bfs_dfs.h \
   1.190 -	  		 marci/bfs_dfs_misc.h \
   1.191 +                         jacint/max_matching.h \
   1.192 +                         marci/bfs_dfs.h \
   1.193 +                         marci/bfs_dfs_misc.h \
   1.194                           marci/lp/lp_solver_wrapper.h \
   1.195 -			 jacint/graph_gen.h \
   1.196 -			 marci/max_bipartite_matching.h \
   1.197 -			 marci/bipartite_graph_wrapper.h \
   1.198 -			 alpar/graph_to_eps.cc \
   1.199 -                         deba \
   1.200 -                         
   1.201 +                         jacint/graph_gen.h \
   1.202 +                         marci/max_bipartite_matching.h \
   1.203 +                         marci/bipartite_graph_wrapper.h \
   1.204 +                         alpar/graph_to_eps.cc \
   1.205 +                         deba
   1.206  
   1.207  # If the value of the INPUT tag contains directories, you can use the 
   1.208  # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
   1.209  # and *.h) to filter out the source-files in the directories. If left 
   1.210  # blank the following patterns are tested: 
   1.211 -# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp 
   1.212 -# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
   1.213 +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
   1.214 +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
   1.215  
   1.216  FILE_PATTERNS          = 
   1.217  
   1.218 @@ -432,8 +485,9 @@
   1.219  
   1.220  EXCLUDE                = 
   1.221  
   1.222 -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories 
   1.223 -# that are symbolic links (a Unix filesystem feature) are excluded from the input.
   1.224 +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
   1.225 +# directories that are symbolic links (a Unix filesystem feature) are excluded 
   1.226 +# from the input.
   1.227  
   1.228  EXCLUDE_SYMLINKS       = NO
   1.229  
   1.230 @@ -474,10 +528,20 @@
   1.231  # by executing (via popen()) the command <filter> <input-file>, where <filter> 
   1.232  # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
   1.233  # input file. Doxygen will then use the output that the filter program writes 
   1.234 -# to standard output.
   1.235 +# to standard output.  If FILTER_PATTERNS is specified, this tag will be 
   1.236 +# ignored.
   1.237  
   1.238  INPUT_FILTER           = 
   1.239  
   1.240 +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
   1.241 +# basis.  Doxygen will compare the file name with each pattern and apply the 
   1.242 +# filter if there is a match.  The filters are a list of the form: 
   1.243 +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
   1.244 +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
   1.245 +# is applied to all files.
   1.246 +
   1.247 +FILTER_PATTERNS        = 
   1.248 +
   1.249  # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
   1.250  # INPUT_FILTER) will be used to filter the input files when producing source 
   1.251  # files to browse (i.e. when SOURCE_BROWSER is set to YES).
   1.252 @@ -930,7 +994,9 @@
   1.253  # are defined before the preprocessor is started (similar to the -D option of 
   1.254  # gcc). The argument of the tag is a list of macros of the form: name 
   1.255  # or name=definition (no spaces). If the definition and the = are 
   1.256 -# omitted =1 is assumed.
   1.257 +# omitted =1 is assumed. To prevent a macro definition from being 
   1.258 +# undefined via #undef or recursively expanded use the := operator 
   1.259 +# instead of the = operator.
   1.260  
   1.261  PREDEFINED             = DOXYGEN
   1.262  
   1.263 @@ -944,8 +1010,8 @@
   1.264  # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
   1.265  # doxygen's preprocessor will remove all function-like macros that are alone 
   1.266  # on a line, have an all uppercase name, and do not end with a semicolon. Such 
   1.267 -# function macros are typically used for boiler-plate code, and will confuse the 
   1.268 -# parser if not removed.
   1.269 +# function macros are typically used for boiler-plate code, and will confuse 
   1.270 +# the parser if not removed.
   1.271  
   1.272  SKIP_FUNCTION_MACROS   = YES
   1.273  
   1.274 @@ -997,10 +1063,11 @@
   1.275  #---------------------------------------------------------------------------
   1.276  
   1.277  # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
   1.278 -# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or 
   1.279 -# super classes. Setting the tag to NO turns the diagrams off. Note that this 
   1.280 -# option is superseded by the HAVE_DOT option below. This is only a fallback. It is 
   1.281 -# recommended to install and use dot, since it yields more powerful graphs.
   1.282 +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
   1.283 +# or super classes. Setting the tag to NO turns the diagrams off. Note that 
   1.284 +# this option is superseded by the HAVE_DOT option below. This is only a 
   1.285 +# fallback. It is recommended to install and use dot, since it yields more 
   1.286 +# powerful graphs.
   1.287  
   1.288  CLASS_DIAGRAMS         = YES
   1.289  
   1.290 @@ -1031,6 +1098,11 @@
   1.291  
   1.292  COLLABORATION_GRAPH    = YES
   1.293  
   1.294 +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
   1.295 +# will generate a graph for groups, showing the direct groups dependencies
   1.296 +
   1.297 +GROUP_GRAPHS           = YES
   1.298 +
   1.299  # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
   1.300  # collaboration diagrams in a style similar to the OMG's Unified Modeling 
   1.301  # Language.
   1.302 @@ -1069,6 +1141,13 @@
   1.303  
   1.304  GRAPHICAL_HIERARCHY    = YES
   1.305  
   1.306 +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
   1.307 +# then doxygen will show the dependencies a directory has on other directories 
   1.308 +# in a graphical way. The dependency relations are determined by the #include
   1.309 +# relations between the files in the directories.
   1.310 +
   1.311 +DIRECTORY_GRAPH        = YES
   1.312 +
   1.313  # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
   1.314  # generated by dot. Possible values are png, jpg, or gif
   1.315  # If left blank png will be used.
   1.316 @@ -1104,15 +1183,31 @@
   1.317  
   1.318  # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
   1.319  # graphs generated by dot. A depth value of 3 means that only nodes reachable 
   1.320 -# from the root by following a path via at most 3 edges will be shown. Nodes that 
   1.321 -# lay further from the root node will be omitted. Note that setting this option to 
   1.322 -# 1 or 2 may greatly reduce the computation time needed for large code bases. Also 
   1.323 -# note that a graph may be further truncated if the graph's image dimensions are 
   1.324 -# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). 
   1.325 -# If 0 is used for the depth value (the default), the graph is not depth-constrained.
   1.326 +# from the root by following a path via at most 3 edges will be shown. Nodes 
   1.327 +# that lay further from the root node will be omitted. Note that setting this 
   1.328 +# option to 1 or 2 may greatly reduce the computation time needed for large 
   1.329 +# code bases. Also note that a graph may be further truncated if the graph's 
   1.330 +# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH 
   1.331 +# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), 
   1.332 +# the graph is not depth-constrained.
   1.333  
   1.334  MAX_DOT_GRAPH_DEPTH    = 0
   1.335  
   1.336 +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
   1.337 +# background. This is disabled by default, which results in a white background. 
   1.338 +# Warning: Depending on the platform used, enabling this option may lead to 
   1.339 +# badly anti-aliased labels on the edges of a graph (i.e. they become hard to 
   1.340 +# read).
   1.341 +
   1.342 +DOT_TRANSPARENT        = NO
   1.343 +
   1.344 +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
   1.345 +# files in one run (i.e. multiple -o and -T options on the command line). This 
   1.346 +# makes dot run faster, but since only newer versions of dot (>1.8.10) 
   1.347 +# support this, this feature is disabled by default.
   1.348 +
   1.349 +DOT_MULTI_TARGETS      = NO
   1.350 +
   1.351  # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
   1.352  # generate a legend page explaining the meaning of the various boxes and 
   1.353  # arrows in the dot generated graphs.