# HG changeset patch
# User alpar
# Date 1122577483 0
# Node ID 5ad84fbadf2bbab4c4191f33ce68c1db543308e4
# Parent  c0d7a92479634ac2ff6741069e1e0b2d9891f612
More docs

diff -r c0d7a9247963 -r 5ad84fbadf2b lemon/kruskal.h
--- a/lemon/kruskal.h	Thu Jul 28 17:06:13 2005 +0000
+++ b/lemon/kruskal.h	Thu Jul 28 19:04:43 2005 +0000
@@ -74,7 +74,7 @@
   /// <tt>GR::Edge</tt> as its <tt>value_type</tt>.
   /// The algorithm copies the elements of the found tree into this sequence.
   /// For example, if we know that the spanning tree of the graph \c g has
-  /// say 53 edges then
+  /// say 53 edges, then
   /// we can put its edges into a STL vector \c tree with a code like this.
   /// \code
   /// std::vector<Edge> tree(53);
@@ -88,6 +88,11 @@
   ///
   /// \return The cost of the found tree.
   ///
+  /// \warning If kruskal is run on an \ref undirected graph, be sure that the
+  /// map storing the tree is also undirected
+  /// (e.g. UndirListGraph::UndirEdgeMap<bool>, otherwise the values of the
+  /// half of the edges will not be set.
+  ///
   /// \todo Discuss the case of undirected graphs: In this case the algorithm
   /// also require <tt>Edge</tt>s instead of <tt>UndirEdge</tt>s, as some
   /// people would expect. So, one should be careful not to add both of the
@@ -387,7 +392,7 @@
 //   <tt>GR::Edge</tt> as its <tt>value_type</tt>.
 //   The algorithm copies the elements of the found tree into this sequence.
 //   For example, if we know that the spanning tree of the graph \c g has
-//   say 53 edges then
+//   say 53 edges, then
 //   we can put its edges into a STL vector \c tree with a code like this.
 //   \code
 //   std::vector<Edge> tree(53);