LEMON/LEMON-official Changeset - r157:2ccc1afc2c52

Repositories » LEMON » LEMON-official

Summary
Changelog
Files
Switch To
- loading...
Options
- Lightweight changelog
- Search
Pull Requests

Changeset - r157:2ccc1afc2c52

« 156:e561aa

158:500f3c »

r157:2ccc1afc2c52

Sat, 24 May 2008 23:20:49

[Not Reviewed]

0 comments (0 inline)

kpeter (Peter Kovacs)
kpeter@inf.elte.hu

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

0 14 0

default

14 files changed with 47 insertions and 77 deletions:

lemon/bfs.h

lemon/bin_heap.h

lemon/bits/alteration_notifier.h

lemon/bits/bezier.h

lemon/bits/vector_map.h

lemon/color.h

lemon/concepts/path.h

lemon/dfs.h

lemon/dijkstra.h

lemon/graph_to_eps.h

lemon/graph_utils.h

lemon/path.h

lemon/smart_graph.h

lemon/time_measure.h

↑ Collapse diff ↑

0 comments (0 inline)

@@ -39,3 +39,3 @@
 		  ///Default traits class of Bfs class.
-		  ///\param GR Digraph type.
+		  ///\tparam GR Digraph type.
 		  template<class GR>
@@ -117,6 +117,6 @@
 		  ///
-		  ///\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
@@ -125,4 +125,2 @@
 		  ///a Bfs traits class.
 		  ///
 		  ///\author Alpar Juttner
@@ -758,3 +756,3 @@
 		  ///Default traits class of Bfs function.
-		  ///\param GR Digraph type.
+		  ///\tparam GR Digraph type.
 		  template<class GR>
@@ -1167,3 +1165,3 @@
 		  /// Default traits class of BfsVisit class.
-		  /// \param _Digraph Digraph type.
+		  /// \tparam _Digraph Digraph type.
 		  template<class _Digraph>
@@ -1203,6 +1201,6 @@
 		  ///
-		  /// \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
@@ -1210,3 +1208,3 @@
 		  /// 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
@@ -1215,4 +1213,2 @@
 		  /// a Bfs visit traits class.
 		  ///
 		  /// \author Jacint Szabo, Alpar Juttner and Balazs Dezso
 		#ifdef DOXYGEN

@@ -41,6 +41,6 @@
 		  ///
 		  ///\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>.

@@ -96,4 +96,2 @@
 		  /// \param _Item The item type which is obserbved.
 		  ///
 		  /// \author Balazs Dezso
@@ -132,4 +130,2 @@
 		    /// is cleared to an empty container.
 		    ///
 		    /// \author Balazs Dezso

@@ -26,4 +26,2 @@
 		///Up to now this file is used internally by \ref graph_to_eps.h
 		///
 		///\author Alpar Juttner

@@ -46,7 +46,6 @@
 		  ///
 		  /// \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>

RhodeCode

Login to your account

@@ -29,4 +29,2 @@
 		///\brief Tools to manage RGB colors.
 		///
 		///\author Alpar Juttner

@@ -42,3 +42,3 @@
 		    /// digraph.
-		    /// \param _Digraph The digraph type in which the path is.
+		    /// \tparam _Digraph The digraph type in which the path is.
 		    ///
@@ -207,3 +207,3 @@
-		    /// \param _Digraph  The digraph type in which the path is.
+		    /// \tparam _Digraph  The digraph type in which the path is.
 		    ///

@@ -79,4 +79,4 @@
 		  ///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>
@@ -196,6 +196,6 @@
 		  ///
-		  ///\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
@@ -205,3 +205,4 @@
 		  ///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
@@ -211,4 +212,2 @@
 		  ///class.
 		  ///
 		  ///\author Jacint Szabo and Alpar Juttner
@@ -877,4 +876,4 @@
 		  ///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>

@@ -418,3 +418,3 @@
 		  ///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)
@@ -466,3 +466,3 @@
 		  ///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.
 		  ///

@@ -356,4 +356,2 @@
 		  ///\sa DynArcLookUp
 		  ///
 		  /// \author Balazs Dezso
 		  template <typename _Graph>
@@ -480,4 +478,2 @@
 		  ///\sa findEdge()
 		  ///
 		  /// \author Balazs Dezso
 		  template <typename _Graph>
@@ -1244,5 +1240,5 @@
 		  ///
 		  /// \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.
 		  ///
@@ -1449,4 +1445,4 @@
 		  ///
 		  /// \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.
@@ -1639,3 +1635,2 @@
 		  /// \see TargetMap
 		  /// \author Balazs Dezso
 		  template <typename Digraph>
@@ -1679,3 +1674,2 @@
 		  /// \see SourceMap
 		  /// \author Balazs Dezso
 		  template <typename Digraph>
@@ -1719,3 +1713,2 @@
 		  /// \see BackwardMap
 		  /// \author Balazs Dezso
 		  template <typename Graph>
@@ -1759,3 +1752,2 @@
 		  /// \see ForwardMap
 		  /// \author Balazs Dezso
 		  template <typename Graph>
@@ -2098,3 +2090,3 @@
 		  ///
-		  ///\param G The type of the underlying digraph.
+		  ///\tparam G The type of the underlying digraph.
 		  ///
@@ -2539,3 +2531,3 @@
 		  ///
-		  ///\param G The type of the underlying digraph.
+		  ///\tparam G The type of the underlying digraph.
 		  ///
@@ -2652,3 +2644,3 @@
 		  ///
-		  ///\param G The type of the underlying digraph.
+		  ///\tparam G The type of the underlying digraph.
 		  ///

@@ -42,3 +42,3 @@
 		  /// 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.
 		  ///
@@ -230,3 +230,3 @@
 		  /// 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.
 		  ///
@@ -394,3 +394,3 @@
 		  /// 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.
 		  ///
@@ -734,3 +734,3 @@
 		  /// 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.
 		  ///

@@ -204,4 +204,2 @@
 		  ///\sa concepts::Digraph.
 		  ///
 		  ///\author Alpar Juttner
 		  class SmartDigraph : public ExtendedSmartDigraphBase {

@@ -58,4 +58,2 @@
 		  /// class is what you want to use instead.
 		  ///
 		  ///\author Alpar Juttner
@@ -298,4 +296,2 @@
 		  ///\sa TimeReport
 		  ///
 		  ///\author Alpar Juttner
 		  class Timer