# HG changeset patch
# User alpar
# Date 1108570650 0
# Node ID b217fc69f913f1619a2ec75021aac23a151b8ce7
# Parent  c20bcf71efe3105b4660502c37c56ab505e1b873
Several changes in the docs.

diff -r c20bcf71efe3 -r b217fc69f913 doc/groups.dox
--- a/doc/groups.dox	Tue Feb 15 15:00:31 2005 +0000
+++ b/doc/groups.dox	Wed Feb 16 16:17:30 2005 +0000
@@ -83,6 +83,11 @@
 */
 
 /**
+@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,
 debugging and testing.
@@ -116,3 +121,4 @@
 This group contains some Experimental structures and algorithms.
 The stuff here is subject to change.
 */
+
diff -r c20bcf71efe3 -r b217fc69f913 src/lemon/concept/path.h
--- a/src/lemon/concept/path.h	Tue Feb 15 15:00:31 2005 +0000
+++ b/src/lemon/concept/path.h	Wed Feb 16 16:17:30 2005 +0000
@@ -17,6 +17,8 @@
 ///\ingroup concept
 ///\file
 ///\brief Classes for representing paths in graphs.
+///
+///\todo Iterators have obsolete style
 
 #ifndef LEMON_CONCEPT_PATH_H
 #define LEMON_CONCEPT_PATH_H
@@ -98,7 +100,6 @@
       /**
        * \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
        *
        * Of course it converts to Graph::Edge
@@ -131,7 +132,6 @@
       /**
        * \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
        *
        * Of course it converts to Graph::Node.
@@ -166,7 +166,6 @@
       /**
        * \brief Class to build paths
        *
-       * \ingroup concept
        * This class is used to fill a path with edges.
        *
        * You can push new edges to the front and to the back of the path in
diff -r c20bcf71efe3 -r b217fc69f913 src/lemon/dijkstra.h
--- a/src/lemon/dijkstra.h	Tue Feb 15 15:00:31 2005 +0000
+++ b/src/lemon/dijkstra.h	Wed Feb 16 16:17:30 2005 +0000
@@ -30,9 +30,7 @@
 namespace lemon {
 
 
-/// \addtogroup flowalgs
-/// @{
-
+  
   ///Default traits class of Dijkstra class.
 
   ///Default traits class of Dijkstra class.
@@ -129,6 +127,7 @@
   
   ///%Dijkstra algorithm class.
   
+  /// \ingroup flowalgs
   ///This class provides an efficient implementation of %Dijkstra algorithm.
   ///The edge lengths are passed to the algorithm using a
   ///\ref concept::ReadMap "ReadMap",
@@ -496,7 +495,7 @@
       if(_heap.state(s) != Heap::IN_HEAP) _heap.push(s,dst);
     }
     
-    void processNode()
+    void processNextNode()
     {
       Node v=_heap.top(); 
       Value oldvalue=_heap[v];
@@ -540,7 +539,7 @@
     ///
     void start()
     {
-      while ( !_heap.empty() ) processNode();
+      while ( !_heap.empty() ) processNextNode();
     }
     
     ///Executes the algorithm until \c dest is reached.
@@ -559,7 +558,7 @@
     ///
     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());
     }
     
@@ -575,7 +574,7 @@
     template<class NM>
     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());
     }
     
@@ -695,8 +694,10 @@
 
   /// 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.
   template<class GR,class LM>
@@ -744,15 +745,19 @@
   
   /// 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.
   ///
   /// It does not have own \ref run method. When its \ref run method is called
@@ -898,6 +903,7 @@
   
   ///\e
 
+  /// \ingroup flowalgs
   ///\todo Please document...
   ///
   template<class GR, class LM>
diff -r c20bcf71efe3 -r b217fc69f913 src/lemon/error.h
--- a/src/lemon/error.h	Tue Feb 15 15:00:31 2005 +0000
+++ b/src/lemon/error.h	Wed Feb 16 16:17:30 2005 +0000
@@ -17,7 +17,7 @@
 #ifndef LEMON_ERROR_H
 #define LEMON_ERROR_H
 
-//! \ingroup misc
+//! \ingroup exceptions
 //! \file
 //! \brief Basic exception classes and error handling.
 
@@ -31,6 +31,9 @@
 
 namespace lemon {
 
+/// \addtogroup exceptions
+/// @{
+
   /// Exception-safe convenient "error message" class.
 
   /// Helper class which provides a convenient ostream-like (operator <<
@@ -333,6 +336,7 @@
     throw AssertionFailedError(file, line, func, message, assertion);
   }
 
+/// @}
 
 }
 #endif // LEMON_ERROR_H
diff -r c20bcf71efe3 -r b217fc69f913 src/lemon/path.h
--- a/src/lemon/path.h	Tue Feb 15 15:00:31 2005 +0000
+++ b/src/lemon/path.h	Wed Feb 16 16:17:30 2005 +0000
@@ -33,6 +33,8 @@
 ///\ingroup paths
 ///\file
 ///\brief Classes for representing paths in graphs.
+///
+///\todo Iterators have obsolete style
 
 #ifndef LEMON_PATH_H
 #define LEMON_PATH_H
@@ -157,7 +159,6 @@
     /**
      * \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
      *
      * Of course it converts to Graph::Edge
@@ -204,7 +205,6 @@
     /**
      * \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
      *
      * Of course it converts to Graph::Node
@@ -255,7 +255,6 @@
     /**
      * \brief Class to build paths
      *
-     * \ingroup paths
      * This class is used to fill a path with edges.
      *
      * You can push new edges to the front and to the back of the path in
@@ -494,7 +493,6 @@
     /**
      * \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
      *
      * Of course it converts to Graph::Edge
@@ -542,7 +540,6 @@
     /**
      * \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
      *
      * Of course it converts to Graph::Node
@@ -595,7 +592,6 @@
     /**
      * \brief Class to build paths
      *
-     * \ingroup paths
      * This class is used to fill a path with edges.
      *
      * You can push new edges to the front and to the back of the path in