lemon/dfs.h
changeset 1438 826bdac3525a
parent 1435 8e85e6bbefdf
child 1443 70781827eb2f
     1.1 --- a/lemon/dfs.h	Thu May 26 13:21:47 2005 +0000
     1.2 +++ b/lemon/dfs.h	Thu May 26 15:33:16 2005 +0000
     1.3 @@ -600,8 +600,8 @@
     1.4      ///with addSource() before using this function.
     1.5      ///
     1.6      ///\param nm must be a bool (or convertible) edge map. The algorithm
     1.7 -    ///will stop when it reaches a edge \c v with <tt>nm[v]==true</tt>.
     1.8 -    ///\warning Contrary to \ref Dfs and \ref Dijkstra, \c mn is an edge map,
     1.9 +    ///will stop when it reaches an edge \c e with <tt>nm[e]==true</tt>.
    1.10 +    ///\warning Contrary to \ref Dfs and \ref Dijkstra, \c nm is an edge map,
    1.11      ///not a node map.
    1.12      template<class NM>
    1.13        void start(const NM &nm)
    1.14 @@ -663,9 +663,10 @@
    1.15      ///Copies the path to \c t on the DFS tree into \c p
    1.16      
    1.17      ///This function copies the path on the DFS tree to \c t into \c p.
    1.18 -    ///If it \c \t is a source itself or unreachable, then it does not
    1.19 +    ///If \c t is a source itself or unreachable, then it does not
    1.20      ///alter \c p.
    1.21 -    ///\todo Is it the right way to handle unreachable nodes?
    1.22 +    ///\todo Is this the right way to handle unreachable nodes?
    1.23 +    ///
    1.24      ///\return Returns \c true if a path to \c t was actually copied to \c p,
    1.25      ///\c false otherwise.
    1.26      ///\sa DirPath
    1.27 @@ -687,7 +688,7 @@
    1.28  
    1.29      ///Returns the distance of a node from the root(s).
    1.30      ///\pre \ref run() must be called before using this function.
    1.31 -    ///\warning If node \c v in unreachable from the root(s) the return value
    1.32 +    ///\warning If node \c v is unreachable from the root(s) then the return value
    1.33      ///of this funcion is undefined.
    1.34      int dist(Node v) const { return (*_dist)[v]; }
    1.35  
    1.36 @@ -744,8 +745,8 @@
    1.37  
    1.38      ///Checks if a node is reachable from the root.
    1.39  
    1.40 -    ///Returns \c true if \c v is reachable from the root.
    1.41 -    ///\warning The source nodes are inditated as unreached.
    1.42 +    ///Returns \c true if \c v is reachable from the root(s).
    1.43 +    ///\warning The source nodes are inditated as unreachable.
    1.44      ///\pre Either \ref run() or \ref start()
    1.45      ///must be called before using this function.
    1.46      ///
    1.47 @@ -916,7 +917,7 @@
    1.48    /// return the needed class.
    1.49    ///
    1.50    /// It does not have own \ref run method. When its \ref run method is called
    1.51 -  /// it initiates a plain \ref Dfs class, and calls the \ref Dfs::run
    1.52 +  /// it initiates a plain \ref Dfs object, and calls the \ref Dfs::run
    1.53    /// method of it.
    1.54    template<class TR>
    1.55    class DfsWizard : public TR