# HG changeset patch
# User Peter Kovacs <kpeter@inf.elte.hu>
# Date 1211664049 -7200
# Node ID 2ccc1afc2c5235526c8b5adcb494f1f8e659cdaa
# Parent e561aa7675de318adf4cefc444d21c9297252201
Using \tparam commands + removing \author commands (ticket #29, #39)
diff -r e561aa7675de -r 2ccc1afc2c52 lemon/bfs.h
--- a/lemon/bfs.h Sat May 17 06:30:02 2008 +0100
+++ b/lemon/bfs.h Sat May 24 23:20:49 2008 +0200
@@ -37,7 +37,7 @@
///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,16 +115,14 @@
///\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,7 +754,7 @@
///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,7 +1163,7 @@
/// \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,20 +1199,18 @@
/// 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
diff -r e561aa7675de -r 2ccc1afc2c52 lemon/bin_heap.h
--- a/lemon/bin_heap.h Sat May 17 06:30:02 2008 +0100
+++ b/lemon/bin_heap.h Sat May 24 23:20:49 2008 +0200
@@ -39,10 +39,10 @@
///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
diff -r e561aa7675de -r 2ccc1afc2c52 lemon/bits/alteration_notifier.h
--- a/lemon/bits/alteration_notifier.h Sat May 17 06:30:02 2008 +0100
+++ b/lemon/bits/alteration_notifier.h Sat May 24 23:20:49 2008 +0200
@@ -94,8 +94,6 @@
///
/// \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,8 +128,6 @@
/// 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:
diff -r e561aa7675de -r 2ccc1afc2c52 lemon/bits/bezier.h
--- a/lemon/bits/bezier.h Sat May 17 06:30:02 2008 +0100
+++ b/lemon/bits/bezier.h Sat May 24 23:20:49 2008 +0200
@@ -24,8 +24,6 @@
///\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>
diff -r e561aa7675de -r 2ccc1afc2c52 lemon/bits/vector_map.h
--- a/lemon/bits/vector_map.h Sat May 17 06:30:02 2008 +0100
+++ b/lemon/bits/vector_map.h Sat May 24 23:20:49 2008 +0200
@@ -44,11 +44,10 @@
/// 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 {
diff -r e561aa7675de -r 2ccc1afc2c52 lemon/color.h
--- a/lemon/color.h Sat May 17 06:30:02 2008 +0100
+++ b/lemon/color.h Sat May 24 23:20:49 2008 +0200
@@ -27,8 +27,6 @@
///\ingroup misc
///\file
///\brief Tools to manage RGB colors.
-///
-///\author Alpar Juttner
namespace lemon {
diff -r e561aa7675de -r 2ccc1afc2c52 lemon/concepts/path.h
--- a/lemon/concepts/path.h Sat May 17 06:30:02 2008 +0100
+++ b/lemon/concepts/path.h Sat May 24 23:20:49 2008 +0200
@@ -40,7 +40,7 @@
///
/// 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,7 +205,7 @@
/// 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.
diff -r e561aa7675de -r 2ccc1afc2c52 lemon/dfs.h
--- a/lemon/dfs.h Sat May 17 06:30:02 2008 +0100
+++ b/lemon/dfs.h Sat May 24 23:20:49 2008 +0200
@@ -38,7 +38,7 @@
///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,16 +117,14 @@
///\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,7 +737,7 @@
///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,7 +1158,7 @@
/// \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,14 +1193,14 @@
/// 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
diff -r e561aa7675de -r 2ccc1afc2c52 lemon/dijkstra.h
--- a/lemon/dijkstra.h Sat May 17 06:30:02 2008 +0100
+++ b/lemon/dijkstra.h Sat May 24 23:20:49 2008 +0200
@@ -77,8 +77,8 @@
///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,23 +194,22 @@
///
///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,8 +874,8 @@
///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
{
diff -r e561aa7675de -r 2ccc1afc2c52 lemon/graph_to_eps.h
--- a/lemon/graph_to_eps.h Sat May 17 06:30:02 2008 +0100
+++ b/lemon/graph_to_eps.h Sat May 24 23:20:49 2008 +0200
@@ -416,7 +416,7 @@
///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,7 +464,7 @@
///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> >
diff -r e561aa7675de -r 2ccc1afc2c52 lemon/graph_utils.h
--- a/lemon/graph_utils.h Sat May 17 06:30:02 2008 +0100
+++ b/lemon/graph_utils.h Sat May 24 23:20:49 2008 +0200
@@ -354,8 +354,6 @@
///\sa ArcLookUp
///\sa AllArcLookUp
///\sa DynArcLookUp
- ///
- /// \author Balazs Dezso
template <typename _Graph>
class ConArcIt : public _Graph::Arc {
public:
@@ -478,8 +476,6 @@
///\endcode
///
///\sa findEdge()
- ///
- /// \author Balazs Dezso
template <typename _Graph>
class ConEdgeIt : public _Graph::Edge {
public:
@@ -1242,9 +1238,9 @@
/// 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,8 +1443,8 @@
/// 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,7 +1633,6 @@
///
/// The SourceMap gives back the source Node of the given arc.
/// \see TargetMap
- /// \author Balazs Dezso
template <typename Digraph>
class SourceMap {
public:
@@ -1677,7 +1672,6 @@
///
/// The TargetMap gives back the target Node of the given arc.
/// \see SourceMap
- /// \author Balazs Dezso
template <typename Digraph>
class TargetMap {
public:
@@ -1717,7 +1711,6 @@
///
/// Returns the "forward" directed arc view of an edge.
/// \see BackwardMap
- /// \author Balazs Dezso
template <typename Graph>
class ForwardMap {
public:
@@ -1757,7 +1750,6 @@
///
/// Returns the "backward" directed arc view of an edge.
/// \see ForwardMap
- /// \author Balazs Dezso
template <typename Graph>
class BackwardMap {
public:
@@ -2096,7 +2088,7 @@
///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,7 +2529,7 @@
///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,7 +2642,7 @@
///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
diff -r e561aa7675de -r 2ccc1afc2c52 lemon/path.h
--- a/lemon/path.h Sat May 17 06:30:02 2008 +0100
+++ b/lemon/path.h Sat May 24 23:20:49 2008 +0200
@@ -40,7 +40,7 @@
/// \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,7 +228,7 @@
/// \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,7 +392,7 @@
/// \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,7 +732,7 @@
/// \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
diff -r e561aa7675de -r 2ccc1afc2c52 lemon/smart_graph.h
--- a/lemon/smart_graph.h Sat May 17 06:30:02 2008 +0100
+++ b/lemon/smart_graph.h Sat May 24 23:20:49 2008 +0200
@@ -202,8 +202,6 @@
///concepts::ReferenceMap "reference map"s.
///
///\sa concepts::Digraph.
- ///
- ///\author Alpar Juttner
class SmartDigraph : public ExtendedSmartDigraphBase {
public:
diff -r e561aa7675de -r 2ccc1afc2c52 lemon/time_measure.h
--- a/lemon/time_measure.h Sat May 17 06:30:02 2008 +0100
+++ b/lemon/time_measure.h Sat May 24 23:20:49 2008 +0200
@@ -56,8 +56,6 @@
///
/// 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,8 +294,6 @@
///
///\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)