COIN-OR::LEMON - Graph Library

Changeset 1065:340fe3cbb145 in lemon-0.x for src


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

update to doxygen v1.4.0

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/work/Doxyfile

    r1050 r1065  
    1 # Doxyfile 1.3.6
     1# Doxyfile 1.4.0
    22
    33# This file describes the settings to be used by the documentation system
     
    3333OUTPUT_DIRECTORY       =
    3434
     35# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
     36# 4096 sub-directories (in 2 levels) under the output directory of each output
     37# format and will distribute the generated files over these directories.
     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.
     41
     42CREATE_SUBDIRS         = NO
     43
    3544# The OUTPUT_LANGUAGE tag is used to specify the language in which all
    3645# documentation generated by doxygen is written. Doxygen will use this
    3746# information to generate all constant output in the proper language.
    3847# The default language is English, other supported languages are:
    39 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
    40 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
    41 # (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese,
    42 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
     48# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
     49# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
     50# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
     51# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
     52# Swedish, and Ukrainian.
    4353
    4454OUTPUT_LANGUAGE        = English
     
    7181# that is used to form the text in various listings. Each string
    7282# in this list, if found as the leading text of the brief description, will be
    73 # stripped from the text and the result after processing the whole list, is used
    74 # as the annotated text. Otherwise, the brief description is used as-is. If left
    75 # blank, the following values are used ("$name" is automatically replaced with the
    76 # name of the entity): "The $name class" "The $name widget" "The $name file"
    77 # "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"
    7889
    7990ABBREVIATE_BRIEF       =
     
    8596ALWAYS_DETAILED_SEC    = NO
    8697
    87 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
    88 # members of a class in the documentation of that class as if those members were
    89 # ordinary class members. Constructors, destructors and assignment operators of
    90 # 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.
    91102
    92103INLINE_INHERITED_MEMB  = NO
     
    101112# can be used to strip a user-defined part of the path. Stripping is
    102113# only done if one of the specified strings matches the left-hand part of
    103 # the path. It is allowed to use relative paths in the argument list.
     114# the path. The tag can be used to show relative paths in the file list.
    104115# If left blank the directory from which doxygen is run is used as the
    105116# path to strip.
    106117
    107118STRIP_FROM_PATH        =
     119
     120# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
     121# the path mentioned in the documentation of a class, which tells
     122# the reader which header file to include in order to use a class.
     123# If left blank only the name of the header file containing the class
     124# definition is used. Otherwise one should specify the include paths that
     125# are normally passed to the compiler using the -I flag.
     126
     127STRIP_FROM_INC_PATH    =
    108128
    109129# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
     
    163183ALIASES                =
    164184
    165 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
    166 # 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.
    167187# For instance, some of the names that are used will be different. The list
    168188# of all members will be omitted, etc.
     
    212232EXTRACT_LOCAL_CLASSES  = YES
    213233
     234# This flag is only useful for Objective-C code. When set to YES local
     235# methods, which are defined in the implementation section but not in
     236# the interface are included in the documentation.
     237# If set to NO (the default) only methods in the interface are included.
     238
     239EXTRACT_LOCAL_METHODS  = NO
     240
    214241# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
    215242# undocumented members of documented classes, files or namespaces.
     
    252279# allowed. This is useful if you have classes or files whose names only differ
    253280# in case and if your file system supports case sensitive file names. Windows
    254 # users are advised to set this option to NO.
     281# and Mac users are advised to set this option to NO.
    255282
    256283CASE_SENSE_NAMES       = YES
     
    342369SHOW_USED_FILES        = YES
    343370
     371# If the sources in your project are distributed over multiple directories
     372# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
     373# in the documentation.
     374
     375SHOW_DIRECTORIES       = YES
     376
     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
    344387#---------------------------------------------------------------------------
    345388# configuration options related to warning and progress messages
     
    370413WARN_IF_DOC_ERROR      = YES
    371414
     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
    372423# The WARN_FORMAT tag determines the format of the warning messages that
    373424# doxygen can produce. The string should contain the $file, $line, and $text
    374425# tags, which will be replaced by the file and line number from which the
    375 # 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)
    376429
    377430WARN_FORMAT            = "$file:$line: $text"
     
    393446
    394447INPUT                  = ../../doc/mainpage.dox \
    395                          ../../doc/graphs.dox \
    396                          ../../doc/maps.dox ../../doc/coding_style.dox \
     448                         ../../doc/graphs.dox \
     449                         ../../doc/maps.dox \
     450                         ../../doc/coding_style.dox \
    397451                         ../../doc/groups.dox \
    398452                         ../lemon \
     
    401455                         klao/debug.h \
    402456                         jacint/max_flow.h \
    403                          jacint/max_matching.h \ 
    404                         marci/bfs_dfs.h \
    405                         marci/bfs_dfs_misc.h \
     457                         jacint/max_matching.h \
     458                        marci/bfs_dfs.h \
     459                        marci/bfs_dfs_misc.h \
    406460                         marci/lp/lp_solver_wrapper.h \
    407                          jacint/graph_gen.h \
    408                          marci/max_bipartite_matching.h \
    409                          marci/bipartite_graph_wrapper.h \
    410                          alpar/graph_to_eps.cc \
    411                          deba \
    412                          
     461                         jacint/graph_gen.h \
     462                         marci/max_bipartite_matching.h \
     463                         marci/bipartite_graph_wrapper.h \
     464                         alpar/graph_to_eps.cc \
     465                         deba
    413466
    414467# If the value of the INPUT tag contains directories, you can use the
     
    416469# and *.h) to filter out the source-files in the directories. If left
    417470# blank the following patterns are tested:
    418 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
    419 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
     471# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
     472# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
    420473
    421474FILE_PATTERNS          =
     
    433486EXCLUDE                =
    434487
    435 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
    436 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
     488# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
     489# directories that are symbolic links (a Unix filesystem feature) are excluded
     490# from the input.
    437491
    438492EXCLUDE_SYMLINKS       = NO
     
    475529# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
    476530# input file. Doxygen will then use the output that the filter program writes
    477 # to standard output.
     531# to standard output.  If FILTER_PATTERNS is specified, this tag will be
     532# ignored.
    478533
    479534INPUT_FILTER           =
     535
     536# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
     537# basis.  Doxygen will compare the file name with each pattern and apply the
     538# filter if there is a match.  The filters are a list of the form:
     539# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
     540# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
     541# is applied to all files.
     542
     543FILTER_PATTERNS        =
    480544
    481545# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
     
    931995# gcc). The argument of the tag is a list of macros of the form: name
    932996# or name=definition (no spaces). If the definition and the = are
    933 # omitted =1 is assumed.
     997# omitted =1 is assumed. To prevent a macro definition from being
     998# undefined via #undef or recursively expanded use the := operator
     999# instead of the = operator.
    9341000
    9351001PREDEFINED             = DOXYGEN
     
    9451011# doxygen's preprocessor will remove all function-like macros that are alone
    9461012# on a line, have an all uppercase name, and do not end with a semicolon. Such
    947 # function macros are typically used for boiler-plate code, and will confuse the
    948 # parser if not removed.
     1013# function macros are typically used for boiler-plate code, and will confuse
     1014# the parser if not removed.
    9491015
    9501016SKIP_FUNCTION_MACROS   = YES
     
    9981064
    9991065# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
    1000 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
    1001 # super classes. Setting the tag to NO turns the diagrams off. Note that this
    1002 # option is superseded by the HAVE_DOT option below. This is only a fallback. It is
    1003 # recommended to install and use dot, since it yields more powerful graphs.
     1066# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
     1067# or super classes. Setting the tag to NO turns the diagrams off. Note that
     1068# this option is superseded by the HAVE_DOT option below. This is only a
     1069# fallback. It is recommended to install and use dot, since it yields more
     1070# powerful graphs.
    10041071
    10051072CLASS_DIAGRAMS         = YES
     
    10311098
    10321099COLLABORATION_GRAPH    = YES
     1100
     1101# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
     1102# will generate a graph for groups, showing the direct groups dependencies
     1103
     1104GROUP_GRAPHS           = YES
    10331105
    10341106# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
     
    10701142GRAPHICAL_HIERARCHY    = YES
    10711143
     1144# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
     1145# then doxygen will show the dependencies a directory has on other directories
     1146# in a graphical way. The dependency relations are determined by the #include
     1147# relations between the files in the directories.
     1148
     1149DIRECTORY_GRAPH        = YES
     1150
    10721151# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
    10731152# generated by dot. Possible values are png, jpg, or gif
     
    11051184# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
    11061185# graphs generated by dot. A depth value of 3 means that only nodes reachable
    1107 # from the root by following a path via at most 3 edges will be shown. Nodes that
    1108 # lay further from the root node will be omitted. Note that setting this option to
    1109 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also
    1110 # note that a graph may be further truncated if the graph's image dimensions are
    1111 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
    1112 # If 0 is used for the depth value (the default), the graph is not depth-constrained.
     1186# from the root by following a path via at most 3 edges will be shown. Nodes
     1187# that lay further from the root node will be omitted. Note that setting this
     1188# option to 1 or 2 may greatly reduce the computation time needed for large
     1189# code bases. Also note that a graph may be further truncated if the graph's
     1190# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
     1191# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
     1192# the graph is not depth-constrained.
    11131193
    11141194MAX_DOT_GRAPH_DEPTH    = 0
     1195
     1196# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
     1197# background. This is disabled by default, which results in a white background.
     1198# Warning: Depending on the platform used, enabling this option may lead to
     1199# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
     1200# read).
     1201
     1202DOT_TRANSPARENT        = NO
     1203
     1204# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
     1205# files in one run (i.e. multiple -o and -T options on the command line). This
     1206# makes dot run faster, but since only newer versions of dot (>1.8.10)
     1207# support this, this feature is disabled by default.
     1208
     1209DOT_MULTI_TARGETS      = NO
    11151210
    11161211# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
Note: See TracChangeset for help on using the changeset viewer.