* doc/Doxyfile.in: Update for Doxygen 1.4.0, set

DOT_MULTI_TARGETS, and disable GROUP_GRAPH (it causes segfault).
* src/tgbaparse/public.hh (format_tgba_parse_errors): Complete
Doxygen comment.

ChangeLog

@@ -1,5 +1,10 @@
 2005-01-03  Alexandre Duret-Lutz  <adl@src.lip6.fr>
 
+	* doc/Doxyfile.in: Update for Doxygen 1.4.0, set
+	DOT_MULTI_TARGETS, and disable GROUP_GRAPH (it causes segfault).
+	* src/tgbaparse/public.hh (format_tgba_parse_errors): Complete
+	Doxygen comment.
+
 	* src/tgbaalgos/emptiness_stats.hh (ars_statistics): New class.
 	* src/tgbaalgos/ndfs_result.hh (ndfs_result): Inherit from
 	ars_statistics.

HACKING

@@ -15,7 +15,7 @@ generally if you plan to regenerate some of the generated files.
   GNU Flex (the version probably doesn't matter much, we used 2.5.31)
   The CVS version of GNU Bison (called 1.875c at the time of writing)
   SWIG >= 1.3.23
-  Doxygen >= 1.3.5
+  Doxygen >= 1.4.0
 
 Bootstrap the CVS tree by running
 

doc/Doxyfile.in

@@ -1,4 +1,4 @@
-# Doxyfile 1.3.9
+# Doxyfile 1.4.0
 
 # This file describes the settings to be used by the documentation system
 # doxygen (www.doxygen.org) for a project
@@ -35,9 +35,9 @@ OUTPUT_DIRECTORY       = .
 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
 # 4096 sub-directories (in 2 levels) under the output directory of each output
 # format and will distribute the generated files over these directories.
-# Enabling this option can be useful when feeding doxygen a huge amount of source
+# Enabling this option can be useful when feeding doxygen a huge amount of
-# files, where putting all generated files in the same directory would otherwise
+# source files, where putting all generated files in the same directory would
-# cause performance problems for the file system.
+# otherwise cause performance problems for the file system.
 
 CREATE_SUBDIRS         = NO
 
@@ -80,11 +80,12 @@ REPEAT_BRIEF           = YES
 # This tag implements a quasi-intelligent brief description abbreviator
 # that is used to form the text in various listings. Each string
 # in this list, if found as the leading text of the brief description, will be
-# stripped from the text and the result after processing the whole list, is used
+# stripped from the text and the result after processing the whole list, is
-# as the annotated text. Otherwise, the brief description is used as-is. If left
+# used as the annotated text. Otherwise, the brief description is used as-is.
-# blank, the following values are used ("$name" is automatically replaced with the
+# If left blank, the following values are used ("$name" is automatically
-# name of the entity): "The $name class" "The $name widget" "The $name file"
+# replaced with the name of the entity): "The $name class" "The $name widget"
-# "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
+# "The $name file" "is" "provides" "specifies" "contains"
+# "represents" "a" "an" "the"
 
 ABBREVIATE_BRIEF       =
 
@@ -94,10 +95,10 @@ ABBREVIATE_BRIEF       =
 
 ALWAYS_DETAILED_SEC    = YES
 
-# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
-# members of a class in the documentation of that class as if those members were
+# inherited members of a class in the documentation of that class as if those
-# ordinary class members. Constructors, destructors and assignment operators of
+# members were ordinary class members. Constructors, destructors and assignment
-# the base classes will not be shown.
+# operators of the base classes will not be shown.
 
 INLINE_INHERITED_MEMB  = YES
 
@@ -184,8 +185,8 @@ TAB_SIZE               = 8
 
 ALIASES                =
 
-# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
-# only. Doxygen will then generate output that is more tailored for C.
+# sources only. Doxygen will then generate output that is more tailored for C.
 # For instance, some of the names that are used will be different. The list
 # of all members will be omitted, etc.
 
@@ -376,6 +377,16 @@ SHOW_USED_FILES        = YES
 
 SHOW_DIRECTORIES       = YES
 
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
+# doxygen should invoke to get the current version for each file (typically from the
+# version control system). Doxygen will invoke the program by executing (via
+# popen()) the command <command> <input-file>, where <command> is the value of
+# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
+# provided by doxygen. Whatever the progam writes to standard output
+# is used as the file version. See the manual for examples.
+
+FILE_VERSION_FILTER    =
+
 #---------------------------------------------------------------------------
 # configuration options related to warning and progress messages
 #---------------------------------------------------------------------------
@@ -404,10 +415,20 @@ WARN_IF_UNDOCUMENTED   = YES
 
 WARN_IF_DOC_ERROR      = YES
 
+# This WARN_NO_PARAMDOC option can be abled to get warnings for
+# functions that are documented, but have no documentation for their parameters
+# or return value. If set to NO (the default) doxygen will only warn about
+# wrong or incomplete parameter documentation, but not about the absence of
+# documentation.
+
+WARN_NO_PARAMDOC       = NO
+
 # The WARN_FORMAT tag determines the format of the warning messages that
 # doxygen can produce. The string should contain the $file, $line, and $text
 # tags, which will be replaced by the file and line number from which the
-# warning originated and the warning text.
+# warning originated and the warning text. Optionally the format may contain
+# $version, which will be replaced by the version of the file (if it could
+# be obtained via FILE_VERSION_FILTER)
 
 WARN_FORMAT            = "$file:$line: $text"
 
@@ -434,8 +455,8 @@ INPUT                  = @srcdir@/mainpage.dox \
 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
 # and *.h) to filter out the source-files in the directories. If left
 # blank the following patterns are tested:
-# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
+# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
-# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
+# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
 
 FILE_PATTERNS          = *.hh \
                          *.hxx
@@ -452,8 +473,9 @@ RECURSIVE              = YES
 
 EXCLUDE                =
 
-# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
-# that are symbolic links (a Unix filesystem feature) are excluded from the input.
+# directories that are symbolic links (a Unix filesystem feature) are excluded
+# from the input.
 
 EXCLUDE_SYMLINKS       = YES
 
@@ -980,8 +1002,8 @@ EXPAND_AS_DEFINED      =
 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
 # doxygen's preprocessor will remove all function-like macros that are alone
 # on a line, have an all uppercase name, and do not end with a semicolon. Such
-# function macros are typically used for boiler-plate code, and will confuse the
+# function macros are typically used for boiler-plate code, and will confuse
-# parser if not removed.
+# the parser if not removed.
 
 SKIP_FUNCTION_MACROS   = YES
 
@@ -1033,10 +1055,11 @@ PERL_PATH              = /usr/bin/perl
 #---------------------------------------------------------------------------
 
 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
-# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
+# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
-# super classes. Setting the tag to NO turns the diagrams off. Note that this
+# or super classes. Setting the tag to NO turns the diagrams off. Note that
-# option is superseded by the HAVE_DOT option below. This is only a fallback. It is
+# this option is superseded by the HAVE_DOT option below. This is only a
-# recommended to install and use dot, since it yields more powerful graphs.
+# fallback. It is recommended to install and use dot, since it yields more
+# powerful graphs.
 
 CLASS_DIAGRAMS         = YES
 
@@ -1067,6 +1090,11 @@ CLASS_GRAPH            = YES
 
 COLLABORATION_GRAPH    = YES
 
+# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for groups, showing the direct groups dependencies
+
+GROUP_GRAPHS           = NO # YES causes 1.4.0 to segfault
+
 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
 # collaboration diagrams in a style similar to the OMG's Unified Modeling
 # Language.
@@ -1105,6 +1133,13 @@ CALL_GRAPH             = NO
 
 GRAPHICAL_HIERARCHY    = YES
 
+# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
+# then doxygen will show the dependencies a directory has on other directories
+# in a graphical way. The dependency relations are determined by the #include
+# relations between the files in the directories.
+
+DIRECTORY_GRAPH        = YES
+
 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
 # generated by dot. Possible values are png, jpg, or gif
 # If left blank png will be used.
@@ -1112,7 +1147,7 @@ GRAPHICAL_HIERARCHY    = YES
 DOT_IMAGE_FORMAT       = png
 
 # The tag DOT_PATH can be used to specify the path where the dot tool can be
-# found. If left blank, it is assumed the dot tool can be found on the path.
+# found. If left blank, it is assumed the dot tool can be found in the path.
 
 DOT_PATH               =
 
@@ -1140,15 +1175,31 @@ MAX_DOT_GRAPH_HEIGHT   = 1024
 
 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
 # graphs generated by dot. A depth value of 3 means that only nodes reachable
-# from the root by following a path via at most 3 edges will be shown. Nodes that
+# from the root by following a path via at most 3 edges will be shown. Nodes
-# lay further from the root node will be omitted. Note that setting this option to
+# that lay further from the root node will be omitted. Note that setting this
-# 1 or 2 may greatly reduce the computation time needed for large code bases. Also
+# option to 1 or 2 may greatly reduce the computation time needed for large
-# note that a graph may be further truncated if the graph's image dimensions are
+# code bases. Also note that a graph may be further truncated if the graph's
-# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
+# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
-# If 0 is used for the depth value (the default), the graph is not depth-constrained.
+# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
+# the graph is not depth-constrained.
 
 MAX_DOT_GRAPH_DEPTH    = 0
 
+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
+# background. This is disabled by default, which results in a white background.
+# Warning: Depending on the platform used, enabling this option may lead to
+# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
+# read).
+
+DOT_TRANSPARENT        = NO
+
+# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
+# files in one run (i.e. multiple -o and -T options on the command line). This
+# makes dot run faster, but since only newer versions of dot (>1.8.10)
+# support this, this feature is disabled by default.
+
+DOT_MULTI_TARGETS      = YES
+
 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
 # generate a legend page explaining the meaning of the various boxes and
 # arrows in the dot generated graphs.

src/tgbaparse/public.hh

@@ -1,4 +1,4 @@
-// Copyright (C) 2003, 2004  Laboratoire d'Informatique de Paris 6 (LIP6),
+// Copyright (C) 2003, 2004, 2005  Laboratoire d'Informatique de Paris 6 (LIP6),
 // département Systèmes Répartis Coopératifs (SRC), Université Pierre
 // et Marie Curie.
 //
@@ -65,6 +65,7 @@ namespace spot
 
   /// \brief Format diagnostics produced by spot::tgba_parse.
   /// \param os Where diagnostics should be output.
+  /// \param filename The filename that should appear in the diagnostics.
   /// \param error_list The error list filled by spot::ltl::parse while
   ///        parsing \a ltl_string.
   /// \return \c true iff any diagnostic was output.