Changeset 2307:558cc308a4bd in lemon-0.x

Timestamp:

11/21/06 19:29:31 (17 years ago)

Author:

Balazs Dezso

Branch:

default

Phase:

public

Convert:

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

Message:

Some doc fix

File:

• lemon/bfs.h (modified) (4 diffs)

lemon/bfs.h

@@ -588 +588 @@
     }
     
-    ///Executes the algorithm until \c dest is the next node to processed.
-
-    ///Executes the algorithm until \c dest is the next node to processed.
+    ///Executes the algorithm until \c dest is reached.
+
+    ///Executes the algorithm until \c dest is reached.
     ///
     ///\pre init() must be called and at least one node should be added
@@ -616 +616 @@
     ///
     ///\param nm must be a bool (or convertible) node map. The
-    ///algorithm will stop when for the next processable node \c v is
+    ///algorithm will stop when it reached a node \c v with
     ///<tt>nm[v]</tt> true.
     ///\todo query the reached target
@@ -1503 +1503 @@
     }
     
-    /// \brief Executes the algorithm until \c dest will be next processed.
-    ///
-    /// Executes the algorithm until \c dest will be next processed.
+    /// \brief Executes the algorithm until \c dest is reached.
+    ///
+    /// Executes the algorithm until \c dest is reached.
     ///
     /// \pre init() must be called and at least one node should be added
@@ -1524 +1524 @@
     ///
     ///\param nm must be a bool (or convertible) node map. The
-    ///algorithm will stop when it reaches a node \c v with
+    ///algorithm will stop when it reached a node \c v with
     ///<tt>nm[v]</tt> true.
     template <typename NM>