Changeset 1443:70781827eb2f in lemon-0.x

Timestamp:

06/02/05 16:43:45 (20 years ago)

Author:

athos

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1920

Message:

Documentation review.

File:

• lemon/dfs.h (modified) (9 diffs)

lemon/dfs.h

@@ -500 +500 @@
     ///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)
     {
@@ -517 +517 @@
     ///Processes the next node.
     ///
-    ///\warning The stack must not be empty!
+    ///\pre The stack must not be empty!
     void processNextEdge()
     { 
@@ -566 +566 @@
     ///%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()
@@ -585 +585 @@
     ///%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)
@@ -602 +602 @@
     ///\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.
@@ -617 +618 @@
     ///%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.
@@ -663 +664 @@
     ///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.
@@ -901 +902 @@
   };
   
-  /// A class to make the usage of Dfs algorithm easier
-
-  /// This class is created to make it easier to use Dfs algorithm.
+  /// A class to make the usage of the Dfs algorithm easier
+
+  /// 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.
@@ -948 +949 @@
 //     ///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;