Changeset 1946:17eb3eaad9f8 in lemon-0.x for lemon/dag_shortest_path.h

Timestamp:

02/02/06 18:43:24 (18 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

• workaround for a Doxygen 1.4.6 bug
• other doc fixes

File:

• lemon/dag_shortest_path.h (modified) (8 diffs)

lemon/dag_shortest_path.h

@@ -117 +117 @@
     /// 
     /// 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.
     /// \todo The graph alone may be insufficient for the initialization
     static PredMap *createPredMap(const _Graph& graph) {
@@ -134 +135 @@
     ///
     /// This function instantiates a \ref DistMap. 
-    /// \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 
     /// \ref DistMap
     static DistMap *createDistMap(const _Graph& graph) {
@@ -228 +229 @@
     /// 
     /// 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.
     /// \todo The graph alone may be insufficient for the initialization
     static PredMap *createPredMap(const _Graph& graph) {
@@ -245 +247 @@
     ///
     /// This function instantiates a \ref DistMap. 
-    /// \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 
     /// \ref DistMap
     static DistMap *createDistMap(const _Graph& graph) {
@@ -682 +684 @@
     ///
     /// \note d.run(s) is just a shortcut of the following code.
-    /// \code
+    ///\code
     ///  d.init();
     ///  d.addSource(s);
     ///  d.start();
-    /// \endcode
+    ///\endcode
     void run(Node s) {
       init();
@@ -978 +980 @@
     ///
     /// Runs DagShortestPath algorithm from the given node.
-    /// \param s is the given source.
+    /// \param source is the given source.
     void run(Node source) {
       Base::_source = source;
@@ -1043 +1045 @@
     ///
     /// Sets the source node, from which the DagShortestPath algorithm runs.
-    /// \param s is the source node.
+    /// \param source is the source node.
     DagShortestPathWizard<_Traits>& source(Node source) {
       Base::_source = source;
@@ -1061 +1063 @@
   /// The following
   /// example shows how to use these parameters.
-  /// \code
+  ///\code
   /// dagShortestPath(g,length,source).predMap(preds).run();
-  /// \endcode
+  ///\endcode
   /// \warning Don't forget to put the \ref DagShortestPathWizard::run() "run()"
   /// to the end of the parameter list.