Changeset 1151:b217fc69f913 in lemon-0.x

Timestamp:

02/16/05 17:17:30 (20 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:

• doc/groups.dox (modified) (2 diffs)
• src/lemon/concept/path.h (modified) (4 diffs)
• src/lemon/dijkstra.h (modified) (9 diffs)
• src/lemon/error.h (modified) (3 diffs)
• src/lemon/path.h (modified) (7 diffs)

doc/groups.dox

@@ -84 +84 @@
 
 /**
+@defgroup exceptions Exceptions
+This group contains the exceptions thrown by LEMON library
+*/
+
+/**
 @defgroup misc Miscellaneous Tools
 Here you can find several useful tools for development,
@@ -117 +122 @@
 The stuff here is subject to change.
 */
+

src/lemon/concept/path.h

@@ -18 +18 @@
 ///\file
 ///\brief Classes for representing paths in graphs.
+///
+///\todo Iterators have obsolete style
 
 #ifndef LEMON_CONCEPT_PATH_H
@@ -99 +101 @@
        * \brief Iterator class to iterate on the edges of the paths
        *
-       * \ingroup concept
        * This class is used to iterate on the edges of the paths
        *
@@ -132 +133 @@
        * \brief Iterator class to iterate on the nodes of the paths
        *
-       * \ingroup concept
        * This class is used to iterate on the nodes of the paths
        *
@@ -167 +167 @@
        * \brief Class to build paths
        *
-       * \ingroup concept
        * This class is used to fill a path with edges.
        *

src/lemon/dijkstra.h

@@ -31 +31 @@
 
 
-/// \addtogroup flowalgs
-/// @{
-
+  
   ///Default traits class of Dijkstra class.
 
@@ -130 +128 @@
   ///%Dijkstra algorithm class.
   
+  /// \ingroup flowalgs
   ///This class provides an efficient implementation of %Dijkstra algorithm.
   ///The edge lengths are passed to the algorithm using a
@@ -497 +496 @@
     }
     
-    void processNode()
+    void processNextNode()
     {
       Node v=_heap.top(); 
@@ -541 +540 @@
     void start()
     {
-      while ( !_heap.empty() ) processNode();
+      while ( !_heap.empty() ) processNextNode();
     }
     
@@ -560 +559 @@
     void start(Node dest)
     {
-      while ( !_heap.empty() && _heap.top()!=dest ) processNode();
+      while ( !_heap.empty() && _heap.top()!=dest ) processNextNode();
       if ( _heap.top()==dest ) finalizeNodeData(_heap.top());
     }
@@ -576 +575 @@
     void start(const NM &nm)
     {
-      while ( !_heap.empty() && !mn[_heap.top()] ) processNode();
+      while ( !_heap.empty() && !mn[_heap.top()] ) processNextNode();
       if ( !_heap.empty() ) finalizeNodeData(_heap.top());
     }
@@ -696 +695 @@
   /// Default traits used by \ref DijkstraWizard
 
-  /// To make it easier to use Dijkstra algorithm we have created a wizard class.
-  /// This \ref DijkstraWizard class needs default traits, as well as the \ref Dijkstra class.
+  /// To make it easier to use Dijkstra algorithm
+  ///we have created a wizard class.
+  /// This \ref DijkstraWizard class needs default traits,
+  ///as well as the \ref Dijkstra class.
   /// The \ref DijkstraWizardBase is a class to be the default traits of the
   /// \ref DijkstraWizard class.
@@ -745 +746 @@
   /// A class to make easier the usage of Dijkstra algorithm
 
+  /// \ingroup flowalgs
   /// This class is created to make it easier to use Dijkstra algorithm.
   /// It uses the functions and features of the plain \ref Dijkstra,
-  /// but it is much more simple to use it.
+  /// but it is much simpler to use it.
   ///
   /// Simplicity means that the way to change the types defined
   /// in the traits class is based on functions that returns the new class
-  /// and not on templatable built-in classes. When using the plain \ref Dijkstra
-  /// the new class with the modified type comes from the original class by using the ::
-  /// operator. In the case of \ref DijkstraWizard only a function have to be called and it will
+  /// and not on templatable built-in classes.
+  /// When using the plain \ref Dijkstra
+  /// the new class with the modified type comes from
+  /// the original class by using the ::
+  /// operator. In the case of \ref DijkstraWizard only
+  /// a function have to be called and it will
   /// return the needed class.
   ///
@@ -899 +904 @@
   ///\e
 
+  /// \ingroup flowalgs
   ///\todo Please document...
   ///

src/lemon/error.h

@@ -18 +18 @@
 #define LEMON_ERROR_H
 
-//! \ingroup misc
+//! \ingroup exceptions
 //! \file
 //! \brief Basic exception classes and error handling.
@@ -31 +31 @@
 
 namespace lemon {
+
+/// \addtogroup exceptions
+/// @{
 
   /// Exception-safe convenient "error message" class.
@@ -334 +337 @@
   }
 
+/// @}
 
 }

src/lemon/path.h

@@ -34 +34 @@
 ///\file
 ///\brief Classes for representing paths in graphs.
+///
+///\todo Iterators have obsolete style
 
 #ifndef LEMON_PATH_H
@@ -158 +160 @@
      * \brief Iterator class to iterate on the edges of the paths
      *
-     * \ingroup paths
      * This class is used to iterate on the edges of the paths
      *
@@ -205 +206 @@
      * \brief Iterator class to iterate on the nodes of the paths
      *
-     * \ingroup paths
      * This class is used to iterate on the nodes of the paths
      *
@@ -256 +256 @@
      * \brief Class to build paths
      *
-     * \ingroup paths
      * This class is used to fill a path with edges.
      *
@@ -495 +494 @@
      * \brief Iterator class to iterate on the edges of the paths
      *
-     * \ingroup paths
      * This class is used to iterate on the edges of the paths
      *
@@ -543 +541 @@
      * \brief Iterator class to iterate on the nodes of the paths
      *
-     * \ingroup paths
      * This class is used to iterate on the nodes of the paths
      *
@@ -596 +593 @@
      * \brief Class to build paths
      *
-     * \ingroup paths
      * This class is used to fill a path with edges.
      *