Documentation review.
authorathos
Thu, 02 Jun 2005 14:43:45 +0000
changeset 144370781827eb2f
parent 1442 1e3c69aa035b
child 1444 5fcd69785959
Documentation review.
lemon/dfs.h
     1.1 --- a/lemon/dfs.h	Wed Jun 01 23:33:26 2005 +0000
     1.2 +++ b/lemon/dfs.h	Thu Jun 02 14:43:45 2005 +0000
     1.3 @@ -499,7 +499,7 @@
     1.4  
     1.5      ///Adds a new source node to the set of nodes to be processed.
     1.6      ///
     1.7 -    ///\bug dist's are wrong (or at least strange) in case of multiple sources.
     1.8 +    ///\bug dists are wrong (or at least strange) in case of multiple sources.
     1.9      void addSource(Node s)
    1.10      {
    1.11        if(!(*_reached)[s])
    1.12 @@ -516,7 +516,7 @@
    1.13  
    1.14      ///Processes the next node.
    1.15      ///
    1.16 -    ///\warning The stack must not be empty!
    1.17 +    ///\pre The stack must not be empty!
    1.18      void processNextEdge()
    1.19      { 
    1.20        Node m;
    1.21 @@ -565,7 +565,7 @@
    1.22      ///compute the
    1.23      ///%DFS path to each node. The algorithm computes
    1.24      ///- The %DFS tree.
    1.25 -    ///- The distance of each node from the root(s).
    1.26 +    ///- The distance of each node from the root(s) in the %DFS tree.
    1.27      ///
    1.28      void start()
    1.29      {
    1.30 @@ -584,7 +584,7 @@
    1.31      ///compute the
    1.32      ///%DFS path to \c dest. The algorithm computes
    1.33      ///- The %DFS path to \c  dest.
    1.34 -    ///- The distance of \c dest from the root(s).
    1.35 +    ///- The distance of \c dest from the root(s) in the %DFS tree.
    1.36      ///
    1.37      void start(Node dest)
    1.38      {
    1.39 @@ -601,6 +601,7 @@
    1.40      ///
    1.41      ///\param nm must be a bool (or convertible) edge map. The algorithm
    1.42      ///will stop when it reaches an edge \c e with <tt>nm[e]==true</tt>.
    1.43 +    ///
    1.44      ///\warning Contrary to \ref Dfs and \ref Dijkstra, \c nm is an edge map,
    1.45      ///not a node map.
    1.46      template<class NM>
    1.47 @@ -616,7 +617,7 @@
    1.48      ///compute the
    1.49      ///%DFS path to each node. The algorithm computes
    1.50      ///- The %DFS tree.
    1.51 -    ///- The distance of each node from the root.
    1.52 +    ///- The distance of each node from the root in the %DFS tree.
    1.53      ///
    1.54      ///\note d.run(s) is just a shortcut of the following code.
    1.55      ///\code
    1.56 @@ -662,7 +663,7 @@
    1.57  
    1.58      ///Copies the path to \c t on the DFS tree into \c p
    1.59      
    1.60 -    ///This function copies the path on the DFS tree to \c t into \c p.
    1.61 +    ///This function copies the path to \c t on the DFS tree  into \c p.
    1.62      ///If \c t is a source itself or unreachable, then it does not
    1.63      ///alter \c p.
    1.64      ///\todo Is this the right way to handle unreachable nodes?
    1.65 @@ -900,9 +901,9 @@
    1.66  
    1.67    };
    1.68    
    1.69 -  /// A class to make the usage of Dfs algorithm easier
    1.70 +  /// A class to make the usage of the Dfs algorithm easier
    1.71  
    1.72 -  /// This class is created to make it easier to use Dfs algorithm.
    1.73 +  /// This class is created to make it easier to use the Dfs algorithm.
    1.74    /// It uses the functions and features of the plain \ref Dfs,
    1.75    /// but it is much simpler to use it.
    1.76    ///
    1.77 @@ -947,7 +948,7 @@
    1.78  //     ///\brief The type of the map that stores the last but one
    1.79  //     ///nodes of the %DFS paths.
    1.80  //     typedef typename TR::PredNodeMap PredNodeMap;
    1.81 -    ///The type of the map that stores the dists of the nodes.
    1.82 +    ///The type of the map that stores the distances of the nodes.
    1.83      typedef typename TR::DistMap DistMap;
    1.84  
    1.85  public: