lemon/path_utils.h
changeset 97 ee1324c91288
parent 96 b55e501a90ee
     1.1 --- a/lemon/path_utils.h	Thu Jan 24 11:31:19 2008 +0000
     1.2 +++ b/lemon/path_utils.h	Thu Jan 24 16:49:10 2008 +0000
     1.3 @@ -90,18 +90,19 @@
     1.4    }
     1.5  
     1.6  
     1.7 -  /// \brief Make of copy of a path.
     1.8 +  /// \brief Make a copy of a path.
     1.9    ///
    1.10 -  ///  Make of copy of a path.
    1.11 +  ///  This function makes a copy of a path.
    1.12    template <typename Target, typename Source>
    1.13    void copyPath(Target& target, const Source& source) {
    1.14      checkConcept<concepts::PathDumper<typename Source::Digraph>, Source>();
    1.15      _path_bits::PathCopySelector<Target, Source>::copy(target, source);
    1.16    }
    1.17  
    1.18 -  /// \brief Checks the path's consistency.
    1.19 +  /// \brief Check the consistency of a path.
    1.20    ///
    1.21 -  /// Checks that each arc's target is the next's source. 
    1.22 +  /// This function checks that the target of each arc is the same
    1.23 +  /// as the source of the next one. 
    1.24    /// 
    1.25    template <typename Digraph, typename Path>
    1.26    bool checkPath(const Digraph& digraph, const Path& path) {
    1.27 @@ -117,31 +118,31 @@
    1.28      return true;
    1.29    }
    1.30  
    1.31 -  /// \brief Gives back the source of the path
    1.32 +  /// \brief The source of a path
    1.33    ///
    1.34 -  /// Gives back the source of the path.
    1.35 +  /// This function returns the source of the given path.
    1.36    template <typename Digraph, typename Path>
    1.37    typename Digraph::Node pathSource(const Digraph& digraph, const Path& path) {
    1.38      return digraph.source(path.front());
    1.39    }
    1.40  
    1.41 -  /// \brief Gives back the target of the path
    1.42 +  /// \brief The target of a path
    1.43    ///
    1.44 -  /// Gives back the target of the path.
    1.45 +  /// This function returns the target of the given path.
    1.46    template <typename Digraph, typename Path>
    1.47    typename Digraph::Node pathTarget(const Digraph& digraph, const Path& path) {
    1.48      return digraph.target(path.back());
    1.49    }
    1.50  
    1.51 -  /// \brief Class which helps to iterate the nodes of a path
    1.52 +  /// \brief Class which helps to iterate through the nodes of a path
    1.53    ///
    1.54    /// In a sense, the path can be treated as a list of arcs. The
    1.55 -  /// lemon path type stores just this list. As a consequence it
    1.56 +  /// lemon path type stores only this list. As a consequence, it
    1.57    /// cannot enumerate the nodes in the path and the zero length paths
    1.58 -  /// cannot store the node.
    1.59 +  /// cannot have a source node.
    1.60    ///
    1.61    /// This class implements the node iterator of a path structure. To
    1.62 -  /// provide this feature, the underlying digraph should be given to
    1.63 +  /// provide this feature, the underlying digraph should be passed to
    1.64    /// the constructor of the iterator.
    1.65    template <typename Path>
    1.66    class PathNodeIt {