[Lemon-commits] deba: r3330 - lemon/trunk/lemon

[Lemon SVN]

Author: deba
Date: Tue Oct  9 18:22:04 2007
New Revision: 3330

Modified:
   lemon/trunk/lemon/bfs.h
   lemon/trunk/lemon/dfs.h
   lemon/trunk/lemon/fredman_tarjan.h
   lemon/trunk/lemon/prim.h

Log:
Minor bug fixes in documentation



Modified: lemon/trunk/lemon/bfs.h
==============================================================================
--- lemon/trunk/lemon/bfs.h	(original)
+++ lemon/trunk/lemon/bfs.h	Tue Oct  9 18:22:04 2007
@@ -151,14 +151,6 @@
     typedef TR Traits;
     ///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
     ///edges of the shortest paths.
@@ -170,6 +162,12 @@
     ///The type of the map that stores the dists of the nodes.
     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;
     ///Pointer to the map of predecessors edges.
@@ -236,8 +234,9 @@
 	throw UninitializedParameter();
       }
     };
-    ///\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
     ///
     template <class T>
@@ -253,8 +252,9 @@
 	throw UninitializedParameter();
       }
     };
-    ///\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
     ///
     template <class T>
@@ -270,8 +270,9 @@
 	throw UninitializedParameter();
       }
     };
-    ///\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
     ///
     template <class T>
@@ -287,8 +288,9 @@
 	throw UninitializedParameter();
       }
     };
-    ///\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
     ///
     template <class T>
@@ -421,8 +423,8 @@
 
     ///@{
 
-    ///Initializes the internal data structures.
-
+    ///\brief Initializes the internal data structures.
+    ///
     ///Initializes the internal data structures.
     ///
     void init()
@@ -1101,8 +1103,8 @@
 #ifdef DOXYGEN
   /// \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 {
     typedef _Graph Graph;
@@ -1187,10 +1189,11 @@
     }
 
   };
-  
-  /// %BFS Visit algorithm class.
-  
+
   /// \ingroup search
+  ///  
+  /// \brief %BFS Visit algorithm class.
+  ///  
   /// This class provides an efficient implementation of the %BFS algorithm
   /// with visitor interface.
   ///

Modified: lemon/trunk/lemon/dfs.h
==============================================================================
--- lemon/trunk/lemon/dfs.h	(original)
+++ lemon/trunk/lemon/dfs.h	Tue Oct  9 18:22:04 2007
@@ -236,8 +236,9 @@
 	throw UninitializedParameter();
       }
     };
-    ///\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
     ///
     template <class T>
@@ -254,10 +255,11 @@
 	throw UninitializedParameter();
       }
     };
-    ///\ref named-templ-param "Named parameter" for setting DistMap type
-
-    ///\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
     template <class T>
     struct DefDistMap {
       typedef Dfs<Graph, DefDistMapTraits<T> > Create;
@@ -271,8 +273,9 @@
 	throw UninitializedParameter();
       }
     };
-    ///\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
     ///
     template <class T>
@@ -288,8 +291,9 @@
 	throw UninitializedParameter();
       }
     };
-    ///\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
     ///
     template <class T>

Modified: lemon/trunk/lemon/fredman_tarjan.h
==============================================================================
--- lemon/trunk/lemon/fredman_tarjan.h	(original)
+++ lemon/trunk/lemon/fredman_tarjan.h	Tue Oct  9 18:22:04 2007
@@ -192,8 +192,8 @@
 	throw UninitializedParameter();
       }
     };
-    ///\ref named-templ-param "Named parameter" for setting TreeMap 
-
+    ///\brief \ref named-templ-param "Named parameter" for setting TreeMap 
+    ///
     ///\ref named-templ-param "Named parameter" for setting TreeMap
     ///
     template <class TM>

Modified: lemon/trunk/lemon/prim.h
==============================================================================
--- lemon/trunk/lemon/prim.h	(original)
+++ lemon/trunk/lemon/prim.h	Tue Oct  9 18:22:04 2007
@@ -284,8 +284,8 @@
 	throw UninitializedParameter();
       }
     };
-    ///\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
     ///
     template <class T>
@@ -301,8 +301,9 @@
 	throw UninitializedParameter();
       }
     };
-    ///\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
     ///
     template <class T>
@@ -374,8 +375,9 @@
         throw UninitializedParameter();
       }
     };
-    ///\ref named-templ-param "Named parameter" for setting TreeMap
-
+    ///\brief \ref named-templ-param "Named parameter" for setting
+    ///TreeMap
+    ///
     ///\ref named-templ-param "Named parameter" for setting TreeMap
     ///
     template <class TM>