Ticket #29: patch_tparam-author.patch

lemon/bfs.h

@@ -37 +37 @@
   ///Default traits class of Bfs class.
 
   ///Default traits class of Bfs class.
-  ///\param GR Digraph type.
+  ///\tparam GR Digraph type.
   template<class GR>
   struct BfsDefaultTraits
   {
@@ -115 +115 @@
   ///\ingroup search
   ///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
   template <typename GR,
@@ -756 +754 @@
   ///Default traits class of Bfs function.
 
   ///Default traits class of Bfs function.
-  ///\param GR Digraph type.
+  ///\tparam GR Digraph type.
   template<class GR>
   struct BfsWizardDefaultTraits
   {
@@ -1165 +1163 @@
   /// \brief Default traits class of BfsVisit class.
   ///
   /// Default traits class of BfsVisit class.
-  /// \param _Digraph Digraph type.
+  /// \tparam _Digraph Digraph type.
   template<class _Digraph>
   struct BfsVisitDefaultTraits {
 
@@ -1201 +1199 @@
   /// class. It works with callback mechanism, the BfsVisit object calls
   /// 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>
 #else

lemon/bin_heap.h

@@ -39 +39 @@
   ///efficient. \c Compare specifies the ordering of the priorities. In a heap
   ///one can change the priority of an item, add or erase an item, etc.
   ///
-  ///\param _Prio Type of the priority of the items.
-  ///\param _ItemIntMap A read and writable Item int map, used internally
+  ///\tparam _Prio Type of the priority of the items.
+  ///\tparam _ItemIntMap A read and writable Item int map, used internally
   ///to handle the cross references.
-  ///\param _Compare A class for the ordering of the priorities. The
+  ///\tparam _Compare A class for the ordering of the priorities. The
   ///default is \c std::less<_Prio>.
   ///
   ///\sa FibHeap

lemon/bits/alteration_notifier.h

@@ -94 +94 @@
   ///
   /// \param _Container The container which is observed.
   /// \param _Item The item type which is obserbved.
-  ///
-  /// \author Balazs Dezso
 
   template <typename _Container, typename _Item>
   class AlterationNotifier {
@@ -130 +128 @@
     /// The build() and clear() members are to notify the observer
     /// about the container is built from an empty container or
     /// is cleared to an empty container. 
-    /// 
-    /// \author Balazs Dezso
 
     class ObserverBase {
     protected:

lemon/bits/bezier.h

@@ -24 +24 @@
 ///\brief Classes to compute with Bezier curves.
 ///
 ///Up to now this file is used internally by \ref graph_to_eps.h
-///
-///\author Alpar Juttner
 
 #include<lemon/dim2.h>
 

lemon/bits/vector_map.h

@@ -44 +44 @@
   /// automatically updates the map when a key is added to or erased from
   /// the map. This map type uses the std::vector to store the values.
   ///
-  /// \param Notifier The AlterationNotifier that will notify this map.
-  /// \param Item The item type of the graph items.
-  /// \param Value The value type of the map.
-  /// 
-  /// \author Balazs Dezso      
+  /// \tparam _Notifier The AlterationNotifier that will notify this map.
+  /// \tparam _Item The item type of the graph items.
+  /// \tparam _Value The value type of the map.
+  /// \todo Fix the doc: there is _Graph parameter instead of _Notifier.
   template <typename _Graph, typename _Item, typename _Value>
   class VectorMap 
     : public ItemSetTraits<_Graph, _Item>::ItemNotifier::ObserverBase {

lemon/color.h

@@ -27 +27 @@
 ///\ingroup misc
 ///\file
 ///\brief Tools to manage RGB colors.
-///
-///\author Alpar Juttner
 
 namespace lemon {
 

lemon/concepts/path.h

@@ -40 +40 @@
     ///
     /// A skeleton structure for representing directed paths in a
     /// digraph.  
-    /// \param _Digraph The digraph type in which the path is.
+    /// \tparam _Digraph The digraph type in which the path is.
     ///
     /// In a sense, the path can be treated as a list of arcs. The
     /// lemon path type stores just this list. As a consequence it
@@ -205 +205 @@
     /// assigned to a real path and the dumpers can be implemented as
     /// an adaptor class to the predecessor map.
 
-    /// \param _Digraph  The digraph type in which the path is.
+    /// \tparam _Digraph  The digraph type in which the path is.
     ///
     /// The paths can be constructed from any path type by a
     /// template constructor or a template assignment operator.

lemon/dfs.h

@@ -38 +38 @@
   ///Default traits class of Dfs class.
 
   ///Default traits class of Dfs class.
-  ///\param GR Digraph type.
+  ///\tparam GR Digraph type.
   template<class GR>
   struct DfsDefaultTraits
   {
@@ -117 +117 @@
   ///\ingroup search
   ///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,
             typename TR>
@@ -739 +737 @@
   ///Default traits class of Dfs function.
 
   ///Default traits class of Dfs function.
-  ///\param GR Digraph type.
+  ///\tparam GR Digraph type.
   template<class GR>
   struct DfsWizardDefaultTraits
   {
@@ -1160 +1158 @@
   /// \brief Default traits class of DfsVisit class.
   ///
   /// Default traits class of DfsVisit class.
-  /// \param _Digraph Digraph type.
+  /// \tparam _Digraph Digraph type.
   template<class _Digraph>
   struct DfsVisitDefaultTraits {
 
@@ -1195 +1193 @@
   /// class. It works with callback mechanism, the DfsVisit object calls
   /// 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>".
   /// See \ref DfsVisitDefaultTraits for the documentation of

lemon/dijkstra.h

@@ -77 +77 @@
   ///Default traits class of Dijkstra class.
 
   ///Default traits class of Dijkstra class.
-  ///\param GR Digraph type.
-  ///\param LM Type of length map.
+  ///\tparam GR Digraph type.
+  ///\tparam LM Type of length map.
   template<class GR, class LM>
   struct DijkstraDefaultTraits
   {
@@ -194 +194 @@
   ///
   ///It is also possible to change the underlying priority heap.
   ///
-  ///\param GR The digraph type the algorithm runs on. The default value
+  ///\tparam GR The digraph type the algorithm runs on. The default value
   ///is \ref ListDigraph. The value of GR is not used directly by
   ///Dijkstra, it is only passed to \ref DijkstraDefaultTraits.
-  ///\param LM This read-only ArcMap determines the lengths of the
+  ///\tparam LM This read-only ArcMap determines the lengths of the
   ///arcs. It is read once for each arc, so the map may involve in
   ///relatively time consuming process to compute the arc length if
   ///it is necessary. The default map type is \ref
   ///concepts::Digraph::ArcMap "Digraph::ArcMap<int>".  The value
   ///of LM is not used directly by Dijkstra, it is only passed to \ref
-  ///DijkstraDefaultTraits.  \param TR Traits class to set
+  ///DijkstraDefaultTraits.  
+  ///\tparam TR Traits class to set
   ///various data types used by the algorithm.  The default traits
   ///class is \ref DijkstraDefaultTraits
   ///"DijkstraDefaultTraits<GR,LM>".  See \ref
   ///DijkstraDefaultTraits for the documentation of a Dijkstra traits
   ///class.
-  ///
-  ///\author Jacint Szabo and Alpar Juttner
 
 #ifdef DOXYGEN
   template <typename GR, typename LM, typename TR>
@@ -875 +874 @@
   ///Default traits class of Dijkstra function.
 
   ///Default traits class of Dijkstra function.
-  ///\param GR Digraph type.
-  ///\param LM Type of length map.
+  ///\tparam GR Digraph type.
+  ///\tparam LM Type of length map.
   template<class GR, class LM>
   struct DijkstraWizardDefaultTraits
   {

lemon/graph_to_eps.h

@@ -416 +416 @@
   ///Sets the map of the arc widths
 
   ///Sets the map of the arc widths
-  ///\param x must be a arc map with \c double (or convertible) values. 
+  ///\param x must be an arc map with \c double (or convertible) values. 
   template<class X> GraphToEps<ArcWidthsTraits<X> > arcWidths(const X &x)
   {
     dontPrint=true;
@@ -464 +464 @@
   ///Sets the map of the arc colors
 
   ///Sets the map of the arc colors
-  ///\param x must be a arc map with \ref Color values. 
+  ///\param x must be an arc map with \ref Color values. 
   ///
   ///\sa Palette
   template<class X> GraphToEps<ArcColorsTraits<X> >

lemon/graph_utils.h

@@ -354 +354 @@
   ///\sa ArcLookUp
   ///\sa AllArcLookUp
   ///\sa DynArcLookUp
-  ///
-  /// \author Balazs Dezso 
   template <typename _Graph>
   class ConArcIt : public _Graph::Arc {
   public:
@@ -478 +476 @@
   ///\endcode
   ///
   ///\sa findEdge()
-  ///
-  /// \author Balazs Dezso 
   template <typename _Graph>
   class ConEdgeIt : public _Graph::Edge {
   public:
@@ -1242 +1238 @@
   /// The values of the map can be accessed
   /// with stl compatible forward iterator.
   ///
-  /// \param _Graph The graph type.
-  /// \param _Item The item type of the graph.
-  /// \param _Value The value type of the map.
+  /// \tparam _Graph The graph type.
+  /// \tparam _Item The item type of the graph.
+  /// \tparam _Value The value type of the map.
   ///
   /// \see IterableValueMap
   template <typename _Graph, typename _Item, typename _Value>
@@ -1447 +1443 @@
   /// other node, i.e. this id is mutable).  </ul> This map can be inverted
   /// with its member class \c InverseMap, or with the \c operator() member.
   ///
-  /// \param _Graph The graph class the \c DescriptorMap belongs to.
-  /// \param _Item The Item is the Key of the Map. It may be Node, Arc or 
+  /// \tparam _Graph The graph class the \c DescriptorMap belongs to.
+  /// \tparam _Item The Item is the Key of the Map. It may be Node, Arc or 
   /// Edge.
   template <typename _Graph, typename _Item>
   class DescriptorMap : protected DefaultMap<_Graph, _Item, int> {
@@ -1637 +1633 @@
   ///
   /// The SourceMap gives back the source Node of the given arc. 
   /// \see TargetMap
-  /// \author Balazs Dezso
   template <typename Digraph>
   class SourceMap {
   public:
@@ -1677 +1672 @@
   ///
   /// The TargetMap gives back the target Node of the given arc. 
   /// \see SourceMap
-  /// \author Balazs Dezso
   template <typename Digraph>
   class TargetMap {
   public:
@@ -1717 +1711 @@
   ///
   /// Returns the "forward" directed arc view of an edge.
   /// \see BackwardMap
-  /// \author Balazs Dezso
   template <typename Graph>
   class ForwardMap {
   public:
@@ -1757 +1750 @@
   ///
   /// Returns the "backward" directed arc view of an edge.
   /// \see ForwardMap
-  /// \author Balazs Dezso
   template <typename Graph>
   class BackwardMap {
   public:
@@ -2096 +2088 @@
   ///optimal time bound in a constant factor for any distribution of
   ///queries.
   ///
-  ///\param G The type of the underlying digraph.  
+  ///\tparam G The type of the underlying digraph.  
   ///
   ///\sa ArcLookUp  
   ///\sa AllArcLookUp  
@@ -2537 +2529 @@
   ///whenever the digraph changes. This is a time consuming (superlinearly
   ///proportional (<em>O(m</em>log<em>m)</em>) to the number of arcs).
   ///
-  ///\param G The type of the underlying digraph.
+  ///\tparam G The type of the underlying digraph.
   ///
   ///\sa DynArcLookUp
   ///\sa AllArcLookUp  
@@ -2650 +2642 @@
   ///whenever the digraph changes. This is a time consuming (superlinearly
   ///proportional (<em>O(m</em>log<em>m)</em>) to the number of arcs).
   ///
-  ///\param G The type of the underlying digraph.
+  ///\tparam G The type of the underlying digraph.
   ///
   ///\sa DynArcLookUp
   ///\sa ArcLookUp  

lemon/path.h

@@ -40 +40 @@
   /// \brief A structure for representing directed paths in a digraph.
   ///
   /// A structure for representing directed path in a digraph.
-  /// \param Digraph The digraph type in which the path is.
+  /// \tparam _Digraph The digraph type in which the path is.
   ///
   /// In a sense, the path can be treated as a list of arcs. The
   /// lemon path type stores just this list. As a consequence, it
@@ -228 +228 @@
   /// \brief A structure for representing directed paths in a digraph.
   ///
   /// A structure for representing directed path in a digraph.
-  /// \param Digraph The digraph type in which the path is.
+  /// \tparam _Digraph The digraph type in which the path is.
   ///
   /// In a sense, the path can be treated as a list of arcs. The
   /// lemon path type stores just this list. As a consequence it
@@ -392 +392 @@
   /// \brief A structure for representing directed paths in a digraph.
   ///
   /// A structure for representing directed path in a digraph.
-  /// \param Digraph The digraph type in which the path is.
+  /// \tparam _Digraph The digraph type in which the path is.
   ///
   /// In a sense, the path can be treated as a list of arcs. The
   /// lemon path type stores just this list. As a consequence it
@@ -732 +732 @@
   /// \brief A structure for representing directed paths in a digraph.
   ///
   /// A structure for representing directed path in a digraph.
-  /// \param Digraph The digraph type in which the path is.
+  /// \tparam _Digraph The digraph type in which the path is.
   ///
   /// In a sense, the path can be treated as a list of arcs. The
   /// lemon path type stores just this list. As a consequence it

lemon/smart_graph.h

@@ -202 +202 @@
   ///concepts::ReferenceMap "reference map"s.
   ///
   ///\sa concepts::Digraph.
-  ///
-  ///\author Alpar Juttner
   class SmartDigraph : public ExtendedSmartDigraphBase {
   public:
 

lemon/time_measure.h

@@ -56 +56 @@
   ///
   /// In most cases, perhaps the \ref Timer or the \ref TimeReport
   /// class is what you want to use instead.
-  ///
-  ///\author Alpar Juttner
 
   class TimeStamp
   {
@@ -296 +294 @@
   ///
   ///\todo This shouldn't be Unix (Linux) specific.
   ///\sa TimeReport
-  ///
-  ///\author Alpar Juttner
   class Timer
   {
     int _running; //Timer is running iff _running>0; (_running>=0 always holds)