COIN-OR::LEMON - Graph Library

Changeset 2476:059dcdda37c5 in lemon-0.x for lemon


Ignore:
Timestamp:
09/27/07 15:04:06 (12 years ago)
Author:
Peter Kovacs
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@3315
Message:

Bug fixes in the documentation (mainly bad references).

Location:
lemon
Files:
7 edited

Legend:

Unmodified
Added
Removed
  • lemon/bellman_ford.h

    r2408 r2476  
    433433    /// easily with \ref path() or \ref predEdge() functions. If you
    434434    /// need the shortest path and not just the distance you should store
    435     /// after each iteration the \ref predEdgeMap() map and manually build
     435    /// after each iteration the \ref predMap() map and manually build
    436436    /// the path.
    437437    ///
     
    546546    /// easily with \ref path() or \ref predEdge() functions. If you
    547547    /// need the shortest path and not just the distance you should store
    548     /// after each iteration the \ref predEdgeMap() map and manually build
     548    /// after each iteration the \ref predMap() map and manually build
    549549    /// the path.
    550550    ///
     
    952952    ///
    953953    /// Runs BellmanFord algorithm from the given node.
    954     /// \param source is the given source.
     954    /// \param src is the given source.
    955955    void run(Node src) {
    956956      Base::_source = src;
     
    10171017    ///
    10181018    /// Sets the source node, from which the BellmanFord algorithm runs.
    1019     /// \param source is the source node.
     1019    /// \param src is the source node.
    10201020    BellmanFordWizard<_Traits>& source(Node src) {
    10211021      Base::_source = src;
  • lemon/bfs.h

    r2443 r2476  
    594594    ///
    595595    ///This method runs the %BFS algorithm from the root node(s)
    596     ///in order to
    597     ///compute the
    598     ///shortest path to \c dest. The algorithm computes
     596    ///in order to compute the shortest path to \c dest.
     597    ///The algorithm computes
    599598    ///- The shortest path to \c  dest.
    600599    ///- The distance of \c dest from the root(s).
     
    616615    /// <tt>nm[v]</tt> true.
    617616    ///
    618     ///\return The reached node \c v with <tt>nm[v]<\tt> true or
     617    ///\return The reached node \c v with <tt>nm[v]</tt> true or
    619618    ///\c INVALID if no such node was found.
    620619    template<class NM>
     
    15181517    /// <tt>nm[v]</tt> true.
    15191518    ///
    1520     ///\return The reached node \c v with <tt>nm[v]<\tt> true or
     1519    ///\return The reached node \c v with <tt>nm[v]</tt> true or
    15211520    ///\c INVALID if no such node was found.
    15221521    template <typename NM>
  • lemon/dfs.h

    r2443 r2476  
    565565    ///
    566566    ///\param em must be a bool (or convertible) edge map. The algorithm
    567     ///will stop when it reaches an edge \c e with <tt>em[e]<\tt> true.
    568     ///
    569     ///\return The reached edge \c e with <tt>em[e]<\tt> true or
     567    ///will stop when it reaches an edge \c e with <tt>em[e]</tt> true.
     568    ///
     569    ///\return The reached edge \c e with <tt>em[e]</tt> true or
    570570    ///\c INVALID if no such edge was found.
    571571    ///
     
    14591459    ///
    14601460    /// \param em must be a bool (or convertible) edge map. The algorithm
    1461     /// will stop when it reaches an edge \c e with <tt>em[e]<\tt> true.
    1462     ///
    1463     ///\return The reached edge \c e with <tt>em[e]<\tt> true or
     1461    /// will stop when it reaches an edge \c e with <tt>em[e]</tt> true.
     1462    ///
     1463    ///\return The reached edge \c e with <tt>em[e]</tt> true or
    14641464    ///\c INVALID if no such edge was found.
    14651465    ///
  • lemon/dijkstra.h

    r2443 r2476  
    666666    ///will stop when it reaches a node \c v with <tt>nm[v]</tt> true.
    667667    ///
    668     ///\return The reached node \c v with <tt>nm[v]<\tt> true or
     668    ///\return The reached node \c v with <tt>nm[v]</tt> true or
    669669    ///\c INVALID if no such node was found.
    670670    template<class NodeBoolMap>
  • lemon/error.h

    r2410 r2476  
    635635/// behaviour will be activated. The \c msg should be either a const
    636636/// char* message or an exception. When the \c msg is an exception the
    637 /// \ref "Exception::what" what() function is called to retrieve and
     637/// \ref lemon::Exception::what() "what()" function is called to retrieve and
    638638/// display the error message.
    639639///
  • lemon/graph_utils.h

    r2474 r2476  
    373373  ///
    374374  ///\sa EdgeLookUp
    375   ///\se AllEdgeLookUp
     375  ///\sa AllEdgeLookUp
    376376  ///\sa ConEdgeIt
    377377  template <typename Graph>
  • lemon/lemon_reader.h

    r2467 r2476  
    11291129    /// It gives back true when the header line starts with \c \@edgeset,
    11301130    /// and the header line's name and the edgeset's name are the same.
    1131     /// The sections with @uedgeset head line could be read with this
     1131    /// The sections with \@uedgeset head line could be read with this
    11321132    /// section reader too.
    11331133    virtual bool header(const std::string& line) {
     
    14381438    /// It gives back true when the header line starts with \c \@uedgeset,
    14391439    /// and the header line's name and the edgeset's name are the same.
    1440     /// The sections with @edgeset head line could be read with this
     1440    /// The sections with \@edgeset head line could be read with this
    14411441    /// section reader too.
    14421442    virtual bool header(const std::string& line) {
Note: See TracChangeset for help on using the changeset viewer.