lemon/dag_shortest_path.h
changeset 1946 17eb3eaad9f8
parent 1912 d9205a711324
child 1956 a055123339d5
     1.1 --- a/lemon/dag_shortest_path.h	Thu Feb 02 17:09:09 2006 +0000
     1.2 +++ b/lemon/dag_shortest_path.h	Thu Feb 02 17:43:24 2006 +0000
     1.3 @@ -116,7 +116,8 @@
     1.4      /// \brief Instantiates a PredMap.
     1.5      /// 
     1.6      /// This function instantiates a \ref PredMap. 
     1.7 -    /// \param G is the graph, to which we would like to define the PredMap.
     1.8 +    /// \param graph is the graph, to which we would
     1.9 +    /// like to define the PredMap.
    1.10      /// \todo The graph alone may be insufficient for the initialization
    1.11      static PredMap *createPredMap(const _Graph& graph) {
    1.12        return new PredMap(graph);
    1.13 @@ -133,7 +134,7 @@
    1.14      /// \brief Instantiates a DistMap.
    1.15      ///
    1.16      /// This function instantiates a \ref DistMap. 
    1.17 -    /// \param G is the graph, to which we would like to define the 
    1.18 +    /// \param graph is the graph, to which we would like to define the 
    1.19      /// \ref DistMap
    1.20      static DistMap *createDistMap(const _Graph& graph) {
    1.21        return new DistMap(graph);
    1.22 @@ -227,7 +228,8 @@
    1.23      /// \brief Instantiates a PredMap.
    1.24      /// 
    1.25      /// This function instantiates a \ref PredMap. 
    1.26 -    /// \param G is the graph, to which we would like to define the PredMap.
    1.27 +    /// \param graph is the graph,
    1.28 +    /// to which we would like to define the PredMap.
    1.29      /// \todo The graph alone may be insufficient for the initialization
    1.30      static PredMap *createPredMap(const _Graph& graph) {
    1.31        return new PredMap(graph);
    1.32 @@ -244,7 +246,7 @@
    1.33      /// \brief Instantiates a DistMap.
    1.34      ///
    1.35      /// This function instantiates a \ref DistMap. 
    1.36 -    /// \param G is the graph, to which we would like to define the 
    1.37 +    /// \param graph is the graph, to which we would like to define the 
    1.38      /// \ref DistMap
    1.39      static DistMap *createDistMap(const _Graph& graph) {
    1.40        return new DistMap(graph);
    1.41 @@ -681,11 +683,11 @@
    1.42      /// - The distance of each node from the root.
    1.43      ///
    1.44      /// \note d.run(s) is just a shortcut of the following code.
    1.45 -    /// \code
    1.46 +    ///\code
    1.47      ///  d.init();
    1.48      ///  d.addSource(s);
    1.49      ///  d.start();
    1.50 -    /// \endcode
    1.51 +    ///\endcode
    1.52      void run(Node s) {
    1.53        init();
    1.54        addSource(s);
    1.55 @@ -977,7 +979,7 @@
    1.56      /// \brief Runs DagShortestPath algorithm from the given node.
    1.57      ///
    1.58      /// Runs DagShortestPath algorithm from the given node.
    1.59 -    /// \param s is the given source.
    1.60 +    /// \param source is the given source.
    1.61      void run(Node source) {
    1.62        Base::_source = source;
    1.63        run();
    1.64 @@ -1042,7 +1044,7 @@
    1.65      /// \brief Sets the source node, from which the DagShortestPath algorithm runs.
    1.66      ///
    1.67      /// Sets the source node, from which the DagShortestPath algorithm runs.
    1.68 -    /// \param s is the source node.
    1.69 +    /// \param source is the source node.
    1.70      DagShortestPathWizard<_Traits>& source(Node source) {
    1.71        Base::_source = source;
    1.72        return *this;
    1.73 @@ -1060,9 +1062,9 @@
    1.74    /// \ref DagShortestPathWizard.
    1.75    /// The following
    1.76    /// example shows how to use these parameters.
    1.77 -  /// \code
    1.78 +  ///\code
    1.79    /// dagShortestPath(g,length,source).predMap(preds).run();
    1.80 -  /// \endcode
    1.81 +  ///\endcode
    1.82    /// \warning Don't forget to put the \ref DagShortestPathWizard::run() "run()"
    1.83    /// to the end of the parameter list.
    1.84    /// \sa DagShortestPathWizard