1.1 --- a/lemon/bfs.h Sat May 17 06:30:02 2008 +0100
1.2 +++ b/lemon/bfs.h Sat May 24 23:20:49 2008 +0200
1.3 @@ -37,7 +37,7 @@
1.4 ///Default traits class of Bfs class.
1.5
1.6 ///Default traits class of Bfs class.
1.7 - ///\param GR Digraph type.
1.8 + ///\tparam GR Digraph type.
1.9 template<class GR>
1.10 struct BfsDefaultTraits
1.11 {
1.12 @@ -115,16 +115,14 @@
1.13 ///\ingroup search
1.14 ///This class provides an efficient implementation of the %BFS algorithm.
1.15 ///
1.16 - ///\param GR The digraph type the algorithm runs on. The default value is
1.17 + ///\tparam GR The digraph type the algorithm runs on. The default value is
1.18 ///\ref ListDigraph. The value of GR is not used directly by Bfs, it
1.19 ///is only passed to \ref BfsDefaultTraits.
1.20 - ///\param TR Traits class to set various data types used by the algorithm.
1.21 + ///\tparam TR Traits class to set various data types used by the algorithm.
1.22 ///The default traits class is
1.23 ///\ref BfsDefaultTraits "BfsDefaultTraits<GR>".
1.24 ///See \ref BfsDefaultTraits for the documentation of
1.25 ///a Bfs traits class.
1.26 - ///
1.27 - ///\author Alpar Juttner
1.28
1.29 #ifdef DOXYGEN
1.30 template <typename GR,
1.31 @@ -756,7 +754,7 @@
1.32 ///Default traits class of Bfs function.
1.33
1.34 ///Default traits class of Bfs function.
1.35 - ///\param GR Digraph type.
1.36 + ///\tparam GR Digraph type.
1.37 template<class GR>
1.38 struct BfsWizardDefaultTraits
1.39 {
1.40 @@ -1165,7 +1163,7 @@
1.41 /// \brief Default traits class of BfsVisit class.
1.42 ///
1.43 /// Default traits class of BfsVisit class.
1.44 - /// \param _Digraph Digraph type.
1.45 + /// \tparam _Digraph Digraph type.
1.46 template<class _Digraph>
1.47 struct BfsVisitDefaultTraits {
1.48
1.49 @@ -1201,20 +1199,18 @@
1.50 /// class. It works with callback mechanism, the BfsVisit object calls
1.51 /// on every bfs event the \c Visitor class member functions.
1.52 ///
1.53 - /// \param _Digraph The digraph type the algorithm runs on. The default value is
1.54 + /// \tparam _Digraph The digraph type the algorithm runs on. The default value is
1.55 /// \ref ListDigraph. The value of _Digraph is not used directly by Bfs, it
1.56 /// is only passed to \ref BfsDefaultTraits.
1.57 - /// \param _Visitor The Visitor object for the algorithm. The
1.58 + /// \tparam _Visitor The Visitor object for the algorithm. The
1.59 /// \ref BfsVisitor "BfsVisitor<_Digraph>" is an empty Visitor which
1.60 /// does not observe the Bfs events. If you want to observe the bfs
1.61 /// events you should implement your own Visitor class.
1.62 - /// \param _Traits Traits class to set various data types used by the
1.63 + /// \tparam _Traits Traits class to set various data types used by the
1.64 /// algorithm. The default traits class is
1.65 /// \ref BfsVisitDefaultTraits "BfsVisitDefaultTraits<_Digraph>".
1.66 /// See \ref BfsVisitDefaultTraits for the documentation of
1.67 /// a Bfs visit traits class.
1.68 - ///
1.69 - /// \author Jacint Szabo, Alpar Juttner and Balazs Dezso
1.70 #ifdef DOXYGEN
1.71 template <typename _Digraph, typename _Visitor, typename _Traits>
1.72 #else
2.1 --- a/lemon/bin_heap.h Sat May 17 06:30:02 2008 +0100
2.2 +++ b/lemon/bin_heap.h Sat May 24 23:20:49 2008 +0200
2.3 @@ -39,10 +39,10 @@
2.4 ///efficient. \c Compare specifies the ordering of the priorities. In a heap
2.5 ///one can change the priority of an item, add or erase an item, etc.
2.6 ///
2.7 - ///\param _Prio Type of the priority of the items.
2.8 - ///\param _ItemIntMap A read and writable Item int map, used internally
2.9 + ///\tparam _Prio Type of the priority of the items.
2.10 + ///\tparam _ItemIntMap A read and writable Item int map, used internally
2.11 ///to handle the cross references.
2.12 - ///\param _Compare A class for the ordering of the priorities. The
2.13 + ///\tparam _Compare A class for the ordering of the priorities. The
2.14 ///default is \c std::less<_Prio>.
2.15 ///
2.16 ///\sa FibHeap
3.1 --- a/lemon/bits/alteration_notifier.h Sat May 17 06:30:02 2008 +0100
3.2 +++ b/lemon/bits/alteration_notifier.h Sat May 24 23:20:49 2008 +0200
3.3 @@ -94,8 +94,6 @@
3.4 ///
3.5 /// \param _Container The container which is observed.
3.6 /// \param _Item The item type which is obserbved.
3.7 - ///
3.8 - /// \author Balazs Dezso
3.9
3.10 template <typename _Container, typename _Item>
3.11 class AlterationNotifier {
3.12 @@ -130,8 +128,6 @@
3.13 /// The build() and clear() members are to notify the observer
3.14 /// about the container is built from an empty container or
3.15 /// is cleared to an empty container.
3.16 - ///
3.17 - /// \author Balazs Dezso
3.18
3.19 class ObserverBase {
3.20 protected:
4.1 --- a/lemon/bits/bezier.h Sat May 17 06:30:02 2008 +0100
4.2 +++ b/lemon/bits/bezier.h Sat May 24 23:20:49 2008 +0200
4.3 @@ -24,8 +24,6 @@
4.4 ///\brief Classes to compute with Bezier curves.
4.5 ///
4.6 ///Up to now this file is used internally by \ref graph_to_eps.h
4.7 -///
4.8 -///\author Alpar Juttner
4.9
4.10 #include<lemon/dim2.h>
4.11
5.1 --- a/lemon/bits/vector_map.h Sat May 17 06:30:02 2008 +0100
5.2 +++ b/lemon/bits/vector_map.h Sat May 24 23:20:49 2008 +0200
5.3 @@ -44,11 +44,10 @@
5.4 /// automatically updates the map when a key is added to or erased from
5.5 /// the map. This map type uses the std::vector to store the values.
5.6 ///
5.7 - /// \param Notifier The AlterationNotifier that will notify this map.
5.8 - /// \param Item The item type of the graph items.
5.9 - /// \param Value The value type of the map.
5.10 - ///
5.11 - /// \author Balazs Dezso
5.12 + /// \tparam _Notifier The AlterationNotifier that will notify this map.
5.13 + /// \tparam _Item The item type of the graph items.
5.14 + /// \tparam _Value The value type of the map.
5.15 + /// \todo Fix the doc: there is _Graph parameter instead of _Notifier.
5.16 template <typename _Graph, typename _Item, typename _Value>
5.17 class VectorMap
5.18 : public ItemSetTraits<_Graph, _Item>::ItemNotifier::ObserverBase {
6.1 --- a/lemon/color.h Sat May 17 06:30:02 2008 +0100
6.2 +++ b/lemon/color.h Sat May 24 23:20:49 2008 +0200
6.3 @@ -27,8 +27,6 @@
6.4 ///\ingroup misc
6.5 ///\file
6.6 ///\brief Tools to manage RGB colors.
6.7 -///
6.8 -///\author Alpar Juttner
6.9
6.10 namespace lemon {
6.11
7.1 --- a/lemon/concepts/path.h Sat May 17 06:30:02 2008 +0100
7.2 +++ b/lemon/concepts/path.h Sat May 24 23:20:49 2008 +0200
7.3 @@ -40,7 +40,7 @@
7.4 ///
7.5 /// A skeleton structure for representing directed paths in a
7.6 /// digraph.
7.7 - /// \param _Digraph The digraph type in which the path is.
7.8 + /// \tparam _Digraph The digraph type in which the path is.
7.9 ///
7.10 /// In a sense, the path can be treated as a list of arcs. The
7.11 /// lemon path type stores just this list. As a consequence it
7.12 @@ -205,7 +205,7 @@
7.13 /// assigned to a real path and the dumpers can be implemented as
7.14 /// an adaptor class to the predecessor map.
7.15
7.16 - /// \param _Digraph The digraph type in which the path is.
7.17 + /// \tparam _Digraph The digraph type in which the path is.
7.18 ///
7.19 /// The paths can be constructed from any path type by a
7.20 /// template constructor or a template assignment operator.
8.1 --- a/lemon/dfs.h Sat May 17 06:30:02 2008 +0100
8.2 +++ b/lemon/dfs.h Sat May 24 23:20:49 2008 +0200
8.3 @@ -38,7 +38,7 @@
8.4 ///Default traits class of Dfs class.
8.5
8.6 ///Default traits class of Dfs class.
8.7 - ///\param GR Digraph type.
8.8 + ///\tparam GR Digraph type.
8.9 template<class GR>
8.10 struct DfsDefaultTraits
8.11 {
8.12 @@ -117,16 +117,14 @@
8.13 ///\ingroup search
8.14 ///This class provides an efficient implementation of the %DFS algorithm.
8.15 ///
8.16 - ///\param GR The digraph type the algorithm runs on. The default value is
8.17 + ///\tparam GR The digraph type the algorithm runs on. The default value is
8.18 ///\ref ListDigraph. The value of GR is not used directly by Dfs, it
8.19 ///is only passed to \ref DfsDefaultTraits.
8.20 - ///\param TR Traits class to set various data types used by the algorithm.
8.21 + ///\tparam TR Traits class to set various data types used by the algorithm.
8.22 ///The default traits class is
8.23 ///\ref DfsDefaultTraits "DfsDefaultTraits<GR>".
8.24 ///See \ref DfsDefaultTraits for the documentation of
8.25 ///a Dfs traits class.
8.26 - ///
8.27 - ///\author Jacint Szabo and Alpar Juttner
8.28 #ifdef DOXYGEN
8.29 template <typename GR,
8.30 typename TR>
8.31 @@ -739,7 +737,7 @@
8.32 ///Default traits class of Dfs function.
8.33
8.34 ///Default traits class of Dfs function.
8.35 - ///\param GR Digraph type.
8.36 + ///\tparam GR Digraph type.
8.37 template<class GR>
8.38 struct DfsWizardDefaultTraits
8.39 {
8.40 @@ -1160,7 +1158,7 @@
8.41 /// \brief Default traits class of DfsVisit class.
8.42 ///
8.43 /// Default traits class of DfsVisit class.
8.44 - /// \param _Digraph Digraph type.
8.45 + /// \tparam _Digraph Digraph type.
8.46 template<class _Digraph>
8.47 struct DfsVisitDefaultTraits {
8.48
8.49 @@ -1195,14 +1193,14 @@
8.50 /// class. It works with callback mechanism, the DfsVisit object calls
8.51 /// on every dfs event the \c Visitor class member functions.
8.52 ///
8.53 - /// \param _Digraph The digraph type the algorithm runs on. The default value is
8.54 + /// \tparam _Digraph The digraph type the algorithm runs on. The default value is
8.55 /// \ref ListDigraph. The value of _Digraph is not used directly by Dfs, it
8.56 /// is only passed to \ref DfsDefaultTraits.
8.57 - /// \param _Visitor The Visitor object for the algorithm. The
8.58 + /// \tparam _Visitor The Visitor object for the algorithm. The
8.59 /// \ref DfsVisitor "DfsVisitor<_Digraph>" is an empty Visitor which
8.60 /// does not observe the Dfs events. If you want to observe the dfs
8.61 /// events you should implement your own Visitor class.
8.62 - /// \param _Traits Traits class to set various data types used by the
8.63 + /// \tparam _Traits Traits class to set various data types used by the
8.64 /// algorithm. The default traits class is
8.65 /// \ref DfsVisitDefaultTraits "DfsVisitDefaultTraits<_Digraph>".
8.66 /// See \ref DfsVisitDefaultTraits for the documentation of
9.1 --- a/lemon/dijkstra.h Sat May 17 06:30:02 2008 +0100
9.2 +++ b/lemon/dijkstra.h Sat May 24 23:20:49 2008 +0200
9.3 @@ -77,8 +77,8 @@
9.4 ///Default traits class of Dijkstra class.
9.5
9.6 ///Default traits class of Dijkstra class.
9.7 - ///\param GR Digraph type.
9.8 - ///\param LM Type of length map.
9.9 + ///\tparam GR Digraph type.
9.10 + ///\tparam LM Type of length map.
9.11 template<class GR, class LM>
9.12 struct DijkstraDefaultTraits
9.13 {
9.14 @@ -194,23 +194,22 @@
9.15 ///
9.16 ///It is also possible to change the underlying priority heap.
9.17 ///
9.18 - ///\param GR The digraph type the algorithm runs on. The default value
9.19 + ///\tparam GR The digraph type the algorithm runs on. The default value
9.20 ///is \ref ListDigraph. The value of GR is not used directly by
9.21 ///Dijkstra, it is only passed to \ref DijkstraDefaultTraits.
9.22 - ///\param LM This read-only ArcMap determines the lengths of the
9.23 + ///\tparam LM This read-only ArcMap determines the lengths of the
9.24 ///arcs. It is read once for each arc, so the map may involve in
9.25 ///relatively time consuming process to compute the arc length if
9.26 ///it is necessary. The default map type is \ref
9.27 ///concepts::Digraph::ArcMap "Digraph::ArcMap<int>". The value
9.28 ///of LM is not used directly by Dijkstra, it is only passed to \ref
9.29 - ///DijkstraDefaultTraits. \param TR Traits class to set
9.30 + ///DijkstraDefaultTraits.
9.31 + ///\tparam TR Traits class to set
9.32 ///various data types used by the algorithm. The default traits
9.33 ///class is \ref DijkstraDefaultTraits
9.34 ///"DijkstraDefaultTraits<GR,LM>". See \ref
9.35 ///DijkstraDefaultTraits for the documentation of a Dijkstra traits
9.36 ///class.
9.37 - ///
9.38 - ///\author Jacint Szabo and Alpar Juttner
9.39
9.40 #ifdef DOXYGEN
9.41 template <typename GR, typename LM, typename TR>
9.42 @@ -875,8 +874,8 @@
9.43 ///Default traits class of Dijkstra function.
9.44
9.45 ///Default traits class of Dijkstra function.
9.46 - ///\param GR Digraph type.
9.47 - ///\param LM Type of length map.
9.48 + ///\tparam GR Digraph type.
9.49 + ///\tparam LM Type of length map.
9.50 template<class GR, class LM>
9.51 struct DijkstraWizardDefaultTraits
9.52 {
10.1 --- a/lemon/graph_to_eps.h Sat May 17 06:30:02 2008 +0100
10.2 +++ b/lemon/graph_to_eps.h Sat May 24 23:20:49 2008 +0200
10.3 @@ -416,7 +416,7 @@
10.4 ///Sets the map of the arc widths
10.5
10.6 ///Sets the map of the arc widths
10.7 - ///\param x must be a arc map with \c double (or convertible) values.
10.8 + ///\param x must be an arc map with \c double (or convertible) values.
10.9 template<class X> GraphToEps<ArcWidthsTraits<X> > arcWidths(const X &x)
10.10 {
10.11 dontPrint=true;
10.12 @@ -464,7 +464,7 @@
10.13 ///Sets the map of the arc colors
10.14
10.15 ///Sets the map of the arc colors
10.16 - ///\param x must be a arc map with \ref Color values.
10.17 + ///\param x must be an arc map with \ref Color values.
10.18 ///
10.19 ///\sa Palette
10.20 template<class X> GraphToEps<ArcColorsTraits<X> >
11.1 --- a/lemon/graph_utils.h Sat May 17 06:30:02 2008 +0100
11.2 +++ b/lemon/graph_utils.h Sat May 24 23:20:49 2008 +0200
11.3 @@ -354,8 +354,6 @@
11.4 ///\sa ArcLookUp
11.5 ///\sa AllArcLookUp
11.6 ///\sa DynArcLookUp
11.7 - ///
11.8 - /// \author Balazs Dezso
11.9 template <typename _Graph>
11.10 class ConArcIt : public _Graph::Arc {
11.11 public:
11.12 @@ -478,8 +476,6 @@
11.13 ///\endcode
11.14 ///
11.15 ///\sa findEdge()
11.16 - ///
11.17 - /// \author Balazs Dezso
11.18 template <typename _Graph>
11.19 class ConEdgeIt : public _Graph::Edge {
11.20 public:
11.21 @@ -1242,9 +1238,9 @@
11.22 /// The values of the map can be accessed
11.23 /// with stl compatible forward iterator.
11.24 ///
11.25 - /// \param _Graph The graph type.
11.26 - /// \param _Item The item type of the graph.
11.27 - /// \param _Value The value type of the map.
11.28 + /// \tparam _Graph The graph type.
11.29 + /// \tparam _Item The item type of the graph.
11.30 + /// \tparam _Value The value type of the map.
11.31 ///
11.32 /// \see IterableValueMap
11.33 template <typename _Graph, typename _Item, typename _Value>
11.34 @@ -1447,8 +1443,8 @@
11.35 /// other node, i.e. this id is mutable). </ul> This map can be inverted
11.36 /// with its member class \c InverseMap, or with the \c operator() member.
11.37 ///
11.38 - /// \param _Graph The graph class the \c DescriptorMap belongs to.
11.39 - /// \param _Item The Item is the Key of the Map. It may be Node, Arc or
11.40 + /// \tparam _Graph The graph class the \c DescriptorMap belongs to.
11.41 + /// \tparam _Item The Item is the Key of the Map. It may be Node, Arc or
11.42 /// Edge.
11.43 template <typename _Graph, typename _Item>
11.44 class DescriptorMap : protected DefaultMap<_Graph, _Item, int> {
11.45 @@ -1637,7 +1633,6 @@
11.46 ///
11.47 /// The SourceMap gives back the source Node of the given arc.
11.48 /// \see TargetMap
11.49 - /// \author Balazs Dezso
11.50 template <typename Digraph>
11.51 class SourceMap {
11.52 public:
11.53 @@ -1677,7 +1672,6 @@
11.54 ///
11.55 /// The TargetMap gives back the target Node of the given arc.
11.56 /// \see SourceMap
11.57 - /// \author Balazs Dezso
11.58 template <typename Digraph>
11.59 class TargetMap {
11.60 public:
11.61 @@ -1717,7 +1711,6 @@
11.62 ///
11.63 /// Returns the "forward" directed arc view of an edge.
11.64 /// \see BackwardMap
11.65 - /// \author Balazs Dezso
11.66 template <typename Graph>
11.67 class ForwardMap {
11.68 public:
11.69 @@ -1757,7 +1750,6 @@
11.70 ///
11.71 /// Returns the "backward" directed arc view of an edge.
11.72 /// \see ForwardMap
11.73 - /// \author Balazs Dezso
11.74 template <typename Graph>
11.75 class BackwardMap {
11.76 public:
11.77 @@ -2096,7 +2088,7 @@
11.78 ///optimal time bound in a constant factor for any distribution of
11.79 ///queries.
11.80 ///
11.81 - ///\param G The type of the underlying digraph.
11.82 + ///\tparam G The type of the underlying digraph.
11.83 ///
11.84 ///\sa ArcLookUp
11.85 ///\sa AllArcLookUp
11.86 @@ -2537,7 +2529,7 @@
11.87 ///whenever the digraph changes. This is a time consuming (superlinearly
11.88 ///proportional (<em>O(m</em>log<em>m)</em>) to the number of arcs).
11.89 ///
11.90 - ///\param G The type of the underlying digraph.
11.91 + ///\tparam G The type of the underlying digraph.
11.92 ///
11.93 ///\sa DynArcLookUp
11.94 ///\sa AllArcLookUp
11.95 @@ -2650,7 +2642,7 @@
11.96 ///whenever the digraph changes. This is a time consuming (superlinearly
11.97 ///proportional (<em>O(m</em>log<em>m)</em>) to the number of arcs).
11.98 ///
11.99 - ///\param G The type of the underlying digraph.
11.100 + ///\tparam G The type of the underlying digraph.
11.101 ///
11.102 ///\sa DynArcLookUp
11.103 ///\sa ArcLookUp
12.1 --- a/lemon/path.h Sat May 17 06:30:02 2008 +0100
12.2 +++ b/lemon/path.h Sat May 24 23:20:49 2008 +0200
12.3 @@ -40,7 +40,7 @@
12.4 /// \brief A structure for representing directed paths in a digraph.
12.5 ///
12.6 /// A structure for representing directed path in a digraph.
12.7 - /// \param Digraph The digraph type in which the path is.
12.8 + /// \tparam _Digraph The digraph type in which the path is.
12.9 ///
12.10 /// In a sense, the path can be treated as a list of arcs. The
12.11 /// lemon path type stores just this list. As a consequence, it
12.12 @@ -228,7 +228,7 @@
12.13 /// \brief A structure for representing directed paths in a digraph.
12.14 ///
12.15 /// A structure for representing directed path in a digraph.
12.16 - /// \param Digraph The digraph type in which the path is.
12.17 + /// \tparam _Digraph The digraph type in which the path is.
12.18 ///
12.19 /// In a sense, the path can be treated as a list of arcs. The
12.20 /// lemon path type stores just this list. As a consequence it
12.21 @@ -392,7 +392,7 @@
12.22 /// \brief A structure for representing directed paths in a digraph.
12.23 ///
12.24 /// A structure for representing directed path in a digraph.
12.25 - /// \param Digraph The digraph type in which the path is.
12.26 + /// \tparam _Digraph The digraph type in which the path is.
12.27 ///
12.28 /// In a sense, the path can be treated as a list of arcs. The
12.29 /// lemon path type stores just this list. As a consequence it
12.30 @@ -732,7 +732,7 @@
12.31 /// \brief A structure for representing directed paths in a digraph.
12.32 ///
12.33 /// A structure for representing directed path in a digraph.
12.34 - /// \param Digraph The digraph type in which the path is.
12.35 + /// \tparam _Digraph The digraph type in which the path is.
12.36 ///
12.37 /// In a sense, the path can be treated as a list of arcs. The
12.38 /// lemon path type stores just this list. As a consequence it
13.1 --- a/lemon/smart_graph.h Sat May 17 06:30:02 2008 +0100
13.2 +++ b/lemon/smart_graph.h Sat May 24 23:20:49 2008 +0200
13.3 @@ -202,8 +202,6 @@
13.4 ///concepts::ReferenceMap "reference map"s.
13.5 ///
13.6 ///\sa concepts::Digraph.
13.7 - ///
13.8 - ///\author Alpar Juttner
13.9 class SmartDigraph : public ExtendedSmartDigraphBase {
13.10 public:
13.11
14.1 --- a/lemon/time_measure.h Sat May 17 06:30:02 2008 +0100
14.2 +++ b/lemon/time_measure.h Sat May 24 23:20:49 2008 +0200
14.3 @@ -56,8 +56,6 @@
14.4 ///
14.5 /// In most cases, perhaps the \ref Timer or the \ref TimeReport
14.6 /// class is what you want to use instead.
14.7 - ///
14.8 - ///\author Alpar Juttner
14.9
14.10 class TimeStamp
14.11 {
14.12 @@ -296,8 +294,6 @@
14.13 ///
14.14 ///\todo This shouldn't be Unix (Linux) specific.
14.15 ///\sa TimeReport
14.16 - ///
14.17 - ///\author Alpar Juttner
14.18 class Timer
14.19 {
14.20 int _running; //Timer is running iff _running>0; (_running>=0 always holds)