Changeset 2476:059dcdda37c5 in lemon-0.x for lemon

Timestamp:

09/27/07 15:04:06 (17 years ago)

Author:

Peter Kovacs

Branch:

default

Phase:

public

Convert:

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

Message:

Bug fixes in the documentation (mainly bad references).

Location:

lemon

Files:

• bellman_ford.h (modified) (4 diffs)
• bfs.h (modified) (3 diffs)
• dfs.h (modified) (2 diffs)
• dijkstra.h (modified) (1 diff)
• error.h (modified) (1 diff)
• graph_utils.h (modified) (1 diff)
• lemon_reader.h (modified) (2 diffs)

lemon/bellman_ford.h

@@ -433 +433 @@
     /// easily with \ref path() or \ref predEdge() functions. If you
     /// need the shortest path and not just the distance you should store
-    /// after each iteration the \ref predEdgeMap() map and manually build
+    /// after each iteration the \ref predMap() map and manually build
     /// the path.
     ///
@@ -546 +546 @@
     /// easily with \ref path() or \ref predEdge() functions. If you
     /// need the shortest path and not just the distance you should store
-    /// after each iteration the \ref predEdgeMap() map and manually build
+    /// after each iteration the \ref predMap() map and manually build
     /// the path.
     ///
@@ -952 +952 @@
     ///
     /// Runs BellmanFord algorithm from the given node.
-    /// \param source is the given source.
+    /// \param src is the given source.
     void run(Node src) {
       Base::_source = src;
@@ -1017 +1017 @@
     ///
     /// Sets the source node, from which the BellmanFord algorithm runs.
-    /// \param source is the source node.
+    /// \param src is the source node.
     BellmanFordWizard<_Traits>& source(Node src) {
       Base::_source = src;

lemon/bfs.h

@@ -594 +594 @@
     ///
     ///This method runs the %BFS algorithm from the root node(s)
-    ///in order to
-    ///compute the
-    ///shortest path to \c dest. The algorithm computes
+    ///in order to compute the shortest path to \c dest.
+    ///The algorithm computes
     ///- The shortest path to \c  dest.
     ///- The distance of \c dest from the root(s).
@@ -616 +615 @@
     /// <tt>nm[v]</tt> true.
     ///
-    ///\return The reached node \c v with <tt>nm[v]<\tt> true or
+    ///\return The reached node \c v with <tt>nm[v]</tt> true or
     ///\c INVALID if no such node was found.
     template<class NM>
@@ -1518 +1517 @@
     /// <tt>nm[v]</tt> true.
     ///
-    ///\return The reached node \c v with <tt>nm[v]<\tt> true or
+    ///\return The reached node \c v with <tt>nm[v]</tt> true or
     ///\c INVALID if no such node was found.
     template <typename NM>

lemon/dfs.h

@@ -565 +565 @@
     ///
     ///\param em must be a bool (or convertible) edge map. The algorithm
-    ///will stop when it reaches an edge \c e with <tt>em[e]<\tt> true.
-    ///
-    ///\return The reached edge \c e with <tt>em[e]<\tt> true or
+    ///will stop when it reaches an edge \c e with <tt>em[e]</tt> true.
+    ///
+    ///\return The reached edge \c e with <tt>em[e]</tt> true or
     ///\c INVALID if no such edge was found.
     ///
@@ -1459 +1459 @@
     ///
     /// \param em must be a bool (or convertible) edge map. The algorithm
-    /// will stop when it reaches an edge \c e with <tt>em[e]<\tt> true.
-    ///
-    ///\return The reached edge \c e with <tt>em[e]<\tt> true or
+    /// will stop when it reaches an edge \c e with <tt>em[e]</tt> true.
+    ///
+    ///\return The reached edge \c e with <tt>em[e]</tt> true or
     ///\c INVALID if no such edge was found.
     ///

lemon/dijkstra.h

@@ -666 +666 @@
     ///will stop when it reaches a node \c v with <tt>nm[v]</tt> true.
     ///
-    ///\return The reached node \c v with <tt>nm[v]<\tt> true or
+    ///\return The reached node \c v with <tt>nm[v]</tt> true or
     ///\c INVALID if no such node was found.
     template<class NodeBoolMap>

lemon/error.h

@@ -635 +635 @@
 /// behaviour will be activated. The \c msg should be either a const
 /// char* message or an exception. When the \c msg is an exception the
-/// \ref "Exception::what" what() function is called to retrieve and
+/// \ref lemon::Exception::what() "what()" function is called to retrieve and
 /// display the error message.
 ///

lemon/graph_utils.h

@@ -373 +373 @@
   ///
   ///\sa EdgeLookUp
-  ///\se AllEdgeLookUp
+  ///\sa AllEdgeLookUp
   ///\sa ConEdgeIt
   template <typename Graph>

lemon/lemon_reader.h

@@ -1129 +1129 @@
     /// It gives back true when the header line starts with \c \@edgeset,
     /// and the header line's name and the edgeset's name are the same.
-    /// The sections with @uedgeset head line could be read with this
+    /// The sections with \@uedgeset head line could be read with this
     /// section reader too.
     virtual bool header(const std::string& line) {
@@ -1438 +1438 @@
     /// It gives back true when the header line starts with \c \@uedgeset,
     /// and the header line's name and the edgeset's name are the same.
-    /// The sections with @edgeset head line could be read with this
+    /// The sections with \@edgeset head line could be read with this
     /// section reader too.
     virtual bool header(const std::string& line) {