COIN-OR::LEMON - Graph Library

Changeset 2350:eb371753e814 in lemon-0.x


Ignore:
Timestamp:
01/23/07 13:51:39 (13 years ago)
Author:
Alpar Juttner
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@3142
Message:

Several doc improvements.

Files:
13 edited

Legend:

Unmodified
Added
Removed
  • demo/maps_summary.cc

    r2209 r2350  
    1818
    1919///\ingroup demos
    20 ///\file maps_summary demo program
    21 ///\brief Introduction to LEMON maps
     20///\file
     21///\brief An introduction to LEMON maps
    2222///
    2323/// \include maps_summary.cc
  • doc/basic_concepts.dox

    r2288 r2350  
     1namespace lemon {
     2
    13/**
    24\page basic_concepts Basic concepts
     
    118120graph representations. It has an undirected version too: ListUGraph.
    119121*/
     122
     123}
  • doc/dirs.dox

    r2157 r2350  
    3838
    3939/**
    40 \dir concept
     40\dir concepts
    4141\brief Concept descriptors and checking classes
    4242
  • doc/groups.dox

    r2260 r2350  
    135135
    136136/**
    137 @defgroup gutils General Graph Utilities
    138 @ingroup algs
    139 \brief This group describes some simple general graph utilities.
    140 
    141 This group describes some simple general graph utilities.
     137@defgroup gutils Basic Graph Utilities
     138@ingroup algs
     139\brief This group describes some simple basic graph utilities.
     140
     141This group describes some simple basic graph utilities.
    142142*/
    143143
  • lemon/bfs.h

    r2335 r2350  
    521521    ///should be initially false.
    522522    ///
    523     ///\param target The nodemaps of possible targets.
     523    ///\param nm The nodemaps of possible targets.
    524524    ///\retval reached Indicates that one of the target nodes is reached.
    525525    ///\return The processed node.
     
    618618    ///\param nm must be a bool (or convertible) node map. The
    619619    ///algorithm will stop when it reached a node \c v with
    620     ///<tt>nm[v]</tt> true.
     620    /// <tt>nm[v]</tt> true.
    621621    ///\todo query the reached target
    622622    template<class NM>
     
    14361436    /// should be initially false.
    14371437    ///
    1438     /// \param target The nodemaps of possible targets.
     1438    /// \param nm The nodemaps of possible targets.
    14391439    /// \retval reached Indicates that one of the target nodes is reached.
    14401440    /// \return The processed node.
     
    15151515    ///\param nm must be a bool (or convertible) node map. The
    15161516    ///algorithm will stop when it reached a node \c v with
    1517     ///<tt>nm[v]</tt> true.
     1517    /// <tt>nm[v]</tt> true.
    15181518    template <typename NM>
    15191519    void start(const NM &nm) {
  • lemon/elevator.h

    r2349 r2350  
    267267
    268268    ///Lift an active item to a higher level.
    269     ///\params i The item to be lifted. It must be active.
    270     ///\params new_level The new level of \c i. It must be strictly higher
     269    ///\param i The item to be lifted. It must be active.
     270    ///\param new_level The new level of \c i. It must be strictly higher
    271271    ///than the current level.
    272272    ///
  • lemon/eps.h

    r2214 r2350  
    284284    ///\param x The \c x coordinate of the node
    285285    ///\param y The \c y coordinate of the node
     286    ///\param r The size (radius) of the node
    286287    ///\param col Color of the node. The default color is white
    287288    ///\param brd Color of the node border. The default color is black
     
    294295    ///\param t The shape of the drawn object
    295296    ///\param pos Position of the node
     297    ///\param r The size (radius) of the node
    296298    ///\param col Color of the node. The default color is white
    297299    ///\param brd Color of the node border. The default color is black
  • lemon/euler.h

    r1993 r2350  
    122122
    123123  /// \ingroup topology
    124   ///This iterator converts to the \c Edge (or \cUEdge)
     124  ///This iterator converts to the \c Edge (or \c UEdge)
    125125  ///type of the graph and using
    126   ///operator ++ it provides an Euler tour of an \undirected
     126  ///operator ++ it provides an Euler tour of an undirected
    127127  ///graph (if there exists).
    128128  ///
  • lemon/graph_utils.h

    r2331 r2350  
    398398  ///\sa findEdge()
    399399  ///\sa EdgeLookUp
    400   ///\se AllEdgeLookup
     400  ///\sa AllEdgeLookup
    401401  ///
    402402  /// \author Balazs Dezso
     
    26622662    ///\param prev The previous edge between \c s and \c t. It it is INVALID or
    26632663    ///not given, the operator finds the first appropriate edge.
    2664     ///\return An edge from \c s to \c t after \prev or
     2664    ///\return An edge from \c s to \c t after \c prev or
    26652665    ///\ref INVALID if there is no more.
    26662666    ///
  • lemon/path_utils.h

    r2335 r2350  
    104104  ///
    105105  /// Checks that each edge's target is the next's source.
    106   /// \Checks the path's consistency.
    107   ///
    108   /// Checks that each edge's target is the next's source.
     106  ///
    109107  template <typename Graph, typename Path>
    110108  bool checkPath(const Graph& graph, const Path& path) {
  • lemon/preflow.h

    r2330 r2350  
    156156    ///\param _cap The capacity of the edges.
    157157    ///\param _f The flow of the edges.
    158     ///\param tol Tolerance class.
     158    ///\param _sr Tolerance class.
    159159    ///Except the graph, all of these parameters can be reset by
    160160    ///calling \ref source, \ref target, \ref capacityMap and \ref
  • lemon/smart_graph.h

    r2343 r2350  
    694694     
    695695      ///This constructor immediately makes a snapshot of the graph.
    696       ///\param _g The graph we make a snapshot of.
     696      ///\param g The graph we make a snapshot of.
    697697      Snapshot(SmartUGraph &g) {
    698698        g.saveSnapshot(*this);
     
    705705      ///This function can be called more than once. In case of a repeated
    706706      ///call, the previous snapshot gets lost.
    707       ///\param _g The graph we make the snapshot of.
     707      ///\param g The graph we make the snapshot of.
    708708      void save(SmartUGraph &g)
    709709      {
  • lemon/ssp_min_cost_flow.h

    r2276 r2350  
    2222///\ingroup flowalgs
    2323///
    24 ///\file \brief An algorithm for finding a flow of value \c k (for
     24///\file
     25///\brief An algorithm for finding a flow of value \c k (for
    2526///small values of \c k) having minimal total cost
    2627
Note: See TracChangeset for help on using the changeset viewer.