COIN-OR::LEMON - Graph Library

Changeset 1151:b217fc69f913 in lemon-0.x


Ignore:
Timestamp:
02/16/05 17:17:30 (15 years ago)
Author:
Alpar Juttner
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1552
Message:

Several changes in the docs.

Files:
5 edited

Legend:

Unmodified
Added
Removed
  • doc/groups.dox

    r1043 r1151  
    8484
    8585/**
     86@defgroup exceptions Exceptions
     87This group contains the exceptions thrown by LEMON library
     88*/
     89
     90/**
    8691@defgroup misc Miscellaneous Tools
    8792Here you can find several useful tools for development,
     
    117122The stuff here is subject to change.
    118123*/
     124
  • src/lemon/concept/path.h

    r986 r1151  
    1818///\file
    1919///\brief Classes for representing paths in graphs.
     20///
     21///\todo Iterators have obsolete style
    2022
    2123#ifndef LEMON_CONCEPT_PATH_H
     
    99101       * \brief Iterator class to iterate on the edges of the paths
    100102       *
    101        * \ingroup concept
    102103       * This class is used to iterate on the edges of the paths
    103104       *
     
    132133       * \brief Iterator class to iterate on the nodes of the paths
    133134       *
    134        * \ingroup concept
    135135       * This class is used to iterate on the nodes of the paths
    136136       *
     
    167167       * \brief Class to build paths
    168168       *
    169        * \ingroup concept
    170169       * This class is used to fill a path with edges.
    171170       *
  • src/lemon/dijkstra.h

    r1132 r1151  
    3131
    3232
    33 /// \addtogroup flowalgs
    34 /// @{
    35 
     33 
    3634  ///Default traits class of Dijkstra class.
    3735
     
    130128  ///%Dijkstra algorithm class.
    131129 
     130  /// \ingroup flowalgs
    132131  ///This class provides an efficient implementation of %Dijkstra algorithm.
    133132  ///The edge lengths are passed to the algorithm using a
     
    497496    }
    498497   
    499     void processNode()
     498    void processNextNode()
    500499    {
    501500      Node v=_heap.top();
     
    541540    void start()
    542541    {
    543       while ( !_heap.empty() ) processNode();
     542      while ( !_heap.empty() ) processNextNode();
    544543    }
    545544   
     
    560559    void start(Node dest)
    561560    {
    562       while ( !_heap.empty() && _heap.top()!=dest ) processNode();
     561      while ( !_heap.empty() && _heap.top()!=dest ) processNextNode();
    563562      if ( _heap.top()==dest ) finalizeNodeData(_heap.top());
    564563    }
     
    576575    void start(const NM &nm)
    577576    {
    578       while ( !_heap.empty() && !mn[_heap.top()] ) processNode();
     577      while ( !_heap.empty() && !mn[_heap.top()] ) processNextNode();
    579578      if ( !_heap.empty() ) finalizeNodeData(_heap.top());
    580579    }
     
    696695  /// Default traits used by \ref DijkstraWizard
    697696
    698   /// To make it easier to use Dijkstra algorithm we have created a wizard class.
    699   /// This \ref DijkstraWizard class needs default traits, as well as the \ref Dijkstra class.
     697  /// To make it easier to use Dijkstra algorithm
     698  ///we have created a wizard class.
     699  /// This \ref DijkstraWizard class needs default traits,
     700  ///as well as the \ref Dijkstra class.
    700701  /// The \ref DijkstraWizardBase is a class to be the default traits of the
    701702  /// \ref DijkstraWizard class.
     
    745746  /// A class to make easier the usage of Dijkstra algorithm
    746747
     748  /// \ingroup flowalgs
    747749  /// This class is created to make it easier to use Dijkstra algorithm.
    748750  /// It uses the functions and features of the plain \ref Dijkstra,
    749   /// but it is much more simple to use it.
     751  /// but it is much simpler to use it.
    750752  ///
    751753  /// Simplicity means that the way to change the types defined
    752754  /// in the traits class is based on functions that returns the new class
    753   /// and not on templatable built-in classes. When using the plain \ref Dijkstra
    754   /// the new class with the modified type comes from the original class by using the ::
    755   /// operator. In the case of \ref DijkstraWizard only a function have to be called and it will
     755  /// and not on templatable built-in classes.
     756  /// When using the plain \ref Dijkstra
     757  /// the new class with the modified type comes from
     758  /// the original class by using the ::
     759  /// operator. In the case of \ref DijkstraWizard only
     760  /// a function have to be called and it will
    756761  /// return the needed class.
    757762  ///
     
    899904  ///\e
    900905
     906  /// \ingroup flowalgs
    901907  ///\todo Please document...
    902908  ///
  • src/lemon/error.h

    r1125 r1151  
    1818#define LEMON_ERROR_H
    1919
    20 //! \ingroup misc
     20//! \ingroup exceptions
    2121//! \file
    2222//! \brief Basic exception classes and error handling.
     
    3131
    3232namespace lemon {
     33
     34/// \addtogroup exceptions
     35/// @{
    3336
    3437  /// Exception-safe convenient "error message" class.
     
    334337  }
    335338
     339/// @}
    336340
    337341}
  • src/lemon/path.h

    r986 r1151  
    3434///\file
    3535///\brief Classes for representing paths in graphs.
     36///
     37///\todo Iterators have obsolete style
    3638
    3739#ifndef LEMON_PATH_H
     
    158160     * \brief Iterator class to iterate on the edges of the paths
    159161     *
    160      * \ingroup paths
    161162     * This class is used to iterate on the edges of the paths
    162163     *
     
    205206     * \brief Iterator class to iterate on the nodes of the paths
    206207     *
    207      * \ingroup paths
    208208     * This class is used to iterate on the nodes of the paths
    209209     *
     
    256256     * \brief Class to build paths
    257257     *
    258      * \ingroup paths
    259258     * This class is used to fill a path with edges.
    260259     *
     
    495494     * \brief Iterator class to iterate on the edges of the paths
    496495     *
    497      * \ingroup paths
    498496     * This class is used to iterate on the edges of the paths
    499497     *
     
    543541     * \brief Iterator class to iterate on the nodes of the paths
    544542     *
    545      * \ingroup paths
    546543     * This class is used to iterate on the nodes of the paths
    547544     *
     
    596593     * \brief Class to build paths
    597594     *
    598      * \ingroup paths
    599595     * This class is used to fill a path with edges.
    600596     *
Note: See TracChangeset for help on using the changeset viewer.