COIN-OR::LEMON - Graph Library

Ticket #79: doxyfile.patch

File doxyfile.patch, 17.0 KB (added by Akos Ladanyi, 11 years ago)
  • doc/Doxyfile.in

    # HG changeset patch
    # User Akos Ladanyi <ladanyi@tmit.bme.hu>
    # Date 1208881015 -7200
    # Node ID e650362714ae17f49cdb4c12aff2749a04fe6f73
    # Parent  24d495be695528849d0c607cfb405bc93390a7df
    Updated Doxyfile.in (using 'doxygen -u').
    
    diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
    a b  
    1 # Doxyfile 1.4.2
     1# Doxyfile 1.5.3
    22
    33# This file describes the settings to be used by the documentation system
    44# doxygen (www.doxygen.org) for a project
     
    1313#---------------------------------------------------------------------------
    1414# Project related configuration options
    1515#---------------------------------------------------------------------------
     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
     23DOXYFILE_ENCODING      = UTF-8
    1624
    1725# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
    1826# by quotes) that should identify the project.
     
    4553# documentation generated by doxygen is written. Doxygen will use this
    4654# information to generate all constant output in the proper language.
    4755# The default language is English, other supported languages are:
    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.
     56# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
     57# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,
     58# Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
     59# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
     60# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
    5361
    5462OUTPUT_LANGUAGE        = English
    55 
    56 # This tag can be used to specify the encoding used in the generated output.
    57 # The encoding is not always determined by the language that is chosen,
    58 # but also whether or not the output is meant for Windows or non-Windows users.
    59 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
    60 # forces the Windows encoding (this is the default for the Windows binary),
    61 # whereas setting the tag to NO uses a Unix-style encoding (the default for
    62 # all platforms other than Windows).
    63 
    64 USE_WINDOWS_ENCODING   = NO
    6563
    6664# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
    6765# include brief member descriptions after the members that are listed in
     
    135133# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
    136134# will interpret the first line (until the first dot) of a JavaDoc-style
    137135# comment as the brief description. If set to NO, the JavaDoc
    138 # comments will behave just like the Qt-style comments (thus requiring an
    139 # explicit @brief command for a brief description.
     136# comments will behave just like regular Qt-style comments
     137# (thus requiring an explicit @brief command for a brief description.)
    140138
    141139JAVADOC_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
     147QT_AUTOBRIEF           = NO
    142148
    143149# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
    144150# treat a multi-line C++ special comment block (i.e. a block of //! or ///
     
    160166# re-implements.
    161167
    162168INHERIT_DOCS           = NO
    163 
    164 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
    165 # tag is set to YES, then doxygen will reuse the documentation of the first
    166 # member in the group (if any) for the other members of the group. By default
    167 # all members of a group must be documented explicitly.
    168 
    169 DISTRIBUTE_GROUP_DOC   = NO
    170169
    171170# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
    172171# a new page for each member. If set to NO, the documentation of a member will
     
    195194
    196195OPTIMIZE_OUTPUT_FOR_C  = NO
    197196
    198 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
    199 # only. Doxygen will then generate output that is more tailored for Java.
     197# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
     198# sources only. Doxygen will then generate output that is more tailored for Java.
    200199# For instance, namespaces will be presented as packages, qualified scopes
    201200# will look different, etc.
    202201
    203202OPTIMIZE_OUTPUT_JAVA   = NO
     203
     204# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
     205# include (a tag file for) the STL sources as input, then you should
     206# set this tag to YES in order to let doxygen match functions declarations and
     207# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
     208# func(std::string) {}). This also make the inheritance and collaboration
     209# diagrams that involve STL classes more complete and accurate.
     210
     211BUILTIN_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
     216CPP_CLI_SUPPORT        = NO
     217
     218# 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
     220# member in the group (if any) for the other members of the group. By default
     221# all members of a group must be documented explicitly.
     222
     223DISTRIBUTE_GROUP_DOC   = NO
    204224
    205225# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
    206226# the same type (for instance a group of public functions) to be put as a
     
    244264
    245265EXTRACT_LOCAL_METHODS  = NO
    246266
     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
     272EXTRACT_ANON_NSPACES   = NO
     273
    247274# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
    248275# undocumented members of documented classes, files or namespaces.
    249276# If set to NO (the default) these members will be included in the
     
    278305# to NO (the default) then the documentation will be excluded.
    279306# Set it to YES to include the internal documentation.
    280307
    281 INTERNAL_DOCS          = @DOXYGEN_INTERNAL_DOCS@
     308INTERNAL_DOCS          = NO
    282309
    283310# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
    284311# file names in lower-case letters. If set to YES upper-case letters are also
     
    376403
    377404# If the sources in your project are distributed over multiple directories
    378405# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
    379 # in the documentation.
     406# in the documentation. The default is NO.
    380407
    381408SHOW_DIRECTORIES       = YES
    382409
     
    385412# version control system). Doxygen will invoke the program by executing (via
    386413# popen()) the command <command> <input-file>, where <command> is the value of
    387414# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
    388 # provided by doxygen. Whatever the progam writes to standard output
     415# provided by doxygen. Whatever the program writes to standard output
    389416# is used as the file version. See the manual for examples.
    390417
    391418FILE_VERSION_FILTER    =
     
    433460# $version, which will be replaced by the version of the file (if it could
    434461# be obtained via FILE_VERSION_FILTER)
    435462
    436 WARN_FORMAT            = "$file:$line: $text"
     463WARN_FORMAT            = "$file:$line: $text  "
    437464
    438465# The WARN_LOGFILE tag can be used to specify a file to which warning
    439466# and error messages should be written. If left blank the output is written
     
    458485                         @abs_top_srcdir@/tools \
    459486                         @abs_top_srcdir@/test/test_tools.h
    460487
     488# This tag can be used to specify the character encoding of the source files that
     489# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
     490# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
     491# See http://www.gnu.org/software/libiconv for the list of possible encodings.
     492
     493INPUT_ENCODING         = UTF-8
     494
    461495# If the value of the INPUT tag contains directories, you can use the
    462496# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
    463497# and *.h) to filter out the source-files in the directories. If left
    464498# blank the following patterns are tested:
    465499# *.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
     500# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
    467501
    468 FILE_PATTERNS          = *.h *.cc *.dox
     502FILE_PATTERNS          = *.h \
     503                         *.cc \
     504                         *.dox
    469505
    470506# The RECURSIVE tag can be used to turn specify whether or not subdirectories
    471507# should be searched for input files as well. Possible values are YES and NO.
     
    487523
    488524# If the value of the INPUT tag contains directories, you can use the
    489525# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
    490 # certain files from those directories.
     526# certain files from those directories. Note that the wildcards are matched
     527# against the file with absolute path, so to exclude all test directories
     528# for example use the pattern */test/*
    491529
    492530EXCLUDE_PATTERNS       =
     531
     532# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
     533# (namespaces, classes, functions, etc.) that should be excluded from the output.
     534# The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
     535# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
     536
     537EXCLUDE_SYMBOLS        =
    493538
    494539# The EXAMPLE_PATH tag can be used to specify one or more files or
    495540# directories that contain example code fragments that are included (see
     
    551596# If the SOURCE_BROWSER tag is set to YES then a list of source files will
    552597# be generated. Documented entities will be cross-referenced with these sources.
    553598# Note: To get rid of all source code in the generated output, make sure also
    554 # VERBATIM_HEADERS is set to NO.
     599# VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH
     600# then you must also enable this option. If you don't then doxygen will produce
     601# a warning and turn it on anyway
    555602
    556603SOURCE_BROWSER         = NO
    557604
     
    577624# called/used by that function will be listed.
    578625
    579626REFERENCES_RELATION    = NO
     627
     628# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
     629# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
     630# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
     631# link to the source code.  Otherwise they will link to the documentstion.
     632
     633REFERENCES_LINK_SOURCE = YES
     634
     635# If the USE_HTAGS tag is set to YES then the references to source code
     636# will point to the HTML generated by the htags(1) tool instead of doxygen
     637# built-in source browser. The htags tool is part of GNU's global source
     638# tagging system (see http://www.gnu.org/software/global/global.html). You
     639# will need version 4.8.6 or higher.
     640
     641USE_HTAGS              = NO
    580642
    581643# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
    582644# will generate a verbatim copy of the header file for each class for
     
    661723# of the generated HTML documentation.
    662724
    663725GENERATE_HTMLHELP      = NO
     726
     727# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
     728# documentation will contain sections that can be hidden and shown after the
     729# page has loaded. For this to work a browser that supports
     730# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
     731# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
     732
     733HTML_DYNAMIC_SECTIONS  = NO
    664734
    665735# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
    666736# be used to specify the file name of the resulting .chm file. You
     
    9651035
    9661036# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
    9671037# then the macro expansion is limited to the macros specified with the
    968 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
     1038# PREDEFINED and EXPAND_AS_DEFINED tags.
    9691039
    9701040EXPAND_ONLY_PREDEF     = NO
    9711041
     
    10311101# If a tag file is not located in the directory in which doxygen
    10321102# is run, you must also specify the path to the tagfile here.
    10331103
    1034 TAGFILES               = "@abs_top_srcdir@/doc/libstdc++.tag = http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/"
     1104TAGFILES               = "@abs_top_srcdir@/doc/libstdc++.tag = http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/  "
    10351105
    10361106# When a file name is specified after GENERATE_TAGFILE, doxygen will create
    10371107# a tag file that is based on the input files it reads.
     
    10671137# powerful graphs.
    10681138
    10691139CLASS_DIAGRAMS         = NO
     1140
     1141# You can define message sequence charts within doxygen comments using the \msc
     1142# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
     1143# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
     1144# specify the directory where the mscgen tool resides. If left empty the tool is assumed to
     1145# be found in the default search path.
     1146
     1147MSCGEN_PATH            =
    10701148
    10711149# If set to YES, the inheritance and collaboration graphs will hide
    10721150# inheritance and usage relations if the target is undocumented
     
    11251203
    11261204INCLUDED_BY_GRAPH      = NO
    11271205
    1128 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
     1206# If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
    11291207# generate a call dependency graph for every global function or class method.
    11301208# Note that enabling this option will significantly increase the time of a run.
    11311209# So in most cases it will be better to enable call graphs for selected
    11321210# functions only using the \callgraph command.
    11331211
    11341212CALL_GRAPH             = NO
     1213
     1214# If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
     1215# generate a caller dependency graph for every global function or class method.
     1216# Note that enabling this option will significantly increase the time of a run.
     1217# So in most cases it will be better to enable caller graphs for selected
     1218# functions only using the \callergraph command.
     1219
     1220CALLER_GRAPH           = NO
    11351221
    11361222# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
    11371223# will graphical hierarchy of all classes instead of a textual one.
     
    11621248
    11631249DOTFILE_DIRS           =
    11641250
    1165 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
    1166 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
    1167 # this value, doxygen will try to truncate the graph, so that it fits within
    1168 # the specified constraint. Beware that most browsers cannot cope with very
    1169 # large images.
     1251# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
     1252# nodes that will be shown in the graph. If the number of nodes in a graph
     1253# becomes larger than this value, doxygen will truncate the graph, which is
     1254# visualized by representing a node as a red box. Note that doxygen if the number
     1255# of direct children of the root node in a graph is already larger than
     1256# MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note
     1257# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
    11701258
    1171 MAX_DOT_GRAPH_WIDTH    = 1024
    1172 
    1173 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
    1174 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
    1175 # this value, doxygen will try to truncate the graph, so that it fits within
    1176 # the specified constraint. Beware that most browsers cannot cope with very
    1177 # large images.
    1178 
    1179 MAX_DOT_GRAPH_HEIGHT   = 1024
     1259DOT_GRAPH_MAX_NODES    = 50
    11801260
    11811261# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
    11821262# graphs generated by dot. A depth value of 3 means that only nodes reachable
    11831263# from the root by following a path via at most 3 edges will be shown. Nodes
    11841264# that lay further from the root node will be omitted. Note that setting this
    11851265# option to 1 or 2 may greatly reduce the computation time needed for large
    1186 # code bases. Also note that a graph may be further truncated if the graph's
    1187 # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
    1188 # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
    1189 # the graph is not depth-constrained.
     1266# code bases. Also note that the size of a graph can be further restricted by
     1267# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
    11901268
    11911269MAX_DOT_GRAPH_DEPTH    = 0
    11921270