Minor doc improvements
authorPeter Kovacs <kpeter@inf.elte.hu>
Sat, 08 Jan 2011 16:11:48 +0100
changeset 1025140c953ad5d1
parent 1021 4980b05606bd
child 1026 9312d6c89d02
Minor doc improvements
lemon/capacity_scaling.h
lemon/cost_scaling.h
lemon/cycle_canceling.h
lemon/kruskal.h
lemon/network_simplex.h
     1.1 --- a/lemon/capacity_scaling.h	Tue Nov 16 07:46:01 2010 +0100
     1.2 +++ b/lemon/capacity_scaling.h	Sat Jan 08 16:11:48 2011 +0100
     1.3 @@ -86,7 +86,8 @@
     1.4    /// In most cases, this parameter should not be set directly,
     1.5    /// consider to use the named template parameters instead.
     1.6    ///
     1.7 -  /// \warning Both number types must be signed and all input data must
     1.8 +  /// \warning Both \c V and \c C must be signed number types.
     1.9 +  /// \warning All input data (capacities, supply values, and costs) must
    1.10    /// be integer.
    1.11    /// \warning This algorithm does not support negative costs for such
    1.12    /// arcs that have infinite upper bound.
     2.1 --- a/lemon/cost_scaling.h	Tue Nov 16 07:46:01 2010 +0100
     2.2 +++ b/lemon/cost_scaling.h	Sat Jan 08 16:11:48 2011 +0100
     2.3 @@ -113,7 +113,8 @@
     2.4    /// In most cases, this parameter should not be set directly,
     2.5    /// consider to use the named template parameters instead.
     2.6    ///
     2.7 -  /// \warning Both number types must be signed and all input data must
     2.8 +  /// \warning Both \c V and \c C must be signed number types.
     2.9 +  /// \warning All input data (capacities, supply values, and costs) must
    2.10    /// be integer.
    2.11    /// \warning This algorithm does not support negative costs for such
    2.12    /// arcs that have infinite upper bound.
     3.1 --- a/lemon/cycle_canceling.h	Tue Nov 16 07:46:01 2010 +0100
     3.2 +++ b/lemon/cycle_canceling.h	Sat Jan 08 16:11:48 2011 +0100
     3.3 @@ -65,7 +65,8 @@
     3.4    /// \tparam C The number type used for costs and potentials in the
     3.5    /// algorithm. By default, it is the same as \c V.
     3.6    ///
     3.7 -  /// \warning Both number types must be signed and all input data must
     3.8 +  /// \warning Both \c V and \c C must be signed number types.
     3.9 +  /// \warning All input data (capacities, supply values, and costs) must
    3.10    /// be integer.
    3.11    /// \warning This algorithm does not support negative costs for such
    3.12    /// arcs that have infinite upper bound.
     4.1 --- a/lemon/kruskal.h	Tue Nov 16 07:46:01 2010 +0100
     4.2 +++ b/lemon/kruskal.h	Sat Jan 08 16:11:48 2011 +0100
     4.3 @@ -30,9 +30,6 @@
     4.4  ///\ingroup spantree
     4.5  ///\file
     4.6  ///\brief Kruskal's algorithm to compute a minimum cost spanning tree
     4.7 -///
     4.8 -///Kruskal's algorithm to compute a minimum cost spanning tree.
     4.9 -///
    4.10  
    4.11  namespace lemon {
    4.12  
     5.1 --- a/lemon/network_simplex.h	Tue Nov 16 07:46:01 2010 +0100
     5.2 +++ b/lemon/network_simplex.h	Sat Jan 08 16:11:48 2011 +0100
     5.3 @@ -63,7 +63,8 @@
     5.4    /// \tparam C The number type used for costs and potentials in the
     5.5    /// algorithm. By default, it is the same as \c V.
     5.6    ///
     5.7 -  /// \warning Both number types must be signed and all input data must
     5.8 +  /// \warning Both \c V and \c C must be signed number types.
     5.9 +  /// \warning All input data (capacities, supply values, and costs) must
    5.10    /// be integer.
    5.11    ///
    5.12    /// \note %NetworkSimplex provides five different pivot rule