Changeset 157:2ccc1afc2c52 in lemon for lemon/dfs.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/dfs.h (modified) (5 diffs)

lemon/dfs.h

@@ -39 +39 @@
 
   ///Default traits class of Dfs class.
-  ///\param GR Digraph type.
+  ///\tparam GR Digraph type.
   template<class GR>
   struct DfsDefaultTraits
@@ -118 +118 @@
   ///This class provides an efficient implementation of the %DFS 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 Dfs, it
   ///is only passed to \ref DfsDefaultTraits.
-  ///\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 DfsDefaultTraits "DfsDefaultTraits<GR>".
   ///See \ref DfsDefaultTraits for the documentation of
   ///a Dfs traits class.
-  ///
-  ///\author Jacint Szabo and Alpar Juttner
 #ifdef DOXYGEN
   template <typename GR,
@@ -740 +738 @@
 
   ///Default traits class of Dfs function.
-  ///\param GR Digraph type.
+  ///\tparam GR Digraph type.
   template<class GR>
   struct DfsWizardDefaultTraits
@@ -1161 +1159 @@
   ///
   /// Default traits class of DfsVisit class.
-  /// \param _Digraph Digraph type.
+  /// \tparam _Digraph Digraph type.
   template<class _Digraph>
   struct DfsVisitDefaultTraits {
@@ -1196 +1194 @@
   /// on every dfs 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 Dfs, it
   /// is only passed to \ref DfsDefaultTraits.
-  /// \param _Visitor The Visitor object for the algorithm. The 
+  /// \tparam _Visitor The Visitor object for the algorithm. The 
   /// \ref DfsVisitor "DfsVisitor<_Digraph>" is an empty Visitor which
   /// does not observe the Dfs events. If you want to observe the dfs
   /// 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 DfsVisitDefaultTraits "DfsVisitDefaultTraits<_Digraph>".