Changeset 2490:31a93dd6f714 in lemon-0.x for lemon/bfs.h

Timestamp:

10/09/07 18:22:04 (17 years ago)

Author:

Balazs Dezso

Branch:

default

Phase:

public

Convert:

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

Message:

Minor bug fixes in documentation

File:

• lemon/bfs.h (modified) (9 diffs)

lemon/bfs.h

@@ -152 +152 @@
     ///The type of the underlying graph.
     typedef typename TR::Graph Graph;
-    ///\e
-    typedef typename Graph::Node Node;
-    ///\e
-    typedef typename Graph::NodeIt NodeIt;
-    ///\e
-    typedef typename Graph::Edge Edge;
-    ///\e
-    typedef typename Graph::OutEdgeIt OutEdgeIt;
     
     ///\brief The type of the map that stores the last
@@ -171 +163 @@
     typedef typename TR::DistMap DistMap;
   private:
+
+    typedef typename Graph::Node Node;
+    typedef typename Graph::NodeIt NodeIt;
+    typedef typename Graph::Edge Edge;
+    typedef typename Graph::OutEdgeIt OutEdgeIt;
+
     /// Pointer to the underlying graph.
     const Graph *G;
@@ -237 +235 @@
       }
     };
-    ///\ref named-templ-param "Named parameter" for setting PredMap type
-
+    ///\brief \ref named-templ-param "Named parameter" for setting
+    ///PredMap type
+    ///
     ///\ref named-templ-param "Named parameter" for setting PredMap type
     ///
@@ -254 +253 @@
       }
     };
-    ///\ref named-templ-param "Named parameter" for setting DistMap type
-
+    ///\brief \ref named-templ-param "Named parameter" for setting
+    ///DistMap type
+    ///
     ///\ref named-templ-param "Named parameter" for setting DistMap type
     ///
@@ -271 +271 @@
       }
     };
-    ///\ref named-templ-param "Named parameter" for setting ReachedMap type
-
+    ///\brief \ref named-templ-param "Named parameter" for setting
+    ///ReachedMap type
+    ///
     ///\ref named-templ-param "Named parameter" for setting ReachedMap type
     ///
@@ -288 +289 @@
       }
     };
-    ///\ref named-templ-param "Named parameter" for setting ProcessedMap type
-
+    ///\brief \ref named-templ-param "Named parameter" for setting
+    ///ProcessedMap type
+    ///
     ///\ref named-templ-param "Named parameter" for setting ProcessedMap type
     ///
@@ -422 +424 @@
     ///@{
 
-    ///Initializes the internal data structures.
-
+    ///\brief Initializes the internal data structures.
+    ///
     ///Initializes the internal data structures.
     ///
@@ -1102 +1104 @@
   /// \brief Visitor class for bfs.
   ///  
-  /// It gives a simple interface for a functional interface for bfs 
-  /// traversal. The traversal on a linear data structure. 
+  /// This class defines the interface of the BfsVisit events, and
+  /// it could be the base of a real Visitor class.
   template <typename _Graph>
   struct BfsVisitor {
@@ -1188 +1190 @@
 
   };
-  
-  /// %BFS Visit algorithm class.
-  
+
   /// \ingroup search
+  ///  
+  /// \brief %BFS Visit algorithm class.
+  ///  
   /// This class provides an efficient implementation of the %BFS algorithm
   /// with visitor interface.