COIN-OR::LEMON - Graph Library

Changeset 157:2ccc1afc2c52 in lemon-1.0 for lemon


Ignore:
Timestamp:
05/24/08 23:20:49 (11 years ago)
Author:
Peter Kovacs <kpeter@…>
Branch:
default
Phase:
public
Message:

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

Location:
lemon
Files:
14 edited

Legend:

Unmodified
Added
Removed
  • lemon/bfs.h

    r100 r157  
    3838
    3939  ///Default traits class of Bfs class.
    40   ///\param GR Digraph type.
     40  ///\tparam GR Digraph type.
    4141  template<class GR>
    4242  struct BfsDefaultTraits
     
    116116  ///This class provides an efficient implementation of the %BFS algorithm.
    117117  ///
    118   ///\param GR The digraph type the algorithm runs on. The default value is
     118  ///\tparam GR The digraph type the algorithm runs on. The default value is
    119119  ///\ref ListDigraph. The value of GR is not used directly by Bfs, it
    120120  ///is only passed to \ref BfsDefaultTraits.
    121   ///\param TR Traits class to set various data types used by the algorithm.
     121  ///\tparam TR Traits class to set various data types used by the algorithm.
    122122  ///The default traits class is
    123123  ///\ref BfsDefaultTraits "BfsDefaultTraits<GR>".
    124124  ///See \ref BfsDefaultTraits for the documentation of
    125125  ///a Bfs traits class.
    126   ///
    127   ///\author Alpar Juttner
    128126
    129127#ifdef DOXYGEN
     
    757755
    758756  ///Default traits class of Bfs function.
    759   ///\param GR Digraph type.
     757  ///\tparam GR Digraph type.
    760758  template<class GR>
    761759  struct BfsWizardDefaultTraits
     
    11661164  ///
    11671165  /// Default traits class of BfsVisit class.
    1168   /// \param _Digraph Digraph type.
     1166  /// \tparam _Digraph Digraph type.
    11691167  template<class _Digraph>
    11701168  struct BfsVisitDefaultTraits {
     
    12021200  /// on every bfs event the \c Visitor class member functions.
    12031201  ///
    1204   /// \param _Digraph The digraph type the algorithm runs on. The default value is
     1202  /// \tparam _Digraph The digraph type the algorithm runs on. The default value is
    12051203  /// \ref ListDigraph. The value of _Digraph is not used directly by Bfs, it
    12061204  /// is only passed to \ref BfsDefaultTraits.
    1207   /// \param _Visitor The Visitor object for the algorithm. The
     1205  /// \tparam _Visitor The Visitor object for the algorithm. The
    12081206  /// \ref BfsVisitor "BfsVisitor<_Digraph>" is an empty Visitor which
    12091207  /// does not observe the Bfs events. If you want to observe the bfs
    12101208  /// events you should implement your own Visitor class.
    1211   /// \param _Traits Traits class to set various data types used by the
     1209  /// \tparam _Traits Traits class to set various data types used by the
    12121210  /// algorithm. The default traits class is
    12131211  /// \ref BfsVisitDefaultTraits "BfsVisitDefaultTraits<_Digraph>".
    12141212  /// See \ref BfsVisitDefaultTraits for the documentation of
    12151213  /// a Bfs visit traits class.
    1216   ///
    1217   /// \author Jacint Szabo, Alpar Juttner and Balazs Dezso
    12181214#ifdef DOXYGEN
    12191215  template <typename _Digraph, typename _Visitor, typename _Traits>
  • lemon/bin_heap.h

    r100 r157  
    4040  ///one can change the priority of an item, add or erase an item, etc.
    4141  ///
    42   ///\param _Prio Type of the priority of the items.
    43   ///\param _ItemIntMap A read and writable Item int map, used internally
     42  ///\tparam _Prio Type of the priority of the items.
     43  ///\tparam _ItemIntMap A read and writable Item int map, used internally
    4444  ///to handle the cross references.
    45   ///\param _Compare A class for the ordering of the priorities. The
     45  ///\tparam _Compare A class for the ordering of the priorities. The
    4646  ///default is \c std::less<_Prio>.
    4747  ///
  • lemon/bits/alteration_notifier.h

    r107 r157  
    9595  /// \param _Container The container which is observed.
    9696  /// \param _Item The item type which is obserbved.
    97   ///
    98   /// \author Balazs Dezso
    9997
    10098  template <typename _Container, typename _Item>
     
    131129    /// about the container is built from an empty container or
    132130    /// is cleared to an empty container.
    133     ///
    134     /// \author Balazs Dezso
    135131
    136132    class ObserverBase {
  • lemon/bits/bezier.h

    r128 r157  
    2525///
    2626///Up to now this file is used internally by \ref graph_to_eps.h
    27 ///
    28 ///\author Alpar Juttner
    2927
    3028#include<lemon/dim2.h>
  • lemon/bits/vector_map.h

    r107 r157  
    4545  /// the map. This map type uses the std::vector to store the values.
    4646  ///
    47   /// \param Notifier The AlterationNotifier that will notify this map.
    48   /// \param Item The item type of the graph items.
    49   /// \param Value The value type of the map.
    50   ///
    51   /// \author Balazs Dezso     
     47  /// \tparam _Notifier The AlterationNotifier that will notify this map.
     48  /// \tparam _Item The item type of the graph items.
     49  /// \tparam _Value The value type of the map.
     50  /// \todo Fix the doc: there is _Graph parameter instead of _Notifier.
    5251  template <typename _Graph, typename _Item, typename _Value>
    5352  class VectorMap
  • lemon/color.h

    r133 r157  
    2828///\file
    2929///\brief Tools to manage RGB colors.
    30 ///
    31 ///\author Alpar Juttner
    3230
    3331namespace lemon {
  • lemon/concepts/path.h

    r96 r157  
    4141    /// A skeleton structure for representing directed paths in a
    4242    /// digraph. 
    43     /// \param _Digraph The digraph type in which the path is.
     43    /// \tparam _Digraph The digraph type in which the path is.
    4444    ///
    4545    /// In a sense, the path can be treated as a list of arcs. The
     
    206206    /// an adaptor class to the predecessor map.
    207207
    208     /// \param _Digraph  The digraph type in which the path is.
     208    /// \tparam _Digraph  The digraph type in which the path is.
    209209    ///
    210210    /// The paths can be constructed from any path type by a
  • lemon/dfs.h

    r100 r157  
    3939
    4040  ///Default traits class of Dfs class.
    41   ///\param GR Digraph type.
     41  ///\tparam GR Digraph type.
    4242  template<class GR>
    4343  struct DfsDefaultTraits
     
    118118  ///This class provides an efficient implementation of the %DFS algorithm.
    119119  ///
    120   ///\param GR The digraph type the algorithm runs on. The default value is
     120  ///\tparam GR The digraph type the algorithm runs on. The default value is
    121121  ///\ref ListDigraph. The value of GR is not used directly by Dfs, it
    122122  ///is only passed to \ref DfsDefaultTraits.
    123   ///\param TR Traits class to set various data types used by the algorithm.
     123  ///\tparam TR Traits class to set various data types used by the algorithm.
    124124  ///The default traits class is
    125125  ///\ref DfsDefaultTraits "DfsDefaultTraits<GR>".
    126126  ///See \ref DfsDefaultTraits for the documentation of
    127127  ///a Dfs traits class.
    128   ///
    129   ///\author Jacint Szabo and Alpar Juttner
    130128#ifdef DOXYGEN
    131129  template <typename GR,
     
    740738
    741739  ///Default traits class of Dfs function.
    742   ///\param GR Digraph type.
     740  ///\tparam GR Digraph type.
    743741  template<class GR>
    744742  struct DfsWizardDefaultTraits
     
    11611159  ///
    11621160  /// Default traits class of DfsVisit class.
    1163   /// \param _Digraph Digraph type.
     1161  /// \tparam _Digraph Digraph type.
    11641162  template<class _Digraph>
    11651163  struct DfsVisitDefaultTraits {
     
    11961194  /// on every dfs event the \c Visitor class member functions.
    11971195  ///
    1198   /// \param _Digraph The digraph type the algorithm runs on. The default value is
     1196  /// \tparam _Digraph The digraph type the algorithm runs on. The default value is
    11991197  /// \ref ListDigraph. The value of _Digraph is not used directly by Dfs, it
    12001198  /// is only passed to \ref DfsDefaultTraits.
    1201   /// \param _Visitor The Visitor object for the algorithm. The
     1199  /// \tparam _Visitor The Visitor object for the algorithm. The
    12021200  /// \ref DfsVisitor "DfsVisitor<_Digraph>" is an empty Visitor which
    12031201  /// does not observe the Dfs events. If you want to observe the dfs
    12041202  /// events you should implement your own Visitor class.
    1205   /// \param _Traits Traits class to set various data types used by the
     1203  /// \tparam _Traits Traits class to set various data types used by the
    12061204  /// algorithm. The default traits class is
    12071205  /// \ref DfsVisitDefaultTraits "DfsVisitDefaultTraits<_Digraph>".
  • lemon/dijkstra.h

    r100 r157  
    7878
    7979  ///Default traits class of Dijkstra class.
    80   ///\param GR Digraph type.
    81   ///\param LM Type of length map.
     80  ///\tparam GR Digraph type.
     81  ///\tparam LM Type of length map.
    8282  template<class GR, class LM>
    8383  struct DijkstraDefaultTraits
     
    195195  ///It is also possible to change the underlying priority heap.
    196196  ///
    197   ///\param GR The digraph type the algorithm runs on. The default value
     197  ///\tparam GR The digraph type the algorithm runs on. The default value
    198198  ///is \ref ListDigraph. The value of GR is not used directly by
    199199  ///Dijkstra, it is only passed to \ref DijkstraDefaultTraits.
    200   ///\param LM This read-only ArcMap determines the lengths of the
     200  ///\tparam LM This read-only ArcMap determines the lengths of the
    201201  ///arcs. It is read once for each arc, so the map may involve in
    202202  ///relatively time consuming process to compute the arc length if
     
    204204  ///concepts::Digraph::ArcMap "Digraph::ArcMap<int>".  The value
    205205  ///of LM is not used directly by Dijkstra, it is only passed to \ref
    206   ///DijkstraDefaultTraits.  \param TR Traits class to set
     206  ///DijkstraDefaultTraits. 
     207  ///\tparam TR Traits class to set
    207208  ///various data types used by the algorithm.  The default traits
    208209  ///class is \ref DijkstraDefaultTraits
     
    210211  ///DijkstraDefaultTraits for the documentation of a Dijkstra traits
    211212  ///class.
    212   ///
    213   ///\author Jacint Szabo and Alpar Juttner
    214213
    215214#ifdef DOXYGEN
     
    876875
    877876  ///Default traits class of Dijkstra function.
    878   ///\param GR Digraph type.
    879   ///\param LM Type of length map.
     877  ///\tparam GR Digraph type.
     878  ///\tparam LM Type of length map.
    880879  template<class GR, class LM>
    881880  struct DijkstraWizardDefaultTraits
  • lemon/graph_to_eps.h

    r143 r157  
    417417
    418418  ///Sets the map of the arc widths
    419   ///\param x must be a arc map with \c double (or convertible) values.
     419  ///\param x must be an arc map with \c double (or convertible) values.
    420420  template<class X> GraphToEps<ArcWidthsTraits<X> > arcWidths(const X &x)
    421421  {
     
    465465
    466466  ///Sets the map of the arc colors
    467   ///\param x must be a arc map with \ref Color values.
     467  ///\param x must be an arc map with \ref Color values.
    468468  ///
    469469  ///\sa Palette
  • lemon/graph_utils.h

    r148 r157  
    355355  ///\sa AllArcLookUp
    356356  ///\sa DynArcLookUp
    357   ///
    358   /// \author Balazs Dezso
    359357  template <typename _Graph>
    360358  class ConArcIt : public _Graph::Arc {
     
    479477  ///
    480478  ///\sa findEdge()
    481   ///
    482   /// \author Balazs Dezso
    483479  template <typename _Graph>
    484480  class ConEdgeIt : public _Graph::Edge {
     
    12431239  /// with stl compatible forward iterator.
    12441240  ///
    1245   /// \param _Graph The graph type.
    1246   /// \param _Item The item type of the graph.
    1247   /// \param _Value The value type of the map.
     1241  /// \tparam _Graph The graph type.
     1242  /// \tparam _Item The item type of the graph.
     1243  /// \tparam _Value The value type of the map.
    12481244  ///
    12491245  /// \see IterableValueMap
     
    14481444  /// with its member class \c InverseMap, or with the \c operator() member.
    14491445  ///
    1450   /// \param _Graph The graph class the \c DescriptorMap belongs to.
    1451   /// \param _Item The Item is the Key of the Map. It may be Node, Arc or
     1446  /// \tparam _Graph The graph class the \c DescriptorMap belongs to.
     1447  /// \tparam _Item The Item is the Key of the Map. It may be Node, Arc or
    14521448  /// Edge.
    14531449  template <typename _Graph, typename _Item>
     
    16381634  /// The SourceMap gives back the source Node of the given arc.
    16391635  /// \see TargetMap
    1640   /// \author Balazs Dezso
    16411636  template <typename Digraph>
    16421637  class SourceMap {
     
    16781673  /// The TargetMap gives back the target Node of the given arc.
    16791674  /// \see SourceMap
    1680   /// \author Balazs Dezso
    16811675  template <typename Digraph>
    16821676  class TargetMap {
     
    17181712  /// Returns the "forward" directed arc view of an edge.
    17191713  /// \see BackwardMap
    1720   /// \author Balazs Dezso
    17211714  template <typename Graph>
    17221715  class ForwardMap {
     
    17581751  /// Returns the "backward" directed arc view of an edge.
    17591752  /// \see ForwardMap
    1760   /// \author Balazs Dezso
    17611753  template <typename Graph>
    17621754  class BackwardMap {
     
    20972089  ///queries.
    20982090  ///
    2099   ///\param G The type of the underlying digraph. 
     2091  ///\tparam G The type of the underlying digraph. 
    21002092  ///
    21012093  ///\sa ArcLookUp 
     
    25382530  ///proportional (<em>O(m</em>log<em>m)</em>) to the number of arcs).
    25392531  ///
    2540   ///\param G The type of the underlying digraph.
     2532  ///\tparam G The type of the underlying digraph.
    25412533  ///
    25422534  ///\sa DynArcLookUp
     
    26512643  ///proportional (<em>O(m</em>log<em>m)</em>) to the number of arcs).
    26522644  ///
    2653   ///\param G The type of the underlying digraph.
     2645  ///\tparam G The type of the underlying digraph.
    26542646  ///
    26552647  ///\sa DynArcLookUp
  • lemon/path.h

    r144 r157  
    4141  ///
    4242  /// A structure for representing directed path in a digraph.
    43   /// \param Digraph The digraph type in which the path is.
     43  /// \tparam _Digraph The digraph type in which the path is.
    4444  ///
    4545  /// In a sense, the path can be treated as a list of arcs. The
     
    229229  ///
    230230  /// A structure for representing directed path in a digraph.
    231   /// \param Digraph The digraph type in which the path is.
     231  /// \tparam _Digraph The digraph type in which the path is.
    232232  ///
    233233  /// In a sense, the path can be treated as a list of arcs. The
     
    393393  ///
    394394  /// A structure for representing directed path in a digraph.
    395   /// \param Digraph The digraph type in which the path is.
     395  /// \tparam _Digraph The digraph type in which the path is.
    396396  ///
    397397  /// In a sense, the path can be treated as a list of arcs. The
     
    733733  ///
    734734  /// A structure for representing directed path in a digraph.
    735   /// \param Digraph The digraph type in which the path is.
     735  /// \tparam _Digraph The digraph type in which the path is.
    736736  ///
    737737  /// In a sense, the path can be treated as a list of arcs. The
  • lemon/smart_graph.h

    r149 r157  
    203203  ///
    204204  ///\sa concepts::Digraph.
    205   ///
    206   ///\author Alpar Juttner
    207205  class SmartDigraph : public ExtendedSmartDigraphBase {
    208206  public:
  • lemon/time_measure.h

    r143 r157  
    5757  /// In most cases, perhaps the \ref Timer or the \ref TimeReport
    5858  /// class is what you want to use instead.
    59   ///
    60   ///\author Alpar Juttner
    6159
    6260  class TimeStamp
     
    297295  ///\todo This shouldn't be Unix (Linux) specific.
    298296  ///\sa TimeReport
    299   ///
    300   ///\author Alpar Juttner
    301297  class Timer
    302298  {
Note: See TracChangeset for help on using the changeset viewer.