Changeset 967:6563019430ba in lemon-0.x for src/work/alpar/dijkstra.h

Timestamp:

11/08/04 16:22:39 (19 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

Several changes in doc.

File:

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

src/work/alpar/dijkstra.h

@@ -43 +43 @@
     ///The type of the map that stores the edge lengths.
 
-    ///It must meet the \ref ReadMap concept.
+    ///It must meet the \ref concept::ReadMap "ReadMap" concept.
     ///
     typedef LM LengthMap;
@@ -49 +49 @@
     typedef typename LM::ValueType ValueType;
     ///The heap type used by Dijkstra algorithm.
+
+    ///The heap type used by Dijkstra algorithm.
+    ///
+    ///\sa BinHeap
+    ///\sa Dijkstra
     typedef BinHeap<typename Graph::Node,
                     typename LM::ValueType,
@@ -57 +62 @@
     ///edges of the shortest paths.
     /// 
-    ///It must meet the \ref WriteMap concept.
+    ///It must meet the \ref concept::WriteMap "WriteMap" concept.
     ///
     typedef typename Graph::template NodeMap<typename GR::Edge> PredMap;
@@ -71 +76 @@
     ///nodes of the shortest paths.
     ///
-    ///It must meet the \ref WriteMap concept.
+    ///It must meet the \ref concept::WriteMap "WriteMap" concept.
     ///
     typedef typename Graph::template NodeMap<typename GR::Node> PredNodeMap;
@@ -77 +82 @@
  
     ///\todo Please document...
-    /// 
+    ///
     static PredNodeMap *createPredNodeMap(const GR &G)
     {
@@ -84 +89 @@
     ///The type of the map that stores the dists of the nodes.
  
-    ///It must meet the \ref WriteMap concept.
+    ///It must meet the \ref concept::WriteMap "WriteMap" concept.
     ///
     typedef typename Graph::template NodeMap<typename LM::ValueType> DistMap;
@@ -167 +172 @@
     ///The heap type used by the dijkstra algorithm.
     typedef typename TR::Heap Heap;
-
   private:
     /// Pointer to the underlying graph.
@@ -225 +229 @@
     ///\ref named-templ-param "Named parameter" for setting PredMap type
 
+    ///\relates Dijkstra
     ///\ingroup flowalgs 
     ///\ref named-templ-param "Named parameter" for setting PredMap type