doc/Doxyfile
changeset 1063 d53a12d49262
parent 1030 c8a41699e613
child 1064 5f0a20861a77
     1.1 --- a/doc/Doxyfile	Sat Jan 08 20:16:56 2005 +0000
     1.2 +++ b/doc/Doxyfile	Sun Jan 09 20:06:57 2005 +0000
     1.3 @@ -1,4 +1,4 @@
     1.4 -# Doxyfile 1.3.9
     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 @@ -35,9 +35,9 @@
    1.10  # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
    1.11  # 4096 sub-directories (in 2 levels) under the output directory of each output 
    1.12  # format and will distribute the generated files over these directories. 
    1.13 -# Enabling this option can be useful when feeding doxygen a huge amount of source 
    1.14 -# files, where putting all generated files in the same directory would otherwise 
    1.15 -# cause performance problems for the file system.
    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 @@ -80,11 +80,12 @@
    1.23  # This tag implements a quasi-intelligent brief description abbreviator 
    1.24  # that is used to form the text in various listings. Each string 
    1.25  # in this list, if found as the leading text of the brief description, will be 
    1.26 -# stripped from the text and the result after processing the whole list, is used 
    1.27 -# as the annotated text. Otherwise, the brief description is used as-is. If left 
    1.28 -# blank, the following values are used ("$name" is automatically replaced with the 
    1.29 -# name of the entity): "The $name class" "The $name widget" "The $name file" 
    1.30 -# "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
    1.31 +# stripped from the text and the result after processing the whole list, is 
    1.32 +# used as the annotated text. Otherwise, the brief description is used as-is. 
    1.33 +# If left blank, the following values are used ("$name" is automatically 
    1.34 +# replaced with the name of the entity): "The $name class" "The $name widget" 
    1.35 +# "The $name file" "is" "provides" "specifies" "contains" 
    1.36 +# "represents" "a" "an" "the"
    1.37  
    1.38  ABBREVIATE_BRIEF       = 
    1.39  
    1.40 @@ -94,10 +95,10 @@
    1.41  
    1.42  ALWAYS_DETAILED_SEC    = NO
    1.43  
    1.44 -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited 
    1.45 -# members of a class in the documentation of that class as if those members were 
    1.46 -# ordinary class members. Constructors, destructors and assignment operators of 
    1.47 -# the base classes will not be shown.
    1.48 +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
    1.49 +# inherited members of a class in the documentation of that class as if those 
    1.50 +# members were ordinary class members. Constructors, destructors and assignment 
    1.51 +# operators of the base classes will not be shown.
    1.52  
    1.53  INLINE_INHERITED_MEMB  = NO
    1.54  
    1.55 @@ -181,8 +182,8 @@
    1.56  
    1.57  ALIASES                = 
    1.58  
    1.59 -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 
    1.60 -# only. Doxygen will then generate output that is more tailored for C. 
    1.61 +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
    1.62 +# sources only. Doxygen will then generate output that is more tailored for C. 
    1.63  # For instance, some of the names that are used will be different. The list 
    1.64  # of all members will be omitted, etc.
    1.65  
    1.66 @@ -373,6 +374,16 @@
    1.67  
    1.68  SHOW_DIRECTORIES       = YES
    1.69  
    1.70 +# The FILE_VERSION_FILTER tag can be used to specify a program or script that 
    1.71 +# doxygen should invoke to get the current version for each file (typically from the 
    1.72 +# version control system). Doxygen will invoke the program by executing (via 
    1.73 +# popen()) the command <command> <input-file>, where <command> is the value of 
    1.74 +# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
    1.75 +# provided by doxygen. Whatever the progam writes to standard output 
    1.76 +# is used as the file version. See the manual for examples.
    1.77 +
    1.78 +FILE_VERSION_FILTER    = 
    1.79 +
    1.80  #---------------------------------------------------------------------------
    1.81  # configuration options related to warning and progress messages
    1.82  #---------------------------------------------------------------------------
    1.83 @@ -401,10 +412,20 @@
    1.84  
    1.85  WARN_IF_DOC_ERROR      = YES
    1.86  
    1.87 +# This WARN_NO_PARAMDOC option can be abled to get warnings for 
    1.88 +# functions that are documented, but have no documentation for their parameters 
    1.89 +# or return value. If set to NO (the default) doxygen will only warn about 
    1.90 +# wrong or incomplete parameter documentation, but not about the absence of 
    1.91 +# documentation.
    1.92 +
    1.93 +WARN_NO_PARAMDOC       = NO
    1.94 +
    1.95  # The WARN_FORMAT tag determines the format of the warning messages that 
    1.96  # doxygen can produce. The string should contain the $file, $line, and $text 
    1.97  # tags, which will be replaced by the file and line number from which the 
    1.98 -# warning originated and the warning text.
    1.99 +# warning originated and the warning text. Optionally the format may contain 
   1.100 +# $version, which will be replaced by the version of the file (if it could 
   1.101 +# be obtained via FILE_VERSION_FILTER)
   1.102  
   1.103  WARN_FORMAT            = "$file:$line: $text"
   1.104  
   1.105 @@ -425,13 +446,13 @@
   1.106  
   1.107  INPUT                  = mainpage.dox \
   1.108                           graphs.dox \
   1.109 -                         undir_graphs.dox \ 
   1.110 +                         undir_graphs.dox \
   1.111                           named-param.dox \
   1.112                           maps.dox \
   1.113                           coding_style.dox \
   1.114                           groups.dox \
   1.115                           namespaces.dox \
   1.116 -			 license.dox \
   1.117 +                         license.dox \
   1.118                           developpers_interface.dox \
   1.119                           ../src/lemon \
   1.120                           ../src/lemon/concept \
   1.121 @@ -441,8 +462,8 @@
   1.122  # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
   1.123  # and *.h) to filter out the source-files in the directories. If left 
   1.124  # blank the following patterns are tested: 
   1.125 -# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp 
   1.126 -# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
   1.127 +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
   1.128 +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
   1.129  
   1.130  FILE_PATTERNS          = 
   1.131  
   1.132 @@ -458,8 +479,9 @@
   1.133  
   1.134  EXCLUDE                = 
   1.135  
   1.136 -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories 
   1.137 -# that are symbolic links (a Unix filesystem feature) are excluded from the input.
   1.138 +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
   1.139 +# directories that are symbolic links (a Unix filesystem feature) are excluded 
   1.140 +# from the input.
   1.141  
   1.142  EXCLUDE_SYMLINKS       = NO
   1.143  
   1.144 @@ -473,7 +495,9 @@
   1.145  # directories that contain example code fragments that are included (see 
   1.146  # the \include command).
   1.147  
   1.148 -EXAMPLE_PATH           = ../src/demo ../LICENSE .
   1.149 +EXAMPLE_PATH           = ../src/demo \
   1.150 +                         ../LICENSE \
   1.151 +                         .
   1.152  
   1.153  # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
   1.154  # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
   1.155 @@ -982,8 +1006,8 @@
   1.156  # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
   1.157  # doxygen's preprocessor will remove all function-like macros that are alone 
   1.158  # on a line, have an all uppercase name, and do not end with a semicolon. Such 
   1.159 -# function macros are typically used for boiler-plate code, and will confuse the 
   1.160 -# parser if not removed.
   1.161 +# function macros are typically used for boiler-plate code, and will confuse 
   1.162 +# the parser if not removed.
   1.163  
   1.164  SKIP_FUNCTION_MACROS   = YES
   1.165  
   1.166 @@ -1035,10 +1059,11 @@
   1.167  #---------------------------------------------------------------------------
   1.168  
   1.169  # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
   1.170 -# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or 
   1.171 -# super classes. Setting the tag to NO turns the diagrams off. Note that this 
   1.172 -# option is superseded by the HAVE_DOT option below. This is only a fallback. It is 
   1.173 -# recommended to install and use dot, since it yields more powerful graphs.
   1.174 +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
   1.175 +# or super classes. Setting the tag to NO turns the diagrams off. Note that 
   1.176 +# this option is superseded by the HAVE_DOT option below. This is only a 
   1.177 +# fallback. It is recommended to install and use dot, since it yields more 
   1.178 +# powerful graphs.
   1.179  
   1.180  CLASS_DIAGRAMS         = YES
   1.181  
   1.182 @@ -1069,6 +1094,11 @@
   1.183  
   1.184  COLLABORATION_GRAPH    = YES
   1.185  
   1.186 +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
   1.187 +# will generate a graph for groups, showing the direct groups dependencies
   1.188 +
   1.189 +GROUP_GRAPHS           = YES
   1.190 +
   1.191  # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
   1.192  # collaboration diagrams in a style similar to the OMG's Unified Modeling 
   1.193  # Language.
   1.194 @@ -1107,6 +1137,13 @@
   1.195  
   1.196  GRAPHICAL_HIERARCHY    = YES
   1.197  
   1.198 +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
   1.199 +# then doxygen will show the dependencies a directory has on other directories 
   1.200 +# in a graphical way. The dependency relations are determined by the #include
   1.201 +# relations between the files in the directories.
   1.202 +
   1.203 +DIRECTORY_GRAPH        = YES
   1.204 +
   1.205  # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
   1.206  # generated by dot. Possible values are png, jpg, or gif
   1.207  # If left blank png will be used.
   1.208 @@ -1142,15 +1179,31 @@
   1.209  
   1.210  # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
   1.211  # graphs generated by dot. A depth value of 3 means that only nodes reachable 
   1.212 -# from the root by following a path via at most 3 edges will be shown. Nodes that 
   1.213 -# lay further from the root node will be omitted. Note that setting this option to 
   1.214 -# 1 or 2 may greatly reduce the computation time needed for large code bases. Also 
   1.215 -# note that a graph may be further truncated if the graph's image dimensions are 
   1.216 -# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). 
   1.217 -# If 0 is used for the depth value (the default), the graph is not depth-constrained.
   1.218 +# from the root by following a path via at most 3 edges will be shown. Nodes 
   1.219 +# that lay further from the root node will be omitted. Note that setting this 
   1.220 +# option to 1 or 2 may greatly reduce the computation time needed for large 
   1.221 +# code bases. Also note that a graph may be further truncated if the graph's 
   1.222 +# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH 
   1.223 +# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), 
   1.224 +# the graph is not depth-constrained.
   1.225  
   1.226  MAX_DOT_GRAPH_DEPTH    = 0
   1.227  
   1.228 +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
   1.229 +# background. This is disabled by default, which results in a white background. 
   1.230 +# Warning: Depending on the platform used, enabling this option may lead to 
   1.231 +# badly anti-aliased labels on the edges of a graph (i.e. they become hard to 
   1.232 +# read).
   1.233 +
   1.234 +DOT_TRANSPARENT        = NO
   1.235 +
   1.236 +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
   1.237 +# files in one run (i.e. multiple -o and -T options on the command line). This 
   1.238 +# makes dot run faster, but since only newer versions of dot (>1.8.10) 
   1.239 +# support this, this feature is disabled by default.
   1.240 +
   1.241 +DOT_MULTI_TARGETS      = NO
   1.242 +
   1.243  # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
   1.244  # generate a legend page explaining the meaning of the various boxes and 
   1.245  # arrows in the dot generated graphs.