Changeset 157:2ccc1afc2c52 in lemon-1.2 for lemon/bfs.h

Timestamp:

05/24/08 23:20:49 (16 years ago)

Author:

Peter Kovacs <kpeter@…>

Branch:

default

Phase:

public

Message:

Using \tparam commands + removing \author commands (ticket #29, #39)

File:

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

lemon/bfs.h

@@ -38 +38 @@
 
   ///Default traits class of Bfs class.
-  ///\param GR Digraph type.
+  ///\tparam GR Digraph type.
   template<class GR>
   struct BfsDefaultTraits
@@ -116 +116 @@
   ///This class provides an efficient implementation of the %BFS algorithm.
   ///
-  ///\param GR The digraph type the algorithm runs on. The default value is
+  ///\tparam GR The digraph type the algorithm runs on. The default value is
   ///\ref ListDigraph. The value of GR is not used directly by Bfs, it
   ///is only passed to \ref BfsDefaultTraits.
-  ///\param TR Traits class to set various data types used by the algorithm.
+  ///\tparam TR Traits class to set various data types used by the algorithm.
   ///The default traits class is
   ///\ref BfsDefaultTraits "BfsDefaultTraits<GR>".
   ///See \ref BfsDefaultTraits for the documentation of
   ///a Bfs traits class.
-  ///
-  ///\author Alpar Juttner
 
 #ifdef DOXYGEN
@@ -757 +755 @@
 
   ///Default traits class of Bfs function.
-  ///\param GR Digraph type.
+  ///\tparam GR Digraph type.
   template<class GR>
   struct BfsWizardDefaultTraits
@@ -1166 +1164 @@
   ///
   /// Default traits class of BfsVisit class.
-  /// \param _Digraph Digraph type.
+  /// \tparam _Digraph Digraph type.
   template<class _Digraph>
   struct BfsVisitDefaultTraits {
@@ -1202 +1200 @@
   /// on every bfs event the \c Visitor class member functions. 
   ///
-  /// \param _Digraph The digraph type the algorithm runs on. The default value is
+  /// \tparam _Digraph The digraph type the algorithm runs on. The default value is
   /// \ref ListDigraph. The value of _Digraph is not used directly by Bfs, it
   /// is only passed to \ref BfsDefaultTraits.
-  /// \param _Visitor The Visitor object for the algorithm. The 
+  /// \tparam _Visitor The Visitor object for the algorithm. The 
   /// \ref BfsVisitor "BfsVisitor<_Digraph>" is an empty Visitor which
   /// does not observe the Bfs events. If you want to observe the bfs
   /// events you should implement your own Visitor class.
-  /// \param _Traits Traits class to set various data types used by the 
+  /// \tparam _Traits Traits class to set various data types used by the 
   /// algorithm. The default traits class is
   /// \ref BfsVisitDefaultTraits "BfsVisitDefaultTraits<_Digraph>".
   /// See \ref BfsVisitDefaultTraits for the documentation of
   /// a Bfs visit traits class.
-  ///
-  /// \author Jacint Szabo, Alpar Juttner and Balazs Dezso
 #ifdef DOXYGEN
   template <typename _Digraph, typename _Visitor, typename _Traits>