Changeset 1953:d4f411003580 in lemon-0.x for lemon/prim.h

Timestamp:

02/03/06 16:58:24 (18 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

Polish the doc.

File:

• lemon/prim.h (modified) (6 diffs)

lemon/prim.h

@@ -57 +57 @@
 
     ///This function instantiates a \ref HeapCrossRef. 
-    /// \param G is the graph, to which we would like to define the 
+    /// \param _graph is the graph, to which we would like to define the 
     /// HeapCrossRef.
     static HeapCrossRef *createHeapCrossRef(const GR &_graph){
@@ -87 +87 @@
  
     ///This function instantiates a \ref PredMap. 
-    ///\param G is the graph, to which we would like to define the PredMap.
+    ///\param _graph is the graph, to which we would like to define the PredMap.
     static PredMap *createPredMap(const GR &_graph){
       return new PredMap(_graph);
@@ -102 +102 @@
 
     ///This function instantiates a \ref TreeMap.
-    ///\param g is the graph, to which
+    ///
+    ///The first parameter is the graph, to which
     ///we would like to define the \ref TreeMap
     static TreeMap *createTreeMap(const GR &){
@@ -117 +118 @@
  
     ///This function instantiates a \ref ProcessedMap. 
-    ///\param g is the graph, to which
+    ///\param _graph is the graph, to which
     ///we would like to define the \ref ProcessedMap
 #ifdef DOXYGEN
@@ -704 +705 @@
     ///Sets the TreeMap of the edges of the minimum spanning tree.
     ///The map values belonging to the edges of the minimum
-    ///spanning tree are set to \param tree_edge_value or \c true by default,
+    ///spanning tree are set to \c tree_edge_value or \c true by default,
     ///the other map values remain untouched.
     ///
@@ -722 +723 @@
     ///Sets the TreeMap of the edges of the minimum spanning tree.
     ///The map values belonging to the edges of the minimum
-    ///spanning tree are set to \param tree_edge_value or \c true by default while
+    ///spanning tree are set to \c tree_edge_value or \c true by default while
     ///the edge values not belonging to the minimum spanning tree are set to
-    ///\param tree_default_value or \c false by default.
+    ///\c tree_default_value or \c false by default.
     ///
     ///\pre \ref run() or \ref start() must be called before using this function.