Small doc improvements (#263)
authorPeter Kovacs <kpeter@inf.elte.hu>
Wed, 15 Apr 2009 02:04:37 +0200
changeset 57633c6b6e755cd
parent 575 99a31b399b59
child 580 58f70400e139
Small doc improvements (#263)
lemon/bin_heap.h
lemon/concepts/graph_components.h
lemon/concepts/heap.h
lemon/dfs.h
lemon/dijkstra.h
lemon/dimacs.h
lemon/graph_to_eps.h
lemon/kruskal.h
lemon/lgf_reader.h
lemon/lgf_writer.h
lemon/lp_base.h
lemon/maps.h
lemon/min_cost_arborescence.h
lemon/random.h
lemon/suurballe.h
lemon/time_measure.h
tools/dimacs-solver.cc
tools/dimacs-to-lgf.cc
tools/lgf-gen.cc
     1.1 --- a/lemon/bin_heap.h	Tue Apr 14 10:40:33 2009 +0100
     1.2 +++ b/lemon/bin_heap.h	Wed Apr 15 02:04:37 2009 +0200
     1.3 @@ -73,9 +73,9 @@
     1.4      /// The item-int map must be initialized in such way that it assigns
     1.5      /// \c PRE_HEAP (<tt>-1</tt>) to any element to be put in the heap.
     1.6      enum State {
     1.7 -      IN_HEAP = 0,    ///< \e
     1.8 -      PRE_HEAP = -1,  ///< \e
     1.9 -      POST_HEAP = -2  ///< \e
    1.10 +      IN_HEAP = 0,    ///< = 0.
    1.11 +      PRE_HEAP = -1,  ///< = -1.
    1.12 +      POST_HEAP = -2  ///< = -2.
    1.13      };
    1.14  
    1.15    private:
     2.1 --- a/lemon/concepts/graph_components.h	Tue Apr 14 10:40:33 2009 +0100
     2.2 +++ b/lemon/concepts/graph_components.h	Wed Apr 15 02:04:37 2009 +0200
     2.3 @@ -602,7 +602,7 @@
     2.4  
     2.5        typedef IterableDigraphComponent Digraph;
     2.6  
     2.7 -      /// \name Base iteration
     2.8 +      /// \name Base Iteration
     2.9        ///
    2.10        /// This interface provides functions for iteration on digraph items.
    2.11        ///
    2.12 @@ -654,7 +654,7 @@
    2.13  
    2.14        /// @}
    2.15  
    2.16 -      /// \name Class based iteration
    2.17 +      /// \name Class Based Iteration
    2.18        ///
    2.19        /// This interface provides iterator classes for digraph items.
    2.20        ///
    2.21 @@ -779,7 +779,7 @@
    2.22  
    2.23        typedef IterableGraphComponent Graph;
    2.24  
    2.25 -      /// \name Base iteration
    2.26 +      /// \name Base Iteration
    2.27        ///
    2.28        /// This interface provides functions for iteration on edges.
    2.29        ///
    2.30 @@ -818,7 +818,7 @@
    2.31  
    2.32        /// @}
    2.33  
    2.34 -      /// \name Class based iteration
    2.35 +      /// \name Class Based Iteration
    2.36        ///
    2.37        /// This interface provides iterator classes for edges.
    2.38        ///
     3.1 --- a/lemon/concepts/heap.h	Tue Apr 14 10:40:33 2009 +0100
     3.2 +++ b/lemon/concepts/heap.h	Wed Apr 15 02:04:37 2009 +0200
     3.3 @@ -71,9 +71,9 @@
     3.4        /// The item-int map must be initialized in such way that it assigns
     3.5        /// \c PRE_HEAP (<tt>-1</tt>) to any element to be put in the heap.
     3.6        enum State {
     3.7 -        IN_HEAP = 0,    ///< The "in heap" state constant.
     3.8 -        PRE_HEAP = -1,  ///< The "pre heap" state constant.
     3.9 -        POST_HEAP = -2  ///< The "post heap" state constant.
    3.10 +        IN_HEAP = 0,    ///< = 0. The "in heap" state constant.
    3.11 +        PRE_HEAP = -1,  ///< = -1. The "pre heap" state constant.
    3.12 +        POST_HEAP = -2  ///< = -2. The "post heap" state constant.
    3.13        };
    3.14  
    3.15        /// \brief The constructor.
     4.1 --- a/lemon/dfs.h	Tue Apr 14 10:40:33 2009 +0100
     4.2 +++ b/lemon/dfs.h	Wed Apr 15 02:04:37 2009 +0200
     4.3 @@ -206,7 +206,7 @@
     4.4  
     4.5      typedef Dfs Create;
     4.6  
     4.7 -    ///\name Named template parameters
     4.8 +    ///\name Named Template Parameters
     4.9  
    4.10      ///@{
    4.11  
     5.1 --- a/lemon/dijkstra.h	Tue Apr 14 10:40:33 2009 +0100
     5.2 +++ b/lemon/dijkstra.h	Wed Apr 15 02:04:37 2009 +0200
     5.3 @@ -286,7 +286,7 @@
     5.4  
     5.5      typedef Dijkstra Create;
     5.6  
     5.7 -    ///\name Named template parameters
     5.8 +    ///\name Named Template Parameters
     5.9  
    5.10      ///@{
    5.11  
     6.1 --- a/lemon/dimacs.h	Tue Apr 14 10:40:33 2009 +0100
     6.2 +++ b/lemon/dimacs.h	Wed Apr 15 02:04:37 2009 +0200
     6.3 @@ -37,11 +37,16 @@
     6.4    /// DIMACS file type descriptor.
     6.5    struct DimacsDescriptor
     6.6    {
     6.7 -    ///File type enum
     6.8 -    enum Type
     6.9 -      {
    6.10 -        NONE, MIN, MAX, SP, MAT
    6.11 -      };
    6.12 +    ///\brief DIMACS file type enum
    6.13 +    ///
    6.14 +    ///DIMACS file type enum.
    6.15 +    enum Type {
    6.16 +      NONE,  ///< Undefined type.
    6.17 +      MIN,   ///< DIMACS file type for minimum cost flow problems.
    6.18 +      MAX,   ///< DIMACS file type for maximum flow problems.
    6.19 +      SP,    ///< DIMACS file type for shostest path problems.
    6.20 +      MAT    ///< DIMACS file type for plain graphs and matching problems.
    6.21 +    };
    6.22      ///The file type
    6.23      Type type;
    6.24      ///The number of nodes in the graph
    6.25 @@ -49,16 +54,16 @@
    6.26      ///The number of edges in the graph
    6.27      int edgeNum;
    6.28      int lineShift;
    6.29 -    /// Constructor. Sets the type to NONE.
    6.30 +    ///Constructor. It sets the type to \c NONE.
    6.31      DimacsDescriptor() : type(NONE) {}
    6.32    };
    6.33  
    6.34    ///Discover the type of a DIMACS file
    6.35  
    6.36 -  ///It starts seeking the beginning of the file for the problem type
    6.37 -  ///and size info. The found data is returned in a special struct
    6.38 -  ///that can be evaluated and passed to the appropriate reader
    6.39 -  ///function.
    6.40 +  ///This function starts seeking the beginning of the given file for the
    6.41 +  ///problem type and size info. 
    6.42 +  ///The found data is returned in a special struct that can be evaluated
    6.43 +  ///and passed to the appropriate reader function.
    6.44    DimacsDescriptor dimacsType(std::istream& is)
    6.45    {
    6.46      DimacsDescriptor r;
    6.47 @@ -96,8 +101,7 @@
    6.48    }
    6.49  
    6.50  
    6.51 -
    6.52 -  /// DIMACS minimum cost flow reader function.
    6.53 +  /// \brief DIMACS minimum cost flow reader function.
    6.54    ///
    6.55    /// This function reads a minimum cost flow instance from DIMACS format,
    6.56    /// i.e. from a DIMACS file having a line starting with
    6.57 @@ -253,7 +257,7 @@
    6.58      }
    6.59    }
    6.60  
    6.61 -  /// DIMACS maximum flow reader function.
    6.62 +  /// \brief DIMACS maximum flow reader function.
    6.63    ///
    6.64    /// This function reads a maximum flow instance from DIMACS format,
    6.65    /// i.e. from a DIMACS file having a line starting with
    6.66 @@ -287,7 +291,7 @@
    6.67      _readDimacs(is,g,capacity,s,t,infty,desc);
    6.68    }
    6.69  
    6.70 -  /// DIMACS shortest path reader function.
    6.71 +  /// \brief DIMACS shortest path reader function.
    6.72    ///
    6.73    /// This function reads a shortest path instance from DIMACS format,
    6.74    /// i.e. from a DIMACS file having a line starting with
    6.75 @@ -313,7 +317,7 @@
    6.76      _readDimacs(is, g, length, s, t, 0, desc);
    6.77    }
    6.78  
    6.79 -  /// DIMACS capacitated digraph reader function.
    6.80 +  /// \brief DIMACS capacitated digraph reader function.
    6.81    ///
    6.82    /// This function reads an arc capacitated digraph instance from
    6.83    /// DIMACS 'max' or 'sp' format.
    6.84 @@ -359,11 +363,11 @@
    6.85      g.addArc(s,t);
    6.86    }
    6.87    
    6.88 -  /// DIMACS plain (di)graph reader function.
    6.89 +  /// \brief DIMACS plain (di)graph reader function.
    6.90    ///
    6.91 -  /// This function reads a (di)graph without any designated nodes and
    6.92 -  /// maps from DIMACS format, i.e. from DIMACS files having a line
    6.93 -  /// starting with
    6.94 +  /// This function reads a plain (di)graph without any designated nodes
    6.95 +  /// and maps (e.g. a matching instance) from DIMACS format, i.e. from 
    6.96 +  /// DIMACS files having a line starting with
    6.97    /// \code
    6.98    ///   p mat
    6.99    /// \endcode
     7.1 --- a/lemon/graph_to_eps.h	Tue Apr 14 10:40:33 2009 +0100
     7.2 +++ b/lemon/graph_to_eps.h	Wed Apr 15 02:04:37 2009 +0200
     7.3 @@ -268,22 +268,18 @@
     7.4      /// = 1
     7.5      ///\image html nodeshape_1.png
     7.6      ///\image latex nodeshape_1.eps "SQUARE shape (1)" width=2cm
     7.7 -    ///
     7.8      SQUARE=1,
     7.9      /// = 2
    7.10      ///\image html nodeshape_2.png
    7.11      ///\image latex nodeshape_2.eps "DIAMOND shape (2)" width=2cm
    7.12 -    ///
    7.13      DIAMOND=2,
    7.14      /// = 3
    7.15      ///\image html nodeshape_3.png
    7.16 -    ///\image latex nodeshape_2.eps "MALE shape (4)" width=2cm
    7.17 -    ///
    7.18 +    ///\image latex nodeshape_3.eps "MALE shape (3)" width=2cm
    7.19      MALE=3,
    7.20      /// = 4
    7.21      ///\image html nodeshape_4.png
    7.22 -    ///\image latex nodeshape_2.eps "FEMALE shape (4)" width=2cm
    7.23 -    ///
    7.24 +    ///\image latex nodeshape_4.eps "FEMALE shape (4)" width=2cm
    7.25      FEMALE=4
    7.26    };
    7.27  
     8.1 --- a/lemon/kruskal.h	Tue Apr 14 10:40:33 2009 +0100
     8.2 +++ b/lemon/kruskal.h	Wed Apr 15 02:04:37 2009 +0200
     8.3 @@ -248,11 +248,11 @@
     8.4  
     8.5    /// \ingroup spantree
     8.6    ///
     8.7 -  /// \brief Kruskal algorithm to find a minimum cost spanning tree of
     8.8 +  /// \brief Kruskal's algorithm for finding a minimum cost spanning tree of
     8.9    /// a graph.
    8.10    ///
    8.11    /// This function runs Kruskal's algorithm to find a minimum cost
    8.12 -  /// spanning tree.
    8.13 +  /// spanning tree of a graph.
    8.14    /// Due to some C++ hacking, it accepts various input and output types.
    8.15    ///
    8.16    /// \param g The graph the algorithm runs on.
    8.17 @@ -264,17 +264,17 @@
    8.18    /// \param in This object is used to describe the arc/edge costs.
    8.19    /// It can be one of the following choices.
    8.20    /// - An STL compatible 'Forward Container' with
    8.21 -  /// <tt>std::pair<GR::Arc,X></tt> or
    8.22 -  /// <tt>std::pair<GR::Edge,X></tt> as its <tt>value_type</tt>, where
    8.23 -  /// \c X is the type of the costs. The pairs indicates the arcs/edges
    8.24 +  /// <tt>std::pair<GR::Arc,C></tt> or
    8.25 +  /// <tt>std::pair<GR::Edge,C></tt> as its <tt>value_type</tt>, where
    8.26 +  /// \c C is the type of the costs. The pairs indicates the arcs/edges
    8.27    /// along with the assigned cost. <em>They must be in a
    8.28    /// cost-ascending order.</em>
    8.29    /// - Any readable arc/edge map. The values of the map indicate the
    8.30    /// arc/edge costs.
    8.31    ///
    8.32    /// \retval out Here we also have a choice.
    8.33 -  /// - It can be a writable \c bool arc/edge map. After running the
    8.34 -  /// algorithm it will contain the found minimum cost spanning
    8.35 +  /// - It can be a writable arc/edge map with \c bool value type. After
    8.36 +  /// running the algorithm it will contain the found minimum cost spanning
    8.37    /// tree: the value of an arc/edge will be set to \c true if it belongs
    8.38    /// to the tree, otherwise it will be set to \c false. The value of
    8.39    /// each arc/edge will be set exactly once.
    8.40 @@ -301,8 +301,8 @@
    8.41    /// forest is calculated instead of a spanning tree.
    8.42  
    8.43  #ifdef DOXYGEN
    8.44 -  template <class Graph, class In, class Out>
    8.45 -  Value kruskal(GR const& g, const In& in, Out& out)
    8.46 +  template <typename Graph, typename In, typename Out>
    8.47 +  Value kruskal(const Graph& g, const In& in, Out& out)
    8.48  #else
    8.49    template <class Graph, class In, class Out>
    8.50    inline typename _kruskal_bits::KruskalValueSelector<In>::Value
    8.51 @@ -314,8 +314,6 @@
    8.52    }
    8.53  
    8.54  
    8.55 -
    8.56 -
    8.57    template <class Graph, class In, class Out>
    8.58    inline typename _kruskal_bits::KruskalValueSelector<In>::Value
    8.59    kruskal(const Graph& graph, const In& in, const Out& out)
     9.1 --- a/lemon/lgf_reader.h	Tue Apr 14 10:40:33 2009 +0100
     9.2 +++ b/lemon/lgf_reader.h	Wed Apr 15 02:04:37 2009 +0200
     9.3 @@ -593,7 +593,7 @@
     9.4  
     9.5    public:
     9.6  
     9.7 -    /// \name Reading rules
     9.8 +    /// \name Reading Rules
     9.9      /// @{
    9.10  
    9.11      /// \brief Node map reading rule
    9.12 @@ -698,7 +698,7 @@
    9.13  
    9.14      /// @}
    9.15  
    9.16 -    /// \name Select section by name
    9.17 +    /// \name Select Section by Name
    9.18      /// @{
    9.19  
    9.20      /// \brief Set \c \@nodes section to be read
    9.21 @@ -727,7 +727,7 @@
    9.22  
    9.23      /// @}
    9.24  
    9.25 -    /// \name Using previously constructed node or arc set
    9.26 +    /// \name Using Previously Constructed Node or Arc Set
    9.27      /// @{
    9.28  
    9.29      /// \brief Use previously constructed node set
    9.30 @@ -1116,7 +1116,7 @@
    9.31  
    9.32    public:
    9.33  
    9.34 -    /// \name Execution of the reader
    9.35 +    /// \name Execution of the Reader
    9.36      /// @{
    9.37  
    9.38      /// \brief Start the batch processing
    9.39 @@ -1389,7 +1389,7 @@
    9.40  
    9.41    public:
    9.42  
    9.43 -    /// \name Reading rules
    9.44 +    /// \name Reading Rules
    9.45      /// @{
    9.46  
    9.47      /// \brief Node map reading rule
    9.48 @@ -1540,7 +1540,7 @@
    9.49  
    9.50      /// @}
    9.51  
    9.52 -    /// \name Select section by name
    9.53 +    /// \name Select Section by Name
    9.54      /// @{
    9.55  
    9.56      /// \brief Set \c \@nodes section to be read
    9.57 @@ -1569,7 +1569,7 @@
    9.58  
    9.59      /// @}
    9.60  
    9.61 -    /// \name Using previously constructed node or edge set
    9.62 +    /// \name Using Previously Constructed Node or Edge Set
    9.63      /// @{
    9.64  
    9.65      /// \brief Use previously constructed node set
    9.66 @@ -1959,7 +1959,7 @@
    9.67  
    9.68    public:
    9.69  
    9.70 -    /// \name Execution of the reader
    9.71 +    /// \name Execution of the Reader
    9.72      /// @{
    9.73  
    9.74      /// \brief Start the batch processing
    9.75 @@ -2158,7 +2158,7 @@
    9.76  
    9.77    public:
    9.78  
    9.79 -    /// \name Section readers
    9.80 +    /// \name Section Readers
    9.81      /// @{
    9.82  
    9.83      /// \brief Add a section processor with line oriented reading
    9.84 @@ -2257,7 +2257,7 @@
    9.85    public:
    9.86  
    9.87  
    9.88 -    /// \name Execution of the reader
    9.89 +    /// \name Execution of the Reader
    9.90      /// @{
    9.91  
    9.92      /// \brief Start the batch processing
    9.93 @@ -2439,7 +2439,7 @@
    9.94    public:
    9.95  
    9.96  
    9.97 -    /// \name Node sections
    9.98 +    /// \name Node Sections
    9.99      /// @{
   9.100  
   9.101      /// \brief Gives back the number of node sections in the file.
   9.102 @@ -2465,7 +2465,7 @@
   9.103  
   9.104      /// @}
   9.105  
   9.106 -    /// \name Arc/Edge sections
   9.107 +    /// \name Arc/Edge Sections
   9.108      /// @{
   9.109  
   9.110      /// \brief Gives back the number of arc/edge sections in the file.
   9.111 @@ -2523,7 +2523,7 @@
   9.112  
   9.113      /// @}
   9.114  
   9.115 -    /// \name Attribute sections
   9.116 +    /// \name Attribute Sections
   9.117      /// @{
   9.118  
   9.119      /// \brief Gives back the number of attribute sections in the file.
   9.120 @@ -2549,7 +2549,7 @@
   9.121  
   9.122      /// @}
   9.123  
   9.124 -    /// \name Extra sections
   9.125 +    /// \name Extra Sections
   9.126      /// @{
   9.127  
   9.128      /// \brief Gives back the number of extra sections in the file.
   9.129 @@ -2625,7 +2625,7 @@
   9.130  
   9.131    public:
   9.132  
   9.133 -    /// \name Execution of the contents reader
   9.134 +    /// \name Execution of the Contents Reader
   9.135      /// @{
   9.136  
   9.137      /// \brief Starts the reading
    10.1 --- a/lemon/lgf_writer.h	Tue Apr 14 10:40:33 2009 +0100
    10.2 +++ b/lemon/lgf_writer.h	Wed Apr 15 02:04:37 2009 +0200
    10.3 @@ -538,7 +538,7 @@
    10.4  
    10.5    public:
    10.6  
    10.7 -    /// \name Writing rules
    10.8 +    /// \name Writing Rules
    10.9      /// @{
   10.10  
   10.11      /// \brief Node map writing rule
   10.12 @@ -641,7 +641,7 @@
   10.13        return *this;
   10.14      }
   10.15  
   10.16 -    /// \name Section captions
   10.17 +    /// \name Section Captions
   10.18      /// @{
   10.19  
   10.20      /// \brief Add an additional caption to the \c \@nodes section
   10.21 @@ -668,7 +668,7 @@
   10.22        return *this;
   10.23      }
   10.24  
   10.25 -    /// \name Skipping section
   10.26 +    /// \name Skipping Section
   10.27      /// @{
   10.28  
   10.29      /// \brief Skip writing the node set
   10.30 @@ -885,7 +885,7 @@
   10.31  
   10.32    public:
   10.33  
   10.34 -    /// \name Execution of the writer
   10.35 +    /// \name Execution of the Writer
   10.36      /// @{
   10.37  
   10.38      /// \brief Start the batch processing
   10.39 @@ -1106,7 +1106,7 @@
   10.40  
   10.41    public:
   10.42  
   10.43 -    /// \name Writing rules
   10.44 +    /// \name Writing Rules
   10.45      /// @{
   10.46  
   10.47      /// \brief Node map writing rule
   10.48 @@ -1255,7 +1255,7 @@
   10.49        return *this;
   10.50      }
   10.51  
   10.52 -    /// \name Section captions
   10.53 +    /// \name Section Captions
   10.54      /// @{
   10.55  
   10.56      /// \brief Add an additional caption to the \c \@nodes section
   10.57 @@ -1282,7 +1282,7 @@
   10.58        return *this;
   10.59      }
   10.60  
   10.61 -    /// \name Skipping section
   10.62 +    /// \name Skipping Section
   10.63      /// @{
   10.64  
   10.65      /// \brief Skip writing the node set
   10.66 @@ -1499,7 +1499,7 @@
   10.67  
   10.68    public:
   10.69  
   10.70 -    /// \name Execution of the writer
   10.71 +    /// \name Execution of the Writer
   10.72      /// @{
   10.73  
   10.74      /// \brief Start the batch processing
   10.75 @@ -1651,7 +1651,7 @@
   10.76  
   10.77    public:
   10.78  
   10.79 -    /// \name Section writers
   10.80 +    /// \name Section Writers
   10.81      /// @{
   10.82  
   10.83      /// \brief Add a section writer with line oriented writing
   10.84 @@ -1718,7 +1718,7 @@
   10.85    public:
   10.86  
   10.87  
   10.88 -    /// \name Execution of the writer
   10.89 +    /// \name Execution of the Writer
   10.90      /// @{
   10.91  
   10.92      /// \brief Start the batch processing
    11.1 --- a/lemon/lp_base.h	Tue Apr 14 10:40:33 2009 +0100
    11.2 +++ b/lemon/lp_base.h	Wed Apr 15 02:04:37 2009 +0200
    11.3 @@ -52,12 +52,12 @@
    11.4  
    11.5      ///Possible outcomes of an LP solving procedure
    11.6      enum SolveExitStatus {
    11.7 -      ///This means that the problem has been successfully solved: either
    11.8 +      /// = 0. It means that the problem has been successfully solved: either
    11.9        ///an optimal solution has been found or infeasibility/unboundedness
   11.10        ///has been proved.
   11.11        SOLVED = 0,
   11.12 -      ///Any other case (including the case when some user specified
   11.13 -      ///limit has been exceeded)
   11.14 +      /// = 1. Any other case (including the case when some user specified
   11.15 +      ///limit has been exceeded).
   11.16        UNSOLVED = 1
   11.17      };
   11.18  
   11.19 @@ -71,15 +71,15 @@
   11.20  
   11.21      ///Enum for \c messageLevel() parameter
   11.22      enum MessageLevel {
   11.23 -      /// no output (default value)
   11.24 +      /// No output (default value).
   11.25        MESSAGE_NOTHING,
   11.26 -      /// error messages only
   11.27 +      /// Error messages only.
   11.28        MESSAGE_ERROR,
   11.29 -      /// warnings
   11.30 +      /// Warnings.
   11.31        MESSAGE_WARNING,
   11.32 -      /// normal output
   11.33 +      /// Normal output.
   11.34        MESSAGE_NORMAL,
   11.35 -      /// verbose output
   11.36 +      /// Verbose output.
   11.37        MESSAGE_VERBOSE
   11.38      };
   11.39      
   11.40 @@ -1005,7 +1005,7 @@
   11.41      ///Gives back the name of the solver.
   11.42      const char* solverName() const {return _solverName();}
   11.43  
   11.44 -    ///\name Build up and modify the LP
   11.45 +    ///\name Build Up and Modify the LP
   11.46  
   11.47      ///@{
   11.48  
   11.49 @@ -1788,15 +1788,15 @@
   11.50  
   11.51      /// The problem types for primal and dual problems
   11.52      enum ProblemType {
   11.53 -      ///Feasible solution hasn't been found (but may exist).
   11.54 +      /// = 0. Feasible solution hasn't been found (but may exist).
   11.55        UNDEFINED = 0,
   11.56 -      ///The problem has no feasible solution
   11.57 +      /// = 1. The problem has no feasible solution.
   11.58        INFEASIBLE = 1,
   11.59 -      ///Feasible solution found
   11.60 +      /// = 2. Feasible solution found.
   11.61        FEASIBLE = 2,
   11.62 -      ///Optimal solution exists and found
   11.63 +      /// = 3. Optimal solution exists and found.
   11.64        OPTIMAL = 3,
   11.65 -      ///The cost function is unbounded
   11.66 +      /// = 4. The cost function is unbounded.
   11.67        UNBOUNDED = 4
   11.68      };
   11.69  
   11.70 @@ -1852,7 +1852,7 @@
   11.71  
   11.72      ///@}
   11.73  
   11.74 -    ///\name Obtain the solution
   11.75 +    ///\name Obtain the Solution
   11.76  
   11.77      ///@{
   11.78  
   11.79 @@ -1974,17 +1974,16 @@
   11.80  
   11.81      /// The problem types for MIP problems
   11.82      enum ProblemType {
   11.83 -      ///Feasible solution hasn't been found (but may exist).
   11.84 +      /// = 0. Feasible solution hasn't been found (but may exist).
   11.85        UNDEFINED = 0,
   11.86 -      ///The problem has no feasible solution
   11.87 +      /// = 1. The problem has no feasible solution.
   11.88        INFEASIBLE = 1,
   11.89 -      ///Feasible solution found
   11.90 +      /// = 2. Feasible solution found.
   11.91        FEASIBLE = 2,
   11.92 -      ///Optimal solution exists and found
   11.93 +      /// = 3. Optimal solution exists and found.
   11.94        OPTIMAL = 3,
   11.95 -      ///The cost function is unbounded
   11.96 -      ///
   11.97 -      ///The Mip or at least the relaxed problem is unbounded
   11.98 +      /// = 4. The cost function is unbounded.
   11.99 +      ///The Mip or at least the relaxed problem is unbounded.
  11.100        UNBOUNDED = 4
  11.101      };
  11.102  
  11.103 @@ -2006,14 +2005,14 @@
  11.104  
  11.105      ///@}
  11.106  
  11.107 -    ///\name Setting column type
  11.108 +    ///\name Set Column Type
  11.109      ///@{
  11.110  
  11.111      ///Possible variable (column) types (e.g. real, integer, binary etc.)
  11.112      enum ColTypes {
  11.113 -      ///Continuous variable (default)
  11.114 +      /// = 0. Continuous variable (default).
  11.115        REAL = 0,
  11.116 -      ///Integer variable
  11.117 +      /// = 1. Integer variable.
  11.118        INTEGER = 1
  11.119      };
  11.120  
  11.121 @@ -2034,7 +2033,7 @@
  11.122      }
  11.123      ///@}
  11.124  
  11.125 -    ///\name Obtain the solution
  11.126 +    ///\name Obtain the Solution
  11.127  
  11.128      ///@{
  11.129  
    12.1 --- a/lemon/maps.h	Tue Apr 14 10:40:33 2009 +0100
    12.2 +++ b/lemon/maps.h	Wed Apr 15 02:04:37 2009 +0200
    12.3 @@ -2728,8 +2728,8 @@
    12.4  
    12.5    /// \brief Potential difference map
    12.6    ///
    12.7 -  /// PotentialMap returns the difference between the potentials of the
    12.8 -  /// source and target nodes of each arc in a digraph, i.e. it returns
    12.9 +  /// PotentialDifferenceMap returns the difference between the potentials of
   12.10 +  /// the source and target nodes of each arc in a digraph, i.e. it returns
   12.11    /// \code
   12.12    ///   potential[gr.target(arc)] - potential[gr.source(arc)].
   12.13    /// \endcode
    13.1 --- a/lemon/min_cost_arborescence.h	Tue Apr 14 10:40:33 2009 +0100
    13.2 +++ b/lemon/min_cost_arborescence.h	Wed Apr 15 02:04:37 2009 +0200
    13.3 @@ -90,10 +90,10 @@
    13.4  
    13.5    /// \ingroup spantree
    13.6    ///
    13.7 -  /// \brief %MinCostArborescence algorithm class.
    13.8 +  /// \brief Minimum Cost Arborescence algorithm class.
    13.9    ///
   13.10    /// This class provides an efficient implementation of
   13.11 -  /// %MinCostArborescence algorithm. The arborescence is a tree
   13.12 +  /// Minimum Cost Arborescence algorithm. The arborescence is a tree
   13.13    /// which is directed from a given source node of the digraph. One or
   13.14    /// more sources should be given for the algorithm and it will calculate
   13.15    /// the minimum cost subgraph which are union of arborescences with the
   13.16 @@ -390,7 +390,7 @@
   13.17  
   13.18    public:
   13.19  
   13.20 -    /// \name Named template parameters
   13.21 +    /// \name Named Template Parameters
   13.22  
   13.23      /// @{
   13.24  
   13.25 @@ -630,7 +630,7 @@
   13.26  
   13.27      /// @}
   13.28  
   13.29 -    /// \name Execution control
   13.30 +    /// \name Execution Control
   13.31      /// The simplest way to execute the algorithm is to use
   13.32      /// one of the member functions called \c run(...). \n
   13.33      /// If you need more control on the execution,
    14.1 --- a/lemon/random.h	Tue Apr 14 10:40:33 2009 +0100
    14.2 +++ b/lemon/random.h	Wed Apr 15 02:04:37 2009 +0200
    14.3 @@ -659,7 +659,7 @@
    14.4  
    14.5      /// @}
    14.6  
    14.7 -    ///\name Uniform distributions
    14.8 +    ///\name Uniform Distributions
    14.9      ///
   14.10      /// @{
   14.11  
   14.12 @@ -762,7 +762,7 @@
   14.13  
   14.14      /// @}
   14.15  
   14.16 -    ///\name Non-uniform distributions
   14.17 +    ///\name Non-uniform Distributions
   14.18      ///
   14.19      ///@{
   14.20  
   14.21 @@ -938,7 +938,7 @@
   14.22  
   14.23      ///@}
   14.24  
   14.25 -    ///\name Two dimensional distributions
   14.26 +    ///\name Two Dimensional Distributions
   14.27      ///
   14.28      ///@{
   14.29  
    15.1 --- a/lemon/suurballe.h	Tue Apr 14 10:40:33 2009 +0100
    15.2 +++ b/lemon/suurballe.h	Wed Apr 15 02:04:37 2009 +0200
    15.3 @@ -288,7 +288,7 @@
    15.4        return *this;
    15.5      }
    15.6  
    15.7 -    /// \name Execution control
    15.8 +    /// \name Execution Control
    15.9      /// The simplest way to execute the algorithm is to call the run()
   15.10      /// function.
   15.11      /// \n
    16.1 --- a/lemon/time_measure.h	Tue Apr 14 10:40:33 2009 +0100
    16.2 +++ b/lemon/time_measure.h	Wed Apr 15 02:04:37 2009 +0200
    16.3 @@ -287,7 +287,7 @@
    16.4      ///
    16.5      Timer(bool run=true) :_running(run) {_reset();}
    16.6  
    16.7 -    ///\name Control the state of the timer
    16.8 +    ///\name Control the State of the Timer
    16.9      ///Basically a Timer can be either running or stopped,
   16.10      ///but it provides a bit finer control on the execution.
   16.11      ///The \ref lemon::Timer "Timer" also counts the number of
   16.12 @@ -395,7 +395,7 @@
   16.13  
   16.14      ///@}
   16.15  
   16.16 -    ///\name Query Functions for the ellapsed time
   16.17 +    ///\name Query Functions for the Ellapsed Time
   16.18  
   16.19      ///@{
   16.20  
    17.1 --- a/tools/dimacs-solver.cc	Tue Apr 14 10:40:33 2009 +0100
    17.2 +++ b/tools/dimacs-solver.cc	Wed Apr 15 02:04:37 2009 +0200
    17.3 @@ -23,11 +23,10 @@
    17.4  /// This program solves various problems given in DIMACS format.
    17.5  ///
    17.6  /// See
    17.7 -/// \verbatim
    17.8 -///  dimacs-solver --help
    17.9 -/// \endverbatim
   17.10 +/// \code
   17.11 +///   dimacs-solver --help
   17.12 +/// \endcode
   17.13  /// for more info on usage.
   17.14 -///
   17.15  
   17.16  #include <iostream>
   17.17  #include <fstream>
    18.1 --- a/tools/dimacs-to-lgf.cc	Tue Apr 14 10:40:33 2009 +0100
    18.2 +++ b/tools/dimacs-to-lgf.cc	Wed Apr 15 02:04:37 2009 +0200
    18.3 @@ -24,11 +24,10 @@
    18.4  /// (LGF).
    18.5  ///
    18.6  /// See
    18.7 -/// \verbatim
    18.8 -///  dimacs-to-lgf --help
    18.9 -/// \endverbatim
   18.10 -/// for more info on usage.
   18.11 -///
   18.12 +/// \code
   18.13 +///   dimacs-to-lgf --help
   18.14 +/// \endcode
   18.15 +/// for more info on the usage.
   18.16  
   18.17  #include <iostream>
   18.18  #include <fstream>
    19.1 --- a/tools/lgf-gen.cc	Tue Apr 14 10:40:33 2009 +0100
    19.2 +++ b/tools/lgf-gen.cc	Wed Apr 15 02:04:37 2009 +0200
    19.3 @@ -23,12 +23,10 @@
    19.4  /// Graph generator application for various types of plane graphs.
    19.5  ///
    19.6  /// See
    19.7 -/// \verbatim
    19.8 -///  lgf-gen --help
    19.9 -/// \endverbatim
   19.10 +/// \code
   19.11 +///   lgf-gen --help
   19.12 +/// \endcode
   19.13  /// for more info on the usage.
   19.14 -///
   19.15 -
   19.16  
   19.17  #include <algorithm>
   19.18  #include <set>