COIN-OR::LEMON - Graph Library

Changeset 1953:d4f411003580 in lemon-0.x for lemon


Ignore:
Timestamp:
02/03/06 16:58:24 (14 years ago)
Author:
Alpar Juttner
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2528
Message:

Polish the doc.

Location:
lemon
Files:
7 edited

Legend:

Unmodified
Added
Removed
  • lemon/fredman_tarjan.h

    r1946 r1953  
    457457    ///Sets the TreeMap of the edges of the minimum spanning tree.
    458458    ///The map values belonging to the edges of the minimum
    459     ///spanning tree are set to \param tree_edge_value or \c true by default
     459    ///spanning tree are set to \c tree_edge_value or \c true by default
    460460    ///while the edge values not belonging to the minimum spanning tree are
    461461    ///set to
    462     ///\param tree_default_value or \c false by default.
     462    ///\c tree_default_value or \c false by default.
    463463    ///
    464464    ///\pre \ref run() or \ref start() must be called before using this
  • lemon/iterable_maps.h

    r1931 r1953  
    200200      /// Creates an iterator. It iterates on the
    201201      /// keys which mapped to true.
    202       /// \param map The IterableIntMap
     202      /// \param _map The IterableIntMap
    203203      TrueIt(const IterableBoolMap& _map)
    204204        : Parent(_map.sep > 0 ? _map.array[_map.sep - 1] : INVALID),
     
    240240      /// Creates an iterator. It iterates on the
    241241      /// keys which mapped to false.
    242       /// \param map The IterableIntMap
     242      /// \param _map The IterableIntMap
    243243      FalseIt(const IterableBoolMap& _map)
    244244        : Parent(_map.sep < (int)_map.array.size() ?
     
    279279      /// Creates an iterator. It iterates on the
    280280      /// keys which mapped to false.
    281       /// \param map The IterableIntMap
     281      /// \param _map The IterableIntMap
    282282      /// \param value Which elements should be iterated.
    283283      ItemIt(const IterableBoolMap& _map, bool value)
  • lemon/johnson.h

    r1946 r1953  
    152152    ///
    153153    /// This function instantiates a \ref PredMap.
    154     /// \param G is the graph, to which we would like to define the PredMap.
     154    /// \param graph is the graph, to which we would like to define the PredMap.
    155155    /// \todo The graph alone may be insufficient for the initialization
    156156    static PredMap *createPredMap(const Graph& graph) {
     
    168168    ///
    169169    /// This function instantiates a \ref DistMap.
    170     /// \param G is the graph, to which we would like to define the
     170    /// \param graph is the graph, to which we would like to define the
    171171    /// \ref DistMap
    172172    static DistMap *createDistMap(const _Graph& graph) {
  • lemon/preflow.h

    r1898 r1953  
    153153    ///\param _cap The capacity of the edges.
    154154    ///\param _f The flow of the edges.
     155    ///\param tol Tolerance class.
    155156    ///Except the graph, all of these parameters can be reset by
    156157    ///calling \ref source, \ref target, \ref capacityMap and \ref
  • lemon/prim.h

    r1912 r1953  
    5757
    5858    ///This function instantiates a \ref HeapCrossRef.
    59     /// \param G is the graph, to which we would like to define the
     59    /// \param _graph is the graph, to which we would like to define the
    6060    /// HeapCrossRef.
    6161    static HeapCrossRef *createHeapCrossRef(const GR &_graph){
     
    8787 
    8888    ///This function instantiates a \ref PredMap.
    89     ///\param G is the graph, to which we would like to define the PredMap.
     89    ///\param _graph is the graph, to which we would like to define the PredMap.
    9090    static PredMap *createPredMap(const GR &_graph){
    9191      return new PredMap(_graph);
     
    102102
    103103    ///This function instantiates a \ref TreeMap.
    104     ///\param g is the graph, to which
     104    ///
     105    ///The first parameter is the graph, to which
    105106    ///we would like to define the \ref TreeMap
    106107    static TreeMap *createTreeMap(const GR &){
     
    117118 
    118119    ///This function instantiates a \ref ProcessedMap.
    119     ///\param g is the graph, to which
     120    ///\param _graph is the graph, to which
    120121    ///we would like to define the \ref ProcessedMap
    121122#ifdef DOXYGEN
     
    704705    ///Sets the TreeMap of the edges of the minimum spanning tree.
    705706    ///The map values belonging to the edges of the minimum
    706     ///spanning tree are set to \param tree_edge_value or \c true by default,
     707    ///spanning tree are set to \c tree_edge_value or \c true by default,
    707708    ///the other map values remain untouched.
    708709    ///
     
    722723    ///Sets the TreeMap of the edges of the minimum spanning tree.
    723724    ///The map values belonging to the edges of the minimum
    724     ///spanning tree are set to \param tree_edge_value or \c true by default while
     725    ///spanning tree are set to \c tree_edge_value or \c true by default while
    725726    ///the edge values not belonging to the minimum spanning tree are set to
    726     ///\param tree_default_value or \c false by default.
     727    ///\c tree_default_value or \c false by default.
    727728    ///
    728729    ///\pre \ref run() or \ref start() must be called before using this function.
  • lemon/time_measure.h

    r1894 r1953  
    273273    ///Constructor.
    274274
    275     ///\param _running indicates whether or not the timer starts immediately.
     275    ///\param run indicates whether or not the timer starts immediately.
    276276    ///
    277277    Timer(bool run=true) :_running(run) {_reset();}
  • lemon/tolerance.h

    r1897 r1953  
    4040  ///
    4141  ///This is an abstract class, it should be specialized for all numerical
    42   ///data types. These specialized classes like \ref Tolerance<double>
     42  ///data types. These specialized classes like \ref Tolerance\<double\>
    4343  ///may offer additional tuning parameters.
    4444  ///
Note: See TracChangeset for help on using the changeset viewer.