[Lemon-commits] [lemon_svn] hegyi: r1523 - hugo/trunk/src/work/alpar

[Lemon SVN]

Author: hegyi
Date: Sat Feb  5 14:40:01 2005
New Revision: 1523

Modified:
   hugo/trunk/src/work/alpar/dijkstra.h

Log:
Dijkstra documentation is getting ready, but one decision is missing about naming conventions about named_params

Modified: hugo/trunk/src/work/alpar/dijkstra.h
==============================================================================
--- hugo/trunk/src/work/alpar/dijkstra.h	(original)
+++ hugo/trunk/src/work/alpar/dijkstra.h	Sat Feb  5 14:40:01 2005
@@ -48,8 +48,8 @@
     typedef GR Graph;
     ///The type of the map that stores the edge lengths.
 
+    ///The type of the map that stores the edge lengths.
     ///It must meet the \ref concept::ReadMap "ReadMap" concept.
-    ///
     typedef LM LengthMap;
     //The type of the length of the edges.
     typedef typename LM::Value Value;
@@ -67,6 +67,8 @@
     ///\brief The type of the map that stores the last
     ///edges of the shortest paths.
     /// 
+    ///The type of the map that stores the last
+    ///edges of the shortest paths.
     ///It must meet the \ref concept::WriteMap "WriteMap" concept.
     ///
     typedef typename Graph::template NodeMap<typename GR::Edge> PredMap;
@@ -82,6 +84,8 @@
     ///\brief The type of the map that stores the last but one
     ///nodes of the shortest paths.
     ///
+    ///The type of the map that stores the last but one
+    ///nodes of the shortest paths.
     ///It must meet the \ref concept::WriteMap "WriteMap" concept.
     ///
     typedef typename Graph::template NodeMap<typename GR::Node> PredNodeMap;
@@ -96,6 +100,7 @@
 
     ///The type of the map that stores whether a nodes is reached.
  
+    ///The type of the map that stores whether a nodes is reached.
     ///It must meet the \ref concept::WriteMap "WriteMap" concept.
     ///By default it is a NullMap.
     ///\todo If it is set to a real map, Dijkstra::reached() should read this.
@@ -111,6 +116,7 @@
     }
     ///The type of the map that stores the dists of the nodes.
  
+    ///The type of the map that stores the dists of the nodes.
     ///It must meet the \ref concept::WriteMap "WriteMap" concept.
     ///
     typedef typename Graph::template NodeMap<typename LM::Value> DistMap;
@@ -509,8 +515,8 @@
 
   /// Default traits used by \ref DijkstraWizard
 
-  /// To make it easier to use Dijkstra algorithm we created a wizard class.
-  /// This \ref DijkstraWizard class also needs default traits.
+  /// To make it easier to use Dijkstra algorithm we have created a wizard class.
+  /// This \ref DijkstraWizard class needs default traits, as well as the \ref Dijkstra class.
   /// The \ref DijkstraWizardBase is a class to be the default traits of the
   /// \ref DijkstraWizard class.
   template<class GR,class LM>
@@ -564,9 +570,9 @@
   ///
   /// Simplicity means that the way to change the types defined
   /// in the traits class is based on functions that returns the new class
-  /// and not on templatable built-in classes. When using the plain \Dijkstra
-  /// the new class with the modified type comes from the original by using the ::
-  /// operator. In this case only a function have to be called and it will
+  /// and not on templatable built-in classes. When using the plain \ref Dijkstra
+  /// the new class with the modified type comes from the original class by using the ::
+  /// operator. In the case of \ref DijkstraWizard only a function have to be called and it will
   /// return the needed class.
   ///
   /// It does not have own \ref run method. When its \ref run method is called
@@ -608,6 +614,8 @@
     DijkstraWizard() : TR() {}
 
     /// Constructor that requires parameters.
+
+    /// Constructor that requires parameters.
     /// These parameters will be the default values for the traits class.
     DijkstraWizard(const Graph &g,const LengthMap &l, Node s=INVALID) :
       TR(g,l,s) {}
@@ -631,9 +639,9 @@
       Dij.run(*(Node*)_source);
     }
 
-    ///Runs Dijkstra algorithm from a given node.
+    ///Runs Dijkstra algorithm from the given node.
 
-    ///Runs Dijkstra algorithm from a given node.
+    ///Runs Dijkstra algorithm from the given node.
     ///\param s is the given source.
     void run(Node s)
     {
@@ -651,6 +659,7 @@
     /// \ref named-templ-param "Named parameter" function for setting PredMap type
 
     /// \ref named-templ-param "Named parameter" function for setting PredMap type
+    ///
     template<class T>
     DijkstraWizard<DefPredMapBase<T> > predMap(const T &t) 
     {
@@ -669,6 +678,7 @@
     /// \ref named-templ-param "Named parameter" function for setting PredNodeMap type
 
     /// \ref named-templ-param "Named parameter" function for setting PredNodeMap type
+    ///
     template<class T>
     DijkstraWizard<DefPredNodeMapBase<T> > predNodeMap(const T &t) 
     {
@@ -686,6 +696,7 @@
     /// \ref named-templ-param "Named parameter" function for setting DistMap type
 
     /// \ref named-templ-param "Named parameter" function for setting DistMap type
+    ///
     template<class T>
     DijkstraWizard<DefDistMapBase<T> > distMap(const T &t) 
     {