Changeset 1438:826bdac3525a in lemon-0.x for lemon/dfs.h

Timestamp:

05/26/05 17:33:16 (19 years ago)

Author:

athos

Branch:

default

Phase:

public

Convert:

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

Message:

Some documentation got revised.

File:

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

lemon/dfs.h

@@ -601 +601 @@
     ///
     ///\param nm must be a bool (or convertible) edge map. The algorithm
-    ///will stop when it reaches a edge \c v with <tt>nm[v]==true</tt>.
-    ///\warning Contrary to \ref Dfs and \ref Dijkstra, \c mn is an edge map,
+    ///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>
@@ -664 +664 @@
     
     ///This function copies the path on the DFS tree to \c t into \c p.
-    ///If it \c \t is a source itself or unreachable, then it does not
+    ///If \c t is a source itself or unreachable, then it does not
     ///alter \c p.
-    ///\todo Is it the right way to handle unreachable nodes?
+    ///\todo Is this the right way to handle unreachable nodes?
+    ///
     ///\return Returns \c true if a path to \c t was actually copied to \c p,
     ///\c false otherwise.
@@ -688 +689 @@
     ///Returns the distance of a node from the root(s).
     ///\pre \ref run() must be called before using this function.
-    ///\warning If node \c v in unreachable from the root(s) the return value
+    ///\warning If node \c v is unreachable from the root(s) then the return value
     ///of this funcion is undefined.
     int dist(Node v) const { return (*_dist)[v]; }
@@ -745 +746 @@
     ///Checks if a node is reachable from the root.
 
-    ///Returns \c true if \c v is reachable from the root.
-    ///\warning The source nodes are inditated as unreached.
+    ///Returns \c true if \c v is reachable from the root(s).
+    ///\warning The source nodes are inditated as unreachable.
     ///\pre Either \ref run() or \ref start()
     ///must be called before using this function.
@@ -917 +918 @@
   ///
   /// It does not have own \ref run method. When its \ref run method is called
-  /// it initiates a plain \ref Dfs class, and calls the \ref Dfs::run
+  /// it initiates a plain \ref Dfs object, and calls the \ref Dfs::run
   /// method of it.
   template<class TR>