Small doc improvements (#304)
authorPeter Kovacs <kpeter@inf.elte.hu>
Sun, 02 Aug 2009 12:40:20 +0200
changeset 716f47b6c94577e
parent 680 257e91516e09
child 717 684964884a2e
Small doc improvements (#304)
lemon/bfs.h
lemon/dfs.h
lemon/dijkstra.h
lemon/maps.h
     1.1 --- a/lemon/bfs.h	Fri May 29 17:46:48 2009 +0100
     1.2 +++ b/lemon/bfs.h	Sun Aug 02 12:40:20 2009 +0200
     1.3 @@ -47,7 +47,7 @@
     1.4      ///
     1.5      ///The type of the map that stores the predecessor
     1.6      ///arcs of the shortest paths.
     1.7 -    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
     1.8 +    ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
     1.9      typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
    1.10      ///Instantiates a \c PredMap.
    1.11  
    1.12 @@ -62,7 +62,8 @@
    1.13      ///The type of the map that indicates which nodes are processed.
    1.14  
    1.15      ///The type of the map that indicates which nodes are processed.
    1.16 -    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
    1.17 +    ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
    1.18 +    ///By default it is a NullMap.
    1.19      typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
    1.20      ///Instantiates a \c ProcessedMap.
    1.21  
    1.22 @@ -81,7 +82,7 @@
    1.23      ///The type of the map that indicates which nodes are reached.
    1.24  
    1.25      ///The type of the map that indicates which nodes are reached.
    1.26 -    ///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
    1.27 +    ///It must conform to the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
    1.28      typedef typename Digraph::template NodeMap<bool> ReachedMap;
    1.29      ///Instantiates a \c ReachedMap.
    1.30  
    1.31 @@ -96,7 +97,7 @@
    1.32      ///The type of the map that stores the distances of the nodes.
    1.33  
    1.34      ///The type of the map that stores the distances of the nodes.
    1.35 -    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
    1.36 +    ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
    1.37      typedef typename Digraph::template NodeMap<int> DistMap;
    1.38      ///Instantiates a \c DistMap.
    1.39  
    1.40 @@ -225,7 +226,7 @@
    1.41      ///
    1.42      ///\ref named-templ-param "Named parameter" for setting
    1.43      ///\c PredMap type.
    1.44 -    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
    1.45 +    ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
    1.46      template <class T>
    1.47      struct SetPredMap : public Bfs< Digraph, SetPredMapTraits<T> > {
    1.48        typedef Bfs< Digraph, SetPredMapTraits<T> > Create;
    1.49 @@ -245,7 +246,7 @@
    1.50      ///
    1.51      ///\ref named-templ-param "Named parameter" for setting
    1.52      ///\c DistMap type.
    1.53 -    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
    1.54 +    ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
    1.55      template <class T>
    1.56      struct SetDistMap : public Bfs< Digraph, SetDistMapTraits<T> > {
    1.57        typedef Bfs< Digraph, SetDistMapTraits<T> > Create;
    1.58 @@ -265,7 +266,7 @@
    1.59      ///
    1.60      ///\ref named-templ-param "Named parameter" for setting
    1.61      ///\c ReachedMap type.
    1.62 -    ///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
    1.63 +    ///It must conform to the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
    1.64      template <class T>
    1.65      struct SetReachedMap : public Bfs< Digraph, SetReachedMapTraits<T> > {
    1.66        typedef Bfs< Digraph, SetReachedMapTraits<T> > Create;
    1.67 @@ -285,7 +286,7 @@
    1.68      ///
    1.69      ///\ref named-templ-param "Named parameter" for setting
    1.70      ///\c ProcessedMap type.
    1.71 -    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
    1.72 +    ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
    1.73      template <class T>
    1.74      struct SetProcessedMap : public Bfs< Digraph, SetProcessedMapTraits<T> > {
    1.75        typedef Bfs< Digraph, SetProcessedMapTraits<T> > Create;
    1.76 @@ -737,9 +738,9 @@
    1.77  
    1.78      ///@{
    1.79  
    1.80 -    ///The shortest path to a node.
    1.81 +    ///The shortest path to the given node.
    1.82  
    1.83 -    ///Returns the shortest path to a node.
    1.84 +    ///Returns the shortest path to the given node from the root(s).
    1.85      ///
    1.86      ///\warning \c t should be reached from the root(s).
    1.87      ///
    1.88 @@ -747,9 +748,9 @@
    1.89      ///must be called before using this function.
    1.90      Path path(Node t) const { return Path(*G, *_pred, t); }
    1.91  
    1.92 -    ///The distance of a node from the root(s).
    1.93 +    ///The distance of the given node from the root(s).
    1.94  
    1.95 -    ///Returns the distance of a node from the root(s).
    1.96 +    ///Returns the distance of the given node from the root(s).
    1.97      ///
    1.98      ///\warning If node \c v is not reached from the root(s), then
    1.99      ///the return value of this function is undefined.
   1.100 @@ -758,29 +759,31 @@
   1.101      ///must be called before using this function.
   1.102      int dist(Node v) const { return (*_dist)[v]; }
   1.103  
   1.104 -    ///Returns the 'previous arc' of the shortest path tree for a node.
   1.105 -
   1.106 +    ///\brief Returns the 'previous arc' of the shortest path tree for
   1.107 +    ///the given node.
   1.108 +    ///
   1.109      ///This function returns the 'previous arc' of the shortest path
   1.110      ///tree for the node \c v, i.e. it returns the last arc of a
   1.111      ///shortest path from a root to \c v. It is \c INVALID if \c v
   1.112      ///is not reached from the root(s) or if \c v is a root.
   1.113      ///
   1.114      ///The shortest path tree used here is equal to the shortest path
   1.115 -    ///tree used in \ref predNode().
   1.116 +    ///tree used in \ref predNode() and \ref predMap().
   1.117      ///
   1.118      ///\pre Either \ref run(Node) "run()" or \ref init()
   1.119      ///must be called before using this function.
   1.120      Arc predArc(Node v) const { return (*_pred)[v];}
   1.121  
   1.122 -    ///Returns the 'previous node' of the shortest path tree for a node.
   1.123 -
   1.124 +    ///\brief Returns the 'previous node' of the shortest path tree for
   1.125 +    ///the given node.
   1.126 +    ///
   1.127      ///This function returns the 'previous node' of the shortest path
   1.128      ///tree for the node \c v, i.e. it returns the last but one node
   1.129 -    ///from a shortest path from a root to \c v. It is \c INVALID
   1.130 +    ///of a shortest path from a root to \c v. It is \c INVALID
   1.131      ///if \c v is not reached from the root(s) or if \c v is a root.
   1.132      ///
   1.133      ///The shortest path tree used here is equal to the shortest path
   1.134 -    ///tree used in \ref predArc().
   1.135 +    ///tree used in \ref predArc() and \ref predMap().
   1.136      ///
   1.137      ///\pre Either \ref run(Node) "run()" or \ref init()
   1.138      ///must be called before using this function.
   1.139 @@ -801,13 +804,13 @@
   1.140      ///predecessor arcs.
   1.141      ///
   1.142      ///Returns a const reference to the node map that stores the predecessor
   1.143 -    ///arcs, which form the shortest path tree.
   1.144 +    ///arcs, which form the shortest path tree (forest).
   1.145      ///
   1.146      ///\pre Either \ref run(Node) "run()" or \ref init()
   1.147      ///must be called before using this function.
   1.148      const PredMap &predMap() const { return *_pred;}
   1.149  
   1.150 -    ///Checks if a node is reached from the root(s).
   1.151 +    ///Checks if the given node is reached from the root(s).
   1.152  
   1.153      ///Returns \c true if \c v is reached from the root(s).
   1.154      ///
   1.155 @@ -833,7 +836,7 @@
   1.156      ///
   1.157      ///The type of the map that stores the predecessor
   1.158      ///arcs of the shortest paths.
   1.159 -    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
   1.160 +    ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
   1.161      typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
   1.162      ///Instantiates a PredMap.
   1.163  
   1.164 @@ -848,7 +851,7 @@
   1.165      ///The type of the map that indicates which nodes are processed.
   1.166  
   1.167      ///The type of the map that indicates which nodes are processed.
   1.168 -    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
   1.169 +    ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
   1.170      ///By default it is a NullMap.
   1.171      typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
   1.172      ///Instantiates a ProcessedMap.
   1.173 @@ -868,7 +871,7 @@
   1.174      ///The type of the map that indicates which nodes are reached.
   1.175  
   1.176      ///The type of the map that indicates which nodes are reached.
   1.177 -    ///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
   1.178 +    ///It must conform to the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
   1.179      typedef typename Digraph::template NodeMap<bool> ReachedMap;
   1.180      ///Instantiates a ReachedMap.
   1.181  
   1.182 @@ -883,7 +886,7 @@
   1.183      ///The type of the map that stores the distances of the nodes.
   1.184  
   1.185      ///The type of the map that stores the distances of the nodes.
   1.186 -    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
   1.187 +    ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
   1.188      typedef typename Digraph::template NodeMap<int> DistMap;
   1.189      ///Instantiates a DistMap.
   1.190  
   1.191 @@ -898,18 +901,14 @@
   1.192      ///The type of the shortest paths.
   1.193  
   1.194      ///The type of the shortest paths.
   1.195 -    ///It must meet the \ref concepts::Path "Path" concept.
   1.196 +    ///It must conform to the \ref concepts::Path "Path" concept.
   1.197      typedef lemon::Path<Digraph> Path;
   1.198    };
   1.199  
   1.200    /// Default traits class used by BfsWizard
   1.201  
   1.202 -  /// To make it easier to use Bfs algorithm
   1.203 -  /// we have created a wizard class.
   1.204 -  /// This \ref BfsWizard class needs default traits,
   1.205 -  /// as well as the \ref Bfs class.
   1.206 -  /// The \ref BfsWizardBase is a class to be the default traits of the
   1.207 -  /// \ref BfsWizard class.
   1.208 +  /// Default traits class used by BfsWizard.
   1.209 +  /// \tparam GR The type of the digraph.
   1.210    template<class GR>
   1.211    class BfsWizardBase : public BfsWizardDefaultTraits<GR>
   1.212    {
   1.213 @@ -937,7 +936,7 @@
   1.214      public:
   1.215      /// Constructor.
   1.216  
   1.217 -    /// This constructor does not require parameters, therefore it initiates
   1.218 +    /// This constructor does not require parameters, it initiates
   1.219      /// all of the attributes to \c 0.
   1.220      BfsWizardBase() : _g(0), _reached(0), _processed(0), _pred(0),
   1.221                        _dist(0), _path(0), _di(0) {}
   1.222 @@ -967,7 +966,6 @@
   1.223    {
   1.224      typedef TR Base;
   1.225  
   1.226 -    ///The type of the digraph the algorithm runs on.
   1.227      typedef typename TR::Digraph Digraph;
   1.228  
   1.229      typedef typename Digraph::Node Node;
   1.230 @@ -975,16 +973,10 @@
   1.231      typedef typename Digraph::Arc Arc;
   1.232      typedef typename Digraph::OutArcIt OutArcIt;
   1.233  
   1.234 -    ///\brief The type of the map that stores the predecessor
   1.235 -    ///arcs of the shortest paths.
   1.236      typedef typename TR::PredMap PredMap;
   1.237 -    ///\brief The type of the map that stores the distances of the nodes.
   1.238      typedef typename TR::DistMap DistMap;
   1.239 -    ///\brief The type of the map that indicates which nodes are reached.
   1.240      typedef typename TR::ReachedMap ReachedMap;
   1.241 -    ///\brief The type of the map that indicates which nodes are processed.
   1.242      typedef typename TR::ProcessedMap ProcessedMap;
   1.243 -    ///The type of the shortest paths
   1.244      typedef typename TR::Path Path;
   1.245  
   1.246    public:
   1.247 @@ -1067,11 +1059,12 @@
   1.248        static PredMap *createPredMap(const Digraph &) { return 0; };
   1.249        SetPredMapBase(const TR &b) : TR(b) {}
   1.250      };
   1.251 -    ///\brief \ref named-func-param "Named parameter"
   1.252 -    ///for setting PredMap object.
   1.253 +
   1.254 +    ///\brief \ref named-templ-param "Named parameter" for setting
   1.255 +    ///the predecessor map.
   1.256      ///
   1.257 -    ///\ref named-func-param "Named parameter"
   1.258 -    ///for setting PredMap object.
   1.259 +    ///\ref named-templ-param "Named parameter" function for setting
   1.260 +    ///the map that stores the predecessor arcs of the nodes.
   1.261      template<class T>
   1.262      BfsWizard<SetPredMapBase<T> > predMap(const T &t)
   1.263      {
   1.264 @@ -1085,11 +1078,12 @@
   1.265        static ReachedMap *createReachedMap(const Digraph &) { return 0; };
   1.266        SetReachedMapBase(const TR &b) : TR(b) {}
   1.267      };
   1.268 -    ///\brief \ref named-func-param "Named parameter"
   1.269 -    ///for setting ReachedMap object.
   1.270 +
   1.271 +    ///\brief \ref named-templ-param "Named parameter" for setting
   1.272 +    ///the reached map.
   1.273      ///
   1.274 -    /// \ref named-func-param "Named parameter"
   1.275 -    ///for setting ReachedMap object.
   1.276 +    ///\ref named-templ-param "Named parameter" function for setting
   1.277 +    ///the map that indicates which nodes are reached.
   1.278      template<class T>
   1.279      BfsWizard<SetReachedMapBase<T> > reachedMap(const T &t)
   1.280      {
   1.281 @@ -1103,11 +1097,13 @@
   1.282        static DistMap *createDistMap(const Digraph &) { return 0; };
   1.283        SetDistMapBase(const TR &b) : TR(b) {}
   1.284      };
   1.285 -    ///\brief \ref named-func-param "Named parameter"
   1.286 -    ///for setting DistMap object.
   1.287 +
   1.288 +    ///\brief \ref named-templ-param "Named parameter" for setting
   1.289 +    ///the distance map.
   1.290      ///
   1.291 -    /// \ref named-func-param "Named parameter"
   1.292 -    ///for setting DistMap object.
   1.293 +    ///\ref named-templ-param "Named parameter" function for setting
   1.294 +    ///the map that stores the distances of the nodes calculated
   1.295 +    ///by the algorithm.
   1.296      template<class T>
   1.297      BfsWizard<SetDistMapBase<T> > distMap(const T &t)
   1.298      {
   1.299 @@ -1121,11 +1117,12 @@
   1.300        static ProcessedMap *createProcessedMap(const Digraph &) { return 0; };
   1.301        SetProcessedMapBase(const TR &b) : TR(b) {}
   1.302      };
   1.303 -    ///\brief \ref named-func-param "Named parameter"
   1.304 -    ///for setting ProcessedMap object.
   1.305 +
   1.306 +    ///\brief \ref named-func-param "Named parameter" for setting
   1.307 +    ///the processed map.
   1.308      ///
   1.309 -    /// \ref named-func-param "Named parameter"
   1.310 -    ///for setting ProcessedMap object.
   1.311 +    ///\ref named-templ-param "Named parameter" function for setting
   1.312 +    ///the map that indicates which nodes are processed.
   1.313      template<class T>
   1.314      BfsWizard<SetProcessedMapBase<T> > processedMap(const T &t)
   1.315      {
   1.316 @@ -1264,7 +1261,7 @@
   1.317      /// \brief The type of the map that indicates which nodes are reached.
   1.318      ///
   1.319      /// The type of the map that indicates which nodes are reached.
   1.320 -    /// It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
   1.321 +    /// It must conform to the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
   1.322      typedef typename Digraph::template NodeMap<bool> ReachedMap;
   1.323  
   1.324      /// \brief Instantiates a ReachedMap.
   1.325 @@ -1735,7 +1732,7 @@
   1.326  
   1.327      ///@{
   1.328  
   1.329 -    /// \brief Checks if a node is reached from the root(s).
   1.330 +    /// \brief Checks if the given node is reached from the root(s).
   1.331      ///
   1.332      /// Returns \c true if \c v is reached from the root(s).
   1.333      ///
     2.1 --- a/lemon/dfs.h	Fri May 29 17:46:48 2009 +0100
     2.2 +++ b/lemon/dfs.h	Sun Aug 02 12:40:20 2009 +0200
     2.3 @@ -47,7 +47,7 @@
     2.4      ///
     2.5      ///The type of the map that stores the predecessor
     2.6      ///arcs of the %DFS paths.
     2.7 -    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
     2.8 +    ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
     2.9      typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
    2.10      ///Instantiates a \c PredMap.
    2.11  
    2.12 @@ -62,7 +62,8 @@
    2.13      ///The type of the map that indicates which nodes are processed.
    2.14  
    2.15      ///The type of the map that indicates which nodes are processed.
    2.16 -    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
    2.17 +    ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
    2.18 +    ///By default it is a NullMap.
    2.19      typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
    2.20      ///Instantiates a \c ProcessedMap.
    2.21  
    2.22 @@ -81,7 +82,7 @@
    2.23      ///The type of the map that indicates which nodes are reached.
    2.24  
    2.25      ///The type of the map that indicates which nodes are reached.
    2.26 -    ///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
    2.27 +    ///It must conform to the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
    2.28      typedef typename Digraph::template NodeMap<bool> ReachedMap;
    2.29      ///Instantiates a \c ReachedMap.
    2.30  
    2.31 @@ -96,7 +97,7 @@
    2.32      ///The type of the map that stores the distances of the nodes.
    2.33  
    2.34      ///The type of the map that stores the distances of the nodes.
    2.35 -    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
    2.36 +    ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
    2.37      typedef typename Digraph::template NodeMap<int> DistMap;
    2.38      ///Instantiates a \c DistMap.
    2.39  
    2.40 @@ -224,7 +225,7 @@
    2.41      ///
    2.42      ///\ref named-templ-param "Named parameter" for setting
    2.43      ///\c PredMap type.
    2.44 -    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
    2.45 +    ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
    2.46      template <class T>
    2.47      struct SetPredMap : public Dfs<Digraph, SetPredMapTraits<T> > {
    2.48        typedef Dfs<Digraph, SetPredMapTraits<T> > Create;
    2.49 @@ -244,7 +245,7 @@
    2.50      ///
    2.51      ///\ref named-templ-param "Named parameter" for setting
    2.52      ///\c DistMap type.
    2.53 -    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
    2.54 +    ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
    2.55      template <class T>
    2.56      struct SetDistMap : public Dfs< Digraph, SetDistMapTraits<T> > {
    2.57        typedef Dfs<Digraph, SetDistMapTraits<T> > Create;
    2.58 @@ -264,7 +265,7 @@
    2.59      ///
    2.60      ///\ref named-templ-param "Named parameter" for setting
    2.61      ///\c ReachedMap type.
    2.62 -    ///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
    2.63 +    ///It must conform to the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
    2.64      template <class T>
    2.65      struct SetReachedMap : public Dfs< Digraph, SetReachedMapTraits<T> > {
    2.66        typedef Dfs< Digraph, SetReachedMapTraits<T> > Create;
    2.67 @@ -284,7 +285,7 @@
    2.68      ///
    2.69      ///\ref named-templ-param "Named parameter" for setting
    2.70      ///\c ProcessedMap type.
    2.71 -    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
    2.72 +    ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
    2.73      template <class T>
    2.74      struct SetProcessedMap : public Dfs< Digraph, SetProcessedMapTraits<T> > {
    2.75        typedef Dfs< Digraph, SetProcessedMapTraits<T> > Create;
    2.76 @@ -669,9 +670,9 @@
    2.77  
    2.78      ///@{
    2.79  
    2.80 -    ///The DFS path to a node.
    2.81 +    ///The DFS path to the given node.
    2.82  
    2.83 -    ///Returns the DFS path to a node.
    2.84 +    ///Returns the DFS path to the given node from the root(s).
    2.85      ///
    2.86      ///\warning \c t should be reached from the root(s).
    2.87      ///
    2.88 @@ -679,9 +680,9 @@
    2.89      ///must be called before using this function.
    2.90      Path path(Node t) const { return Path(*G, *_pred, t); }
    2.91  
    2.92 -    ///The distance of a node from the root(s).
    2.93 +    ///The distance of the given node from the root(s).
    2.94  
    2.95 -    ///Returns the distance of a node from the root(s).
    2.96 +    ///Returns the distance of the given node from the root(s).
    2.97      ///
    2.98      ///\warning If node \c v is not reached from the root(s), then
    2.99      ///the return value of this function is undefined.
   2.100 @@ -690,7 +691,7 @@
   2.101      ///must be called before using this function.
   2.102      int dist(Node v) const { return (*_dist)[v]; }
   2.103  
   2.104 -    ///Returns the 'previous arc' of the %DFS tree for a node.
   2.105 +    ///Returns the 'previous arc' of the %DFS tree for the given node.
   2.106  
   2.107      ///This function returns the 'previous arc' of the %DFS tree for the
   2.108      ///node \c v, i.e. it returns the last arc of a %DFS path from a
   2.109 @@ -698,21 +699,21 @@
   2.110      ///root(s) or if \c v is a root.
   2.111      ///
   2.112      ///The %DFS tree used here is equal to the %DFS tree used in
   2.113 -    ///\ref predNode().
   2.114 +    ///\ref predNode() and \ref predMap().
   2.115      ///
   2.116      ///\pre Either \ref run(Node) "run()" or \ref init()
   2.117      ///must be called before using this function.
   2.118      Arc predArc(Node v) const { return (*_pred)[v];}
   2.119  
   2.120 -    ///Returns the 'previous node' of the %DFS tree.
   2.121 +    ///Returns the 'previous node' of the %DFS tree for the given node.
   2.122  
   2.123      ///This function returns the 'previous node' of the %DFS
   2.124      ///tree for the node \c v, i.e. it returns the last but one node
   2.125 -    ///from a %DFS path from a root to \c v. It is \c INVALID
   2.126 +    ///of a %DFS path from a root to \c v. It is \c INVALID
   2.127      ///if \c v is not reached from the root(s) or if \c v is a root.
   2.128      ///
   2.129      ///The %DFS tree used here is equal to the %DFS tree used in
   2.130 -    ///\ref predArc().
   2.131 +    ///\ref predArc() and \ref predMap().
   2.132      ///
   2.133      ///\pre Either \ref run(Node) "run()" or \ref init()
   2.134      ///must be called before using this function.
   2.135 @@ -733,13 +734,13 @@
   2.136      ///predecessor arcs.
   2.137      ///
   2.138      ///Returns a const reference to the node map that stores the predecessor
   2.139 -    ///arcs, which form the DFS tree.
   2.140 +    ///arcs, which form the DFS tree (forest).
   2.141      ///
   2.142      ///\pre Either \ref run(Node) "run()" or \ref init()
   2.143      ///must be called before using this function.
   2.144      const PredMap &predMap() const { return *_pred;}
   2.145  
   2.146 -    ///Checks if a node is reached from the root(s).
   2.147 +    ///Checks if the given node. node is reached from the root(s).
   2.148  
   2.149      ///Returns \c true if \c v is reached from the root(s).
   2.150      ///
   2.151 @@ -765,7 +766,7 @@
   2.152      ///
   2.153      ///The type of the map that stores the predecessor
   2.154      ///arcs of the %DFS paths.
   2.155 -    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
   2.156 +    ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
   2.157      typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
   2.158      ///Instantiates a PredMap.
   2.159  
   2.160 @@ -780,7 +781,7 @@
   2.161      ///The type of the map that indicates which nodes are processed.
   2.162  
   2.163      ///The type of the map that indicates which nodes are processed.
   2.164 -    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
   2.165 +    ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
   2.166      ///By default it is a NullMap.
   2.167      typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
   2.168      ///Instantiates a ProcessedMap.
   2.169 @@ -800,7 +801,7 @@
   2.170      ///The type of the map that indicates which nodes are reached.
   2.171  
   2.172      ///The type of the map that indicates which nodes are reached.
   2.173 -    ///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
   2.174 +    ///It must conform to the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
   2.175      typedef typename Digraph::template NodeMap<bool> ReachedMap;
   2.176      ///Instantiates a ReachedMap.
   2.177  
   2.178 @@ -815,7 +816,7 @@
   2.179      ///The type of the map that stores the distances of the nodes.
   2.180  
   2.181      ///The type of the map that stores the distances of the nodes.
   2.182 -    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
   2.183 +    ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
   2.184      typedef typename Digraph::template NodeMap<int> DistMap;
   2.185      ///Instantiates a DistMap.
   2.186  
   2.187 @@ -830,18 +831,14 @@
   2.188      ///The type of the DFS paths.
   2.189  
   2.190      ///The type of the DFS paths.
   2.191 -    ///It must meet the \ref concepts::Path "Path" concept.
   2.192 +    ///It must conform to the \ref concepts::Path "Path" concept.
   2.193      typedef lemon::Path<Digraph> Path;
   2.194    };
   2.195  
   2.196    /// Default traits class used by DfsWizard
   2.197  
   2.198 -  /// To make it easier to use Dfs algorithm
   2.199 -  /// we have created a wizard class.
   2.200 -  /// This \ref DfsWizard class needs default traits,
   2.201 -  /// as well as the \ref Dfs class.
   2.202 -  /// The \ref DfsWizardBase is a class to be the default traits of the
   2.203 -  /// \ref DfsWizard class.
   2.204 +  /// Default traits class used by DfsWizard.
   2.205 +  /// \tparam GR The type of the digraph.
   2.206    template<class GR>
   2.207    class DfsWizardBase : public DfsWizardDefaultTraits<GR>
   2.208    {
   2.209 @@ -869,7 +866,7 @@
   2.210      public:
   2.211      /// Constructor.
   2.212  
   2.213 -    /// This constructor does not require parameters, therefore it initiates
   2.214 +    /// This constructor does not require parameters, it initiates
   2.215      /// all of the attributes to \c 0.
   2.216      DfsWizardBase() : _g(0), _reached(0), _processed(0), _pred(0),
   2.217                        _dist(0), _path(0), _di(0) {}
   2.218 @@ -899,7 +896,6 @@
   2.219    {
   2.220      typedef TR Base;
   2.221  
   2.222 -    ///The type of the digraph the algorithm runs on.
   2.223      typedef typename TR::Digraph Digraph;
   2.224  
   2.225      typedef typename Digraph::Node Node;
   2.226 @@ -907,16 +903,10 @@
   2.227      typedef typename Digraph::Arc Arc;
   2.228      typedef typename Digraph::OutArcIt OutArcIt;
   2.229  
   2.230 -    ///\brief The type of the map that stores the predecessor
   2.231 -    ///arcs of the DFS paths.
   2.232      typedef typename TR::PredMap PredMap;
   2.233 -    ///\brief The type of the map that stores the distances of the nodes.
   2.234      typedef typename TR::DistMap DistMap;
   2.235 -    ///\brief The type of the map that indicates which nodes are reached.
   2.236      typedef typename TR::ReachedMap ReachedMap;
   2.237 -    ///\brief The type of the map that indicates which nodes are processed.
   2.238      typedef typename TR::ProcessedMap ProcessedMap;
   2.239 -    ///The type of the DFS paths
   2.240      typedef typename TR::Path Path;
   2.241  
   2.242    public:
   2.243 @@ -999,11 +989,12 @@
   2.244        static PredMap *createPredMap(const Digraph &) { return 0; };
   2.245        SetPredMapBase(const TR &b) : TR(b) {}
   2.246      };
   2.247 -    ///\brief \ref named-func-param "Named parameter"
   2.248 -    ///for setting PredMap object.
   2.249 +
   2.250 +    ///\brief \ref named-templ-param "Named parameter" for setting
   2.251 +    ///the predecessor map.
   2.252      ///
   2.253 -    ///\ref named-func-param "Named parameter"
   2.254 -    ///for setting PredMap object.
   2.255 +    ///\ref named-templ-param "Named parameter" function for setting
   2.256 +    ///the map that stores the predecessor arcs of the nodes.
   2.257      template<class T>
   2.258      DfsWizard<SetPredMapBase<T> > predMap(const T &t)
   2.259      {
   2.260 @@ -1017,11 +1008,12 @@
   2.261        static ReachedMap *createReachedMap(const Digraph &) { return 0; };
   2.262        SetReachedMapBase(const TR &b) : TR(b) {}
   2.263      };
   2.264 -    ///\brief \ref named-func-param "Named parameter"
   2.265 -    ///for setting ReachedMap object.
   2.266 +
   2.267 +    ///\brief \ref named-templ-param "Named parameter" for setting
   2.268 +    ///the reached map.
   2.269      ///
   2.270 -    /// \ref named-func-param "Named parameter"
   2.271 -    ///for setting ReachedMap object.
   2.272 +    ///\ref named-templ-param "Named parameter" function for setting
   2.273 +    ///the map that indicates which nodes are reached.
   2.274      template<class T>
   2.275      DfsWizard<SetReachedMapBase<T> > reachedMap(const T &t)
   2.276      {
   2.277 @@ -1035,11 +1027,13 @@
   2.278        static DistMap *createDistMap(const Digraph &) { return 0; };
   2.279        SetDistMapBase(const TR &b) : TR(b) {}
   2.280      };
   2.281 -    ///\brief \ref named-func-param "Named parameter"
   2.282 -    ///for setting DistMap object.
   2.283 +
   2.284 +    ///\brief \ref named-templ-param "Named parameter" for setting
   2.285 +    ///the distance map.
   2.286      ///
   2.287 -    /// \ref named-func-param "Named parameter"
   2.288 -    ///for setting DistMap object.
   2.289 +    ///\ref named-templ-param "Named parameter" function for setting
   2.290 +    ///the map that stores the distances of the nodes calculated
   2.291 +    ///by the algorithm.
   2.292      template<class T>
   2.293      DfsWizard<SetDistMapBase<T> > distMap(const T &t)
   2.294      {
   2.295 @@ -1053,11 +1047,12 @@
   2.296        static ProcessedMap *createProcessedMap(const Digraph &) { return 0; };
   2.297        SetProcessedMapBase(const TR &b) : TR(b) {}
   2.298      };
   2.299 -    ///\brief \ref named-func-param "Named parameter"
   2.300 -    ///for setting ProcessedMap object.
   2.301 +
   2.302 +    ///\brief \ref named-func-param "Named parameter" for setting
   2.303 +    ///the processed map.
   2.304      ///
   2.305 -    /// \ref named-func-param "Named parameter"
   2.306 -    ///for setting ProcessedMap object.
   2.307 +    ///\ref named-templ-param "Named parameter" function for setting
   2.308 +    ///the map that indicates which nodes are processed.
   2.309      template<class T>
   2.310      DfsWizard<SetProcessedMapBase<T> > processedMap(const T &t)
   2.311      {
   2.312 @@ -1208,7 +1203,7 @@
   2.313      /// \brief The type of the map that indicates which nodes are reached.
   2.314      ///
   2.315      /// The type of the map that indicates which nodes are reached.
   2.316 -    /// It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
   2.317 +    /// It must conform to the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
   2.318      typedef typename Digraph::template NodeMap<bool> ReachedMap;
   2.319  
   2.320      /// \brief Instantiates a ReachedMap.
   2.321 @@ -1620,7 +1615,7 @@
   2.322  
   2.323      ///@{
   2.324  
   2.325 -    /// \brief Checks if a node is reached from the root(s).
   2.326 +    /// \brief Checks if the given node is reached from the root(s).
   2.327      ///
   2.328      /// Returns \c true if \c v is reached from the root(s).
   2.329      ///
     3.1 --- a/lemon/dijkstra.h	Fri May 29 17:46:48 2009 +0100
     3.2 +++ b/lemon/dijkstra.h	Sun Aug 02 12:40:20 2009 +0200
     3.3 @@ -70,9 +70,9 @@
     3.4      ///The type of the map that stores the arc lengths.
     3.5  
     3.6      ///The type of the map that stores the arc lengths.
     3.7 -    ///It must meet the \ref concepts::ReadMap "ReadMap" concept.
     3.8 +    ///It must conform to the \ref concepts::ReadMap "ReadMap" concept.
     3.9      typedef LEN LengthMap;
    3.10 -    ///The type of the length of the arcs.
    3.11 +    ///The type of the arc lengths.
    3.12      typedef typename LEN::Value Value;
    3.13  
    3.14      /// Operation traits for %Dijkstra algorithm.
    3.15 @@ -116,7 +116,7 @@
    3.16      ///
    3.17      ///The type of the map that stores the predecessor
    3.18      ///arcs of the shortest paths.
    3.19 -    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
    3.20 +    ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
    3.21      typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
    3.22      ///Instantiates a \c PredMap.
    3.23  
    3.24 @@ -131,7 +131,7 @@
    3.25      ///The type of the map that indicates which nodes are processed.
    3.26  
    3.27      ///The type of the map that indicates which nodes are processed.
    3.28 -    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
    3.29 +    ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
    3.30      ///By default it is a NullMap.
    3.31      typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
    3.32      ///Instantiates a \c ProcessedMap.
    3.33 @@ -151,7 +151,7 @@
    3.34      ///The type of the map that stores the distances of the nodes.
    3.35  
    3.36      ///The type of the map that stores the distances of the nodes.
    3.37 -    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
    3.38 +    ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
    3.39      typedef typename Digraph::template NodeMap<typename LEN::Value> DistMap;
    3.40      ///Instantiates a \c DistMap.
    3.41  
    3.42 @@ -169,6 +169,10 @@
    3.43    /// \ingroup shortest_path
    3.44    ///This class provides an efficient implementation of the %Dijkstra algorithm.
    3.45    ///
    3.46 +  ///The %Dijkstra algorithm solves the single-source shortest path problem
    3.47 +  ///when all arc lengths are non-negative. If there are negative lengths,
    3.48 +  ///the BellmanFord algorithm should be used instead.
    3.49 +  ///
    3.50    ///The arc lengths are passed to the algorithm using a
    3.51    ///\ref concepts::ReadMap "ReadMap",
    3.52    ///so it is easy to change it to any kind of length.
    3.53 @@ -201,7 +205,7 @@
    3.54      ///The type of the digraph the algorithm runs on.
    3.55      typedef typename TR::Digraph Digraph;
    3.56  
    3.57 -    ///The type of the length of the arcs.
    3.58 +    ///The type of the arc lengths.
    3.59      typedef typename TR::LengthMap::Value Value;
    3.60      ///The type of the map that stores the arc lengths.
    3.61      typedef typename TR::LengthMap LengthMap;
    3.62 @@ -304,7 +308,7 @@
    3.63      ///
    3.64      ///\ref named-templ-param "Named parameter" for setting
    3.65      ///\c PredMap type.
    3.66 -    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
    3.67 +    ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
    3.68      template <class T>
    3.69      struct SetPredMap
    3.70        : public Dijkstra< Digraph, LengthMap, SetPredMapTraits<T> > {
    3.71 @@ -325,7 +329,7 @@
    3.72      ///
    3.73      ///\ref named-templ-param "Named parameter" for setting
    3.74      ///\c DistMap type.
    3.75 -    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
    3.76 +    ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
    3.77      template <class T>
    3.78      struct SetDistMap
    3.79        : public Dijkstra< Digraph, LengthMap, SetDistMapTraits<T> > {
    3.80 @@ -346,7 +350,7 @@
    3.81      ///
    3.82      ///\ref named-templ-param "Named parameter" for setting
    3.83      ///\c ProcessedMap type.
    3.84 -    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
    3.85 +    ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
    3.86      template <class T>
    3.87      struct SetProcessedMap
    3.88        : public Dijkstra< Digraph, LengthMap, SetProcessedMapTraits<T> > {
    3.89 @@ -443,6 +447,7 @@
    3.90      ///
    3.91      ///\ref named-templ-param "Named parameter" for setting
    3.92      ///\c OperationTraits type.
    3.93 +    /// For more information see \ref DijkstraDefaultOperationTraits.
    3.94      template <class T>
    3.95      struct SetOperationTraits
    3.96        : public Dijkstra<Digraph, LengthMap, SetOperationTraitsTraits<T> > {
    3.97 @@ -801,14 +806,14 @@
    3.98      ///\name Query Functions
    3.99      ///The results of the %Dijkstra algorithm can be obtained using these
   3.100      ///functions.\n
   3.101 -    ///Either \ref run(Node) "run()" or \ref start() should be called
   3.102 +    ///Either \ref run(Node) "run()" or \ref init() should be called
   3.103      ///before using them.
   3.104  
   3.105      ///@{
   3.106  
   3.107 -    ///The shortest path to a node.
   3.108 +    ///The shortest path to the given node.
   3.109  
   3.110 -    ///Returns the shortest path to a node.
   3.111 +    ///Returns the shortest path to the given node from the root(s).
   3.112      ///
   3.113      ///\warning \c t should be reached from the root(s).
   3.114      ///
   3.115 @@ -816,9 +821,9 @@
   3.116      ///must be called before using this function.
   3.117      Path path(Node t) const { return Path(*G, *_pred, t); }
   3.118  
   3.119 -    ///The distance of a node from the root(s).
   3.120 +    ///The distance of the given node from the root(s).
   3.121  
   3.122 -    ///Returns the distance of a node from the root(s).
   3.123 +    ///Returns the distance of the given node from the root(s).
   3.124      ///
   3.125      ///\warning If node \c v is not reached from the root(s), then
   3.126      ///the return value of this function is undefined.
   3.127 @@ -827,29 +832,31 @@
   3.128      ///must be called before using this function.
   3.129      Value dist(Node v) const { return (*_dist)[v]; }
   3.130  
   3.131 -    ///Returns the 'previous arc' of the shortest path tree for a node.
   3.132 -
   3.133 +    ///\brief Returns the 'previous arc' of the shortest path tree for
   3.134 +    ///the given node.
   3.135 +    ///
   3.136      ///This function returns the 'previous arc' of the shortest path
   3.137      ///tree for the node \c v, i.e. it returns the last arc of a
   3.138      ///shortest path from a root to \c v. It is \c INVALID if \c v
   3.139      ///is not reached from the root(s) or if \c v is a root.
   3.140      ///
   3.141      ///The shortest path tree used here is equal to the shortest path
   3.142 -    ///tree used in \ref predNode().
   3.143 +    ///tree used in \ref predNode() and \ref predMap().
   3.144      ///
   3.145      ///\pre Either \ref run(Node) "run()" or \ref init()
   3.146      ///must be called before using this function.
   3.147      Arc predArc(Node v) const { return (*_pred)[v]; }
   3.148  
   3.149 -    ///Returns the 'previous node' of the shortest path tree for a node.
   3.150 -
   3.151 +    ///\brief Returns the 'previous node' of the shortest path tree for
   3.152 +    ///the given node.
   3.153 +    ///
   3.154      ///This function returns the 'previous node' of the shortest path
   3.155      ///tree for the node \c v, i.e. it returns the last but one node
   3.156 -    ///from a shortest path from a root to \c v. It is \c INVALID
   3.157 +    ///of a shortest path from a root to \c v. It is \c INVALID
   3.158      ///if \c v is not reached from the root(s) or if \c v is a root.
   3.159      ///
   3.160      ///The shortest path tree used here is equal to the shortest path
   3.161 -    ///tree used in \ref predArc().
   3.162 +    ///tree used in \ref predArc() and \ref predMap().
   3.163      ///
   3.164      ///\pre Either \ref run(Node) "run()" or \ref init()
   3.165      ///must be called before using this function.
   3.166 @@ -870,13 +877,13 @@
   3.167      ///predecessor arcs.
   3.168      ///
   3.169      ///Returns a const reference to the node map that stores the predecessor
   3.170 -    ///arcs, which form the shortest path tree.
   3.171 +    ///arcs, which form the shortest path tree (forest).
   3.172      ///
   3.173      ///\pre Either \ref run(Node) "run()" or \ref init()
   3.174      ///must be called before using this function.
   3.175      const PredMap &predMap() const { return *_pred;}
   3.176  
   3.177 -    ///Checks if a node is reached from the root(s).
   3.178 +    ///Checks if the given node is reached from the root(s).
   3.179  
   3.180      ///Returns \c true if \c v is reached from the root(s).
   3.181      ///
   3.182 @@ -895,9 +902,9 @@
   3.183      bool processed(Node v) const { return (*_heap_cross_ref)[v] ==
   3.184                                            Heap::POST_HEAP; }
   3.185  
   3.186 -    ///The current distance of a node from the root(s).
   3.187 +    ///The current distance of the given node from the root(s).
   3.188  
   3.189 -    ///Returns the current distance of a node from the root(s).
   3.190 +    ///Returns the current distance of the given node from the root(s).
   3.191      ///It may be decreased in the following processes.
   3.192      ///
   3.193      ///\pre Either \ref run(Node) "run()" or \ref init()
   3.194 @@ -924,9 +931,9 @@
   3.195      ///The type of the map that stores the arc lengths.
   3.196  
   3.197      ///The type of the map that stores the arc lengths.
   3.198 -    ///It must meet the \ref concepts::ReadMap "ReadMap" concept.
   3.199 +    ///It must conform to the \ref concepts::ReadMap "ReadMap" concept.
   3.200      typedef LEN LengthMap;
   3.201 -    ///The type of the length of the arcs.
   3.202 +    ///The type of the arc lengths.
   3.203      typedef typename LEN::Value Value;
   3.204  
   3.205      /// Operation traits for Dijkstra algorithm.
   3.206 @@ -973,7 +980,7 @@
   3.207      ///
   3.208      ///The type of the map that stores the predecessor
   3.209      ///arcs of the shortest paths.
   3.210 -    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
   3.211 +    ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
   3.212      typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
   3.213      ///Instantiates a PredMap.
   3.214  
   3.215 @@ -988,7 +995,7 @@
   3.216      ///The type of the map that indicates which nodes are processed.
   3.217  
   3.218      ///The type of the map that indicates which nodes are processed.
   3.219 -    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
   3.220 +    ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
   3.221      ///By default it is a NullMap.
   3.222      typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
   3.223      ///Instantiates a ProcessedMap.
   3.224 @@ -1008,7 +1015,7 @@
   3.225      ///The type of the map that stores the distances of the nodes.
   3.226  
   3.227      ///The type of the map that stores the distances of the nodes.
   3.228 -    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
   3.229 +    ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
   3.230      typedef typename Digraph::template NodeMap<typename LEN::Value> DistMap;
   3.231      ///Instantiates a DistMap.
   3.232  
   3.233 @@ -1023,18 +1030,15 @@
   3.234      ///The type of the shortest paths.
   3.235  
   3.236      ///The type of the shortest paths.
   3.237 -    ///It must meet the \ref concepts::Path "Path" concept.
   3.238 +    ///It must conform to the \ref concepts::Path "Path" concept.
   3.239      typedef lemon::Path<Digraph> Path;
   3.240    };
   3.241  
   3.242    /// Default traits class used by DijkstraWizard
   3.243  
   3.244 -  /// To make it easier to use Dijkstra algorithm
   3.245 -  /// we have created a wizard class.
   3.246 -  /// This \ref DijkstraWizard class needs default traits,
   3.247 -  /// as well as the \ref Dijkstra class.
   3.248 -  /// The \ref DijkstraWizardBase is a class to be the default traits of the
   3.249 -  /// \ref DijkstraWizard class.
   3.250 +  /// Default traits class used by DijkstraWizard.
   3.251 +  /// \tparam GR The type of the digraph.
   3.252 +  /// \tparam LEN The type of the length map.
   3.253    template<typename GR, typename LEN>
   3.254    class DijkstraWizardBase : public DijkstraWizardDefaultTraits<GR,LEN>
   3.255    {
   3.256 @@ -1093,7 +1097,6 @@
   3.257    {
   3.258      typedef TR Base;
   3.259  
   3.260 -    ///The type of the digraph the algorithm runs on.
   3.261      typedef typename TR::Digraph Digraph;
   3.262  
   3.263      typedef typename Digraph::Node Node;
   3.264 @@ -1101,20 +1104,12 @@
   3.265      typedef typename Digraph::Arc Arc;
   3.266      typedef typename Digraph::OutArcIt OutArcIt;
   3.267  
   3.268 -    ///The type of the map that stores the arc lengths.
   3.269      typedef typename TR::LengthMap LengthMap;
   3.270 -    ///The type of the length of the arcs.
   3.271      typedef typename LengthMap::Value Value;
   3.272 -    ///\brief The type of the map that stores the predecessor
   3.273 -    ///arcs of the shortest paths.
   3.274      typedef typename TR::PredMap PredMap;
   3.275 -    ///The type of the map that stores the distances of the nodes.
   3.276      typedef typename TR::DistMap DistMap;
   3.277 -    ///The type of the map that indicates which nodes are processed.
   3.278      typedef typename TR::ProcessedMap ProcessedMap;
   3.279 -    ///The type of the shortest paths
   3.280      typedef typename TR::Path Path;
   3.281 -    ///The heap type used by the dijkstra algorithm.
   3.282      typedef typename TR::Heap Heap;
   3.283  
   3.284    public:
   3.285 @@ -1186,11 +1181,12 @@
   3.286        static PredMap *createPredMap(const Digraph &) { return 0; };
   3.287        SetPredMapBase(const TR &b) : TR(b) {}
   3.288      };
   3.289 -    ///\brief \ref named-func-param "Named parameter"
   3.290 -    ///for setting PredMap object.
   3.291 +
   3.292 +    ///\brief \ref named-templ-param "Named parameter" for setting
   3.293 +    ///the predecessor map.
   3.294      ///
   3.295 -    ///\ref named-func-param "Named parameter"
   3.296 -    ///for setting PredMap object.
   3.297 +    ///\ref named-templ-param "Named parameter" function for setting
   3.298 +    ///the map that stores the predecessor arcs of the nodes.
   3.299      template<class T>
   3.300      DijkstraWizard<SetPredMapBase<T> > predMap(const T &t)
   3.301      {
   3.302 @@ -1204,11 +1200,13 @@
   3.303        static DistMap *createDistMap(const Digraph &) { return 0; };
   3.304        SetDistMapBase(const TR &b) : TR(b) {}
   3.305      };
   3.306 -    ///\brief \ref named-func-param "Named parameter"
   3.307 -    ///for setting DistMap object.
   3.308 +
   3.309 +    ///\brief \ref named-templ-param "Named parameter" for setting
   3.310 +    ///the distance map.
   3.311      ///
   3.312 -    ///\ref named-func-param "Named parameter"
   3.313 -    ///for setting DistMap object.
   3.314 +    ///\ref named-templ-param "Named parameter" function for setting
   3.315 +    ///the map that stores the distances of the nodes calculated
   3.316 +    ///by the algorithm.
   3.317      template<class T>
   3.318      DijkstraWizard<SetDistMapBase<T> > distMap(const T &t)
   3.319      {
   3.320 @@ -1222,11 +1220,12 @@
   3.321        static ProcessedMap *createProcessedMap(const Digraph &) { return 0; };
   3.322        SetProcessedMapBase(const TR &b) : TR(b) {}
   3.323      };
   3.324 -    ///\brief \ref named-func-param "Named parameter"
   3.325 -    ///for setting ProcessedMap object.
   3.326 +
   3.327 +    ///\brief \ref named-func-param "Named parameter" for setting
   3.328 +    ///the processed map.
   3.329      ///
   3.330 -    /// \ref named-func-param "Named parameter"
   3.331 -    ///for setting ProcessedMap object.
   3.332 +    ///\ref named-templ-param "Named parameter" function for setting
   3.333 +    ///the map that indicates which nodes are processed.
   3.334      template<class T>
   3.335      DijkstraWizard<SetProcessedMapBase<T> > processedMap(const T &t)
   3.336      {
   3.337 @@ -1239,6 +1238,7 @@
   3.338        typedef T Path;
   3.339        SetPathBase(const TR &b) : TR(b) {}
   3.340      };
   3.341 +
   3.342      ///\brief \ref named-func-param "Named parameter"
   3.343      ///for getting the shortest path to the target node.
   3.344      ///
     4.1 --- a/lemon/maps.h	Fri May 29 17:46:48 2009 +0100
     4.2 +++ b/lemon/maps.h	Sun Aug 02 12:40:20 2009 +0200
     4.3 @@ -1790,11 +1790,11 @@
     4.4    /// order of Dfs algorithm, as the following examples show.
     4.5    /// \code
     4.6    ///   std::vector<Node> v;
     4.7 -  ///   dfs(g,s).processedMap(loggerBoolMap(std::back_inserter(v))).run();
     4.8 +  ///   dfs(g).processedMap(loggerBoolMap(std::back_inserter(v))).run(s);
     4.9    /// \endcode
    4.10    /// \code
    4.11    ///   std::vector<Node> v(countNodes(g));
    4.12 -  ///   dfs(g,s).processedMap(loggerBoolMap(v.begin())).run();
    4.13 +  ///   dfs(g).processedMap(loggerBoolMap(v.begin())).run(s);
    4.14    /// \endcode
    4.15    ///
    4.16    /// \note The container of the iterator must contain enough space