[Lemon-commits] [lemon_svn] athos: r1920 - hugo/trunk/lemon

[Lemon SVN]

Author: athos
Date: Thu Jun  2 16:43:45 2005
New Revision: 1920

Modified:
   hugo/trunk/lemon/dfs.h

Log:
Documentation review.

Modified: hugo/trunk/lemon/dfs.h
==============================================================================
--- hugo/trunk/lemon/dfs.h	(original)
+++ hugo/trunk/lemon/dfs.h	Thu Jun  2 16:43:45 2005
@@ -499,7 +499,7 @@
 
     ///Adds a new source node to the set of nodes to be processed.
     ///
-    ///\bug dist's are wrong (or at least strange) in case of multiple sources.
+    ///\bug dists are wrong (or at least strange) in case of multiple sources.
     void addSource(Node s)
     {
       if(!(*_reached)[s])
@@ -516,7 +516,7 @@
 
     ///Processes the next node.
     ///
-    ///\warning The stack must not be empty!
+    ///\pre The stack must not be empty!
     void processNextEdge()
     { 
       Node m;
@@ -565,7 +565,7 @@
     ///compute the
     ///%DFS path to each node. The algorithm computes
     ///- The %DFS tree.
-    ///- The distance of each node from the root(s).
+    ///- The distance of each node from the root(s) in the %DFS tree.
     ///
     void start()
     {
@@ -584,7 +584,7 @@
     ///compute the
     ///%DFS path to \c dest. The algorithm computes
     ///- The %DFS path to \c  dest.
-    ///- The distance of \c dest from the root(s).
+    ///- The distance of \c dest from the root(s) in the %DFS tree.
     ///
     void start(Node dest)
     {
@@ -601,6 +601,7 @@
     ///
     ///\param nm must be a bool (or convertible) edge map. The algorithm
     ///will stop when it reaches an edge \c e with <tt>nm[e]==true</tt>.
+    ///
     ///\warning Contrary to \ref Dfs and \ref Dijkstra, \c nm is an edge map,
     ///not a node map.
     template<class NM>
@@ -616,7 +617,7 @@
     ///compute the
     ///%DFS path to each node. The algorithm computes
     ///- The %DFS tree.
-    ///- The distance of each node from the root.
+    ///- The distance of each node from the root in the %DFS tree.
     ///
     ///\note d.run(s) is just a shortcut of the following code.
     ///\code
@@ -662,7 +663,7 @@
 
     ///Copies the path to \c t on the DFS tree into \c p
     
-    ///This function copies the path on the DFS tree to \c t into \c p.
+    ///This function copies the path to \c t on the DFS tree  into \c p.
     ///If \c t is a source itself or unreachable, then it does not
     ///alter \c p.
     ///\todo Is this the right way to handle unreachable nodes?
@@ -900,9 +901,9 @@
 
   };
   
-  /// A class to make the usage of Dfs algorithm easier
+  /// A class to make the usage of the Dfs algorithm easier
 
-  /// This class is created to make it easier to use Dfs algorithm.
+  /// This class is created to make it easier to use the Dfs algorithm.
   /// It uses the functions and features of the plain \ref Dfs,
   /// but it is much simpler to use it.
   ///
@@ -947,7 +948,7 @@
 //     ///\brief The type of the map that stores the last but one
 //     ///nodes of the %DFS paths.
 //     typedef typename TR::PredNodeMap PredNodeMap;
-    ///The type of the map that stores the dists of the nodes.
+    ///The type of the map that stores the distances of the nodes.
     typedef typename TR::DistMap DistMap;
 
 public: