[Lemon-commits] Peter Kovacs: Minor doc improvements

[Lemon HG]

details:   http://lemon.cs.elte.hu/hg/lemon/rev/140c953ad5d1
changeset: 1025:140c953ad5d1
user:      Peter Kovacs <kpeter [at] inf.elte.hu>
date:      Sat Jan 08 16:11:48 2011 +0100
description:
	Minor doc improvements

diffstat:

 lemon/capacity_scaling.h |  3 ++-
 lemon/cost_scaling.h     |  3 ++-
 lemon/cycle_canceling.h  |  3 ++-
 lemon/kruskal.h          |  3 ---
 lemon/network_simplex.h  |  3 ++-
 5 files changed, 8 insertions(+), 7 deletions(-)

diffs (65 lines):

diff --git a/lemon/capacity_scaling.h b/lemon/capacity_scaling.h
--- a/lemon/capacity_scaling.h
+++ b/lemon/capacity_scaling.h
@@ -86,7 +86,8 @@
   /// In most cases, this parameter should not be set directly,
   /// consider to use the named template parameters instead.
   ///
-  /// \warning Both number types must be signed and all input data must
+  /// \warning Both \c V and \c C must be signed number types.
+  /// \warning All input data (capacities, supply values, and costs) must
   /// be integer.
   /// \warning This algorithm does not support negative costs for such
   /// arcs that have infinite upper bound.
diff --git a/lemon/cost_scaling.h b/lemon/cost_scaling.h
--- a/lemon/cost_scaling.h
+++ b/lemon/cost_scaling.h
@@ -113,7 +113,8 @@
   /// In most cases, this parameter should not be set directly,
   /// consider to use the named template parameters instead.
   ///
-  /// \warning Both number types must be signed and all input data must
+  /// \warning Both \c V and \c C must be signed number types.
+  /// \warning All input data (capacities, supply values, and costs) must
   /// be integer.
   /// \warning This algorithm does not support negative costs for such
   /// arcs that have infinite upper bound.
diff --git a/lemon/cycle_canceling.h b/lemon/cycle_canceling.h
--- a/lemon/cycle_canceling.h
+++ b/lemon/cycle_canceling.h
@@ -65,7 +65,8 @@
   /// \tparam C The number type used for costs and potentials in the
   /// algorithm. By default, it is the same as \c V.
   ///
-  /// \warning Both number types must be signed and all input data must
+  /// \warning Both \c V and \c C must be signed number types.
+  /// \warning All input data (capacities, supply values, and costs) must
   /// be integer.
   /// \warning This algorithm does not support negative costs for such
   /// arcs that have infinite upper bound.
diff --git a/lemon/kruskal.h b/lemon/kruskal.h
--- a/lemon/kruskal.h
+++ b/lemon/kruskal.h
@@ -30,9 +30,6 @@
 ///\ingroup spantree
 ///\file
 ///\brief Kruskal's algorithm to compute a minimum cost spanning tree
-///
-///Kruskal's algorithm to compute a minimum cost spanning tree.
-///
 
 namespace lemon {
 
diff --git a/lemon/network_simplex.h b/lemon/network_simplex.h
--- a/lemon/network_simplex.h
+++ b/lemon/network_simplex.h
@@ -63,7 +63,8 @@
   /// \tparam C The number type used for costs and potentials in the
   /// algorithm. By default, it is the same as \c V.
   ///
-  /// \warning Both number types must be signed and all input data must
+  /// \warning Both \c V and \c C must be signed number types.
+  /// \warning All input data (capacities, supply values, and costs) must
   /// be integer.
   ///
   /// \note %NetworkSimplex provides five different pivot rule