COIN-OR::LEMON - Graph Library

Changeset 1063:d53a12d49262 in lemon-0.x for doc


Ignore:
Timestamp:
01/09/05 21:06:57 (15 years ago)
Author:
Mihaly Barasz
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1459
Message:

Doxyfile updated to doxygen v1.4.0

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/Doxyfile

    r1030 r1063  
    1 # Doxyfile 1.3.9
     1# Doxyfile 1.4.0
    22
    33# This file describes the settings to be used by the documentation system
     
    3636# 4096 sub-directories (in 2 levels) under the output directory of each output
    3737# format and will distribute the generated files over these directories.
    38 # Enabling this option can be useful when feeding doxygen a huge amount of source
    39 # files, where putting all generated files in the same directory would otherwise
    40 # cause performance problems for the file system.
     38# Enabling this option can be useful when feeding doxygen a huge amount of
     39# source files, where putting all generated files in the same directory would
     40# otherwise cause performance problems for the file system.
    4141
    4242CREATE_SUBDIRS         = NO
     
    8181# that is used to form the text in various listings. Each string
    8282# in this list, if found as the leading text of the brief description, will be
    83 # stripped from the text and the result after processing the whole list, is used
    84 # as the annotated text. Otherwise, the brief description is used as-is. If left
    85 # blank, the following values are used ("$name" is automatically replaced with the
    86 # name of the entity): "The $name class" "The $name widget" "The $name file"
    87 # "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
     83# stripped from the text and the result after processing the whole list, is
     84# used as the annotated text. Otherwise, the brief description is used as-is.
     85# If left blank, the following values are used ("$name" is automatically
     86# replaced with the name of the entity): "The $name class" "The $name widget"
     87# "The $name file" "is" "provides" "specifies" "contains"
     88# "represents" "a" "an" "the"
    8889
    8990ABBREVIATE_BRIEF       =
     
    9596ALWAYS_DETAILED_SEC    = NO
    9697
    97 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
    98 # members of a class in the documentation of that class as if those members were
    99 # ordinary class members. Constructors, destructors and assignment operators of
    100 # the base classes will not be shown.
     98# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
     99# inherited members of a class in the documentation of that class as if those
     100# members were ordinary class members. Constructors, destructors and assignment
     101# operators of the base classes will not be shown.
    101102
    102103INLINE_INHERITED_MEMB  = NO
     
    182183ALIASES                =
    183184
    184 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
    185 # only. Doxygen will then generate output that is more tailored for C.
     185# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
     186# sources only. Doxygen will then generate output that is more tailored for C.
    186187# For instance, some of the names that are used will be different. The list
    187188# of all members will be omitted, etc.
     
    374375SHOW_DIRECTORIES       = YES
    375376
     377# The FILE_VERSION_FILTER tag can be used to specify a program or script that
     378# doxygen should invoke to get the current version for each file (typically from the
     379# version control system). Doxygen will invoke the program by executing (via
     380# popen()) the command <command> <input-file>, where <command> is the value of
     381# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
     382# provided by doxygen. Whatever the progam writes to standard output
     383# is used as the file version. See the manual for examples.
     384
     385FILE_VERSION_FILTER    =
     386
    376387#---------------------------------------------------------------------------
    377388# configuration options related to warning and progress messages
     
    402413WARN_IF_DOC_ERROR      = YES
    403414
     415# This WARN_NO_PARAMDOC option can be abled to get warnings for
     416# functions that are documented, but have no documentation for their parameters
     417# or return value. If set to NO (the default) doxygen will only warn about
     418# wrong or incomplete parameter documentation, but not about the absence of
     419# documentation.
     420
     421WARN_NO_PARAMDOC       = NO
     422
    404423# The WARN_FORMAT tag determines the format of the warning messages that
    405424# doxygen can produce. The string should contain the $file, $line, and $text
    406425# tags, which will be replaced by the file and line number from which the
    407 # warning originated and the warning text.
     426# warning originated and the warning text. Optionally the format may contain
     427# $version, which will be replaced by the version of the file (if it could
     428# be obtained via FILE_VERSION_FILTER)
    408429
    409430WARN_FORMAT            = "$file:$line: $text"
     
    426447INPUT                  = mainpage.dox \
    427448                         graphs.dox \
    428                          undir_graphs.dox \ 
     449                         undir_graphs.dox \
    429450                         named-param.dox \
    430451                         maps.dox \
     
    432453                         groups.dox \
    433454                         namespaces.dox \
    434                         license.dox \
     455                        license.dox \
    435456                         developpers_interface.dox \
    436457                         ../src/lemon \
     
    442463# and *.h) to filter out the source-files in the directories. If left
    443464# blank the following patterns are tested:
    444 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
    445 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
     465# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
     466# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
    446467
    447468FILE_PATTERNS          =
     
    459480EXCLUDE                =
    460481
    461 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
    462 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
     482# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
     483# directories that are symbolic links (a Unix filesystem feature) are excluded
     484# from the input.
    463485
    464486EXCLUDE_SYMLINKS       = NO
     
    474496# the \include command).
    475497
    476 EXAMPLE_PATH           = ../src/demo ../LICENSE .
     498EXAMPLE_PATH           = ../src/demo \
     499                         ../LICENSE \
     500                         .
    477501
    478502# If the value of the EXAMPLE_PATH tag contains directories, you can use the
     
    9831007# doxygen's preprocessor will remove all function-like macros that are alone
    9841008# on a line, have an all uppercase name, and do not end with a semicolon. Such
    985 # function macros are typically used for boiler-plate code, and will confuse the
    986 # parser if not removed.
     1009# function macros are typically used for boiler-plate code, and will confuse
     1010# the parser if not removed.
    9871011
    9881012SKIP_FUNCTION_MACROS   = YES
     
    10361060
    10371061# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
    1038 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
    1039 # super classes. Setting the tag to NO turns the diagrams off. Note that this
    1040 # option is superseded by the HAVE_DOT option below. This is only a fallback. It is
    1041 # recommended to install and use dot, since it yields more powerful graphs.
     1062# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
     1063# or super classes. Setting the tag to NO turns the diagrams off. Note that
     1064# this option is superseded by the HAVE_DOT option below. This is only a
     1065# fallback. It is recommended to install and use dot, since it yields more
     1066# powerful graphs.
    10421067
    10431068CLASS_DIAGRAMS         = YES
     
    10691094
    10701095COLLABORATION_GRAPH    = YES
     1096
     1097# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
     1098# will generate a graph for groups, showing the direct groups dependencies
     1099
     1100GROUP_GRAPHS           = YES
    10711101
    10721102# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
     
    11081138GRAPHICAL_HIERARCHY    = YES
    11091139
     1140# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
     1141# then doxygen will show the dependencies a directory has on other directories
     1142# in a graphical way. The dependency relations are determined by the #include
     1143# relations between the files in the directories.
     1144
     1145DIRECTORY_GRAPH        = YES
     1146
    11101147# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
    11111148# generated by dot. Possible values are png, jpg, or gif
     
    11431180# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
    11441181# graphs generated by dot. A depth value of 3 means that only nodes reachable
    1145 # from the root by following a path via at most 3 edges will be shown. Nodes that
    1146 # lay further from the root node will be omitted. Note that setting this option to
    1147 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also
    1148 # note that a graph may be further truncated if the graph's image dimensions are
    1149 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
    1150 # If 0 is used for the depth value (the default), the graph is not depth-constrained.
     1182# from the root by following a path via at most 3 edges will be shown. Nodes
     1183# that lay further from the root node will be omitted. Note that setting this
     1184# option to 1 or 2 may greatly reduce the computation time needed for large
     1185# code bases. Also note that a graph may be further truncated if the graph's
     1186# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
     1187# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
     1188# the graph is not depth-constrained.
    11511189
    11521190MAX_DOT_GRAPH_DEPTH    = 0
     1191
     1192# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
     1193# background. This is disabled by default, which results in a white background.
     1194# Warning: Depending on the platform used, enabling this option may lead to
     1195# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
     1196# read).
     1197
     1198DOT_TRANSPARENT        = NO
     1199
     1200# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
     1201# files in one run (i.e. multiple -o and -T options on the command line). This
     1202# makes dot run faster, but since only newer versions of dot (>1.8.10)
     1203# support this, this feature is disabled by default.
     1204
     1205DOT_MULTI_TARGETS      = NO
    11531206
    11541207# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
Note: See TracChangeset for help on using the changeset viewer.