Changeset 1124:12623f7ecb37 in lemon-0.x for src/work

Timestamp:

02/05/05 14:40:01 (20 years ago)

Author:

Hegyi Péter

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1523

Message:

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

File:

• src/work/alpar/dijkstra.h (modified) (12 diffs)

src/work/alpar/dijkstra.h

@@ -49 +49 @@
     ///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.
@@ -68 +68 @@
     ///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.
     ///
@@ -83 +85 @@
     ///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.
     ///
@@ -97 +101 @@
     ///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.
@@ -112 +117 @@
     ///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.
     ///
@@ -510 +516 @@
   /// 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.
@@ -565 +571 @@
   /// 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.
   ///
@@ -609 +615 @@
 
     /// 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) :
@@ -632 +640 @@
     }
 
-    ///Runs Dijkstra algorithm from a given node.
-
-    ///Runs Dijkstra algorithm from a given node.
+    ///Runs Dijkstra algorithm from the given node.
+
+    ///Runs Dijkstra algorithm from the given node.
     ///\param s is the given source.
     void run(Node s)
@@ -652 +660 @@
 
     /// \ref named-templ-param "Named parameter" function for setting PredMap type
+    ///
     template<class T>
     DijkstraWizard<DefPredMapBase<T> > predMap(const T &t) 
@@ -670 +679 @@
 
     /// \ref named-templ-param "Named parameter" function for setting PredNodeMap type
+    ///
     template<class T>
     DijkstraWizard<DefPredNodeMapBase<T> > predNodeMap(const T &t) 
@@ -687 +697 @@
 
     /// \ref named-templ-param "Named parameter" function for setting DistMap type
+    ///
     template<class T>
     DijkstraWizard<DefDistMapBase<T> > distMap(const T &t)