1.1 --- a/doc/groups.dox Tue Feb 15 15:00:31 2005 +0000
1.2 +++ b/doc/groups.dox Wed Feb 16 16:17:30 2005 +0000
1.3 @@ -83,6 +83,11 @@
1.4 */
1.5
1.6 /**
1.7 +@defgroup exceptions Exceptions
1.8 +This group contains the exceptions thrown by LEMON library
1.9 +*/
1.10 +
1.11 +/**
1.12 @defgroup misc Miscellaneous Tools
1.13 Here you can find several useful tools for development,
1.14 debugging and testing.
1.15 @@ -116,3 +121,4 @@
1.16 This group contains some Experimental structures and algorithms.
1.17 The stuff here is subject to change.
1.18 */
1.19 +
2.1 --- a/src/lemon/concept/path.h Tue Feb 15 15:00:31 2005 +0000
2.2 +++ b/src/lemon/concept/path.h Wed Feb 16 16:17:30 2005 +0000
2.3 @@ -17,6 +17,8 @@
2.4 ///\ingroup concept
2.5 ///\file
2.6 ///\brief Classes for representing paths in graphs.
2.7 +///
2.8 +///\todo Iterators have obsolete style
2.9
2.10 #ifndef LEMON_CONCEPT_PATH_H
2.11 #define LEMON_CONCEPT_PATH_H
2.12 @@ -98,7 +100,6 @@
2.13 /**
2.14 * \brief Iterator class to iterate on the edges of the paths
2.15 *
2.16 - * \ingroup concept
2.17 * This class is used to iterate on the edges of the paths
2.18 *
2.19 * Of course it converts to Graph::Edge
2.20 @@ -131,7 +132,6 @@
2.21 /**
2.22 * \brief Iterator class to iterate on the nodes of the paths
2.23 *
2.24 - * \ingroup concept
2.25 * This class is used to iterate on the nodes of the paths
2.26 *
2.27 * Of course it converts to Graph::Node.
2.28 @@ -166,7 +166,6 @@
2.29 /**
2.30 * \brief Class to build paths
2.31 *
2.32 - * \ingroup concept
2.33 * This class is used to fill a path with edges.
2.34 *
2.35 * You can push new edges to the front and to the back of the path in
3.1 --- a/src/lemon/dijkstra.h Tue Feb 15 15:00:31 2005 +0000
3.2 +++ b/src/lemon/dijkstra.h Wed Feb 16 16:17:30 2005 +0000
3.3 @@ -30,9 +30,7 @@
3.4 namespace lemon {
3.5
3.6
3.7 -/// \addtogroup flowalgs
3.8 -/// @{
3.9 -
3.10 +
3.11 ///Default traits class of Dijkstra class.
3.12
3.13 ///Default traits class of Dijkstra class.
3.14 @@ -129,6 +127,7 @@
3.15
3.16 ///%Dijkstra algorithm class.
3.17
3.18 + /// \ingroup flowalgs
3.19 ///This class provides an efficient implementation of %Dijkstra algorithm.
3.20 ///The edge lengths are passed to the algorithm using a
3.21 ///\ref concept::ReadMap "ReadMap",
3.22 @@ -496,7 +495,7 @@
3.23 if(_heap.state(s) != Heap::IN_HEAP) _heap.push(s,dst);
3.24 }
3.25
3.26 - void processNode()
3.27 + void processNextNode()
3.28 {
3.29 Node v=_heap.top();
3.30 Value oldvalue=_heap[v];
3.31 @@ -540,7 +539,7 @@
3.32 ///
3.33 void start()
3.34 {
3.35 - while ( !_heap.empty() ) processNode();
3.36 + while ( !_heap.empty() ) processNextNode();
3.37 }
3.38
3.39 ///Executes the algorithm until \c dest is reached.
3.40 @@ -559,7 +558,7 @@
3.41 ///
3.42 void start(Node dest)
3.43 {
3.44 - while ( !_heap.empty() && _heap.top()!=dest ) processNode();
3.45 + while ( !_heap.empty() && _heap.top()!=dest ) processNextNode();
3.46 if ( _heap.top()==dest ) finalizeNodeData(_heap.top());
3.47 }
3.48
3.49 @@ -575,7 +574,7 @@
3.50 template<class NM>
3.51 void start(const NM &nm)
3.52 {
3.53 - while ( !_heap.empty() && !mn[_heap.top()] ) processNode();
3.54 + while ( !_heap.empty() && !mn[_heap.top()] ) processNextNode();
3.55 if ( !_heap.empty() ) finalizeNodeData(_heap.top());
3.56 }
3.57
3.58 @@ -695,8 +694,10 @@
3.59
3.60 /// Default traits used by \ref DijkstraWizard
3.61
3.62 - /// To make it easier to use Dijkstra algorithm we have created a wizard class.
3.63 - /// This \ref DijkstraWizard class needs default traits, as well as the \ref Dijkstra class.
3.64 + /// To make it easier to use Dijkstra algorithm
3.65 + ///we have created a wizard class.
3.66 + /// This \ref DijkstraWizard class needs default traits,
3.67 + ///as well as the \ref Dijkstra class.
3.68 /// The \ref DijkstraWizardBase is a class to be the default traits of the
3.69 /// \ref DijkstraWizard class.
3.70 template<class GR,class LM>
3.71 @@ -744,15 +745,19 @@
3.72
3.73 /// A class to make easier the usage of Dijkstra algorithm
3.74
3.75 + /// \ingroup flowalgs
3.76 /// This class is created to make it easier to use Dijkstra algorithm.
3.77 /// It uses the functions and features of the plain \ref Dijkstra,
3.78 - /// but it is much more simple to use it.
3.79 + /// but it is much simpler to use it.
3.80 ///
3.81 /// Simplicity means that the way to change the types defined
3.82 /// in the traits class is based on functions that returns the new class
3.83 - /// and not on templatable built-in classes. When using the plain \ref Dijkstra
3.84 - /// the new class with the modified type comes from the original class by using the ::
3.85 - /// operator. In the case of \ref DijkstraWizard only a function have to be called and it will
3.86 + /// and not on templatable built-in classes.
3.87 + /// When using the plain \ref Dijkstra
3.88 + /// the new class with the modified type comes from
3.89 + /// the original class by using the ::
3.90 + /// operator. In the case of \ref DijkstraWizard only
3.91 + /// a function have to be called and it will
3.92 /// return the needed class.
3.93 ///
3.94 /// It does not have own \ref run method. When its \ref run method is called
3.95 @@ -898,6 +903,7 @@
3.96
3.97 ///\e
3.98
3.99 + /// \ingroup flowalgs
3.100 ///\todo Please document...
3.101 ///
3.102 template<class GR, class LM>
4.1 --- a/src/lemon/error.h Tue Feb 15 15:00:31 2005 +0000
4.2 +++ b/src/lemon/error.h Wed Feb 16 16:17:30 2005 +0000
4.3 @@ -17,7 +17,7 @@
4.4 #ifndef LEMON_ERROR_H
4.5 #define LEMON_ERROR_H
4.6
4.7 -//! \ingroup misc
4.8 +//! \ingroup exceptions
4.9 //! \file
4.10 //! \brief Basic exception classes and error handling.
4.11
4.12 @@ -31,6 +31,9 @@
4.13
4.14 namespace lemon {
4.15
4.16 +/// \addtogroup exceptions
4.17 +/// @{
4.18 +
4.19 /// Exception-safe convenient "error message" class.
4.20
4.21 /// Helper class which provides a convenient ostream-like (operator <<
4.22 @@ -333,6 +336,7 @@
4.23 throw AssertionFailedError(file, line, func, message, assertion);
4.24 }
4.25
4.26 +/// @}
4.27
4.28 }
4.29 #endif // LEMON_ERROR_H
5.1 --- a/src/lemon/path.h Tue Feb 15 15:00:31 2005 +0000
5.2 +++ b/src/lemon/path.h Wed Feb 16 16:17:30 2005 +0000
5.3 @@ -33,6 +33,8 @@
5.4 ///\ingroup paths
5.5 ///\file
5.6 ///\brief Classes for representing paths in graphs.
5.7 +///
5.8 +///\todo Iterators have obsolete style
5.9
5.10 #ifndef LEMON_PATH_H
5.11 #define LEMON_PATH_H
5.12 @@ -157,7 +159,6 @@
5.13 /**
5.14 * \brief Iterator class to iterate on the edges of the paths
5.15 *
5.16 - * \ingroup paths
5.17 * This class is used to iterate on the edges of the paths
5.18 *
5.19 * Of course it converts to Graph::Edge
5.20 @@ -204,7 +205,6 @@
5.21 /**
5.22 * \brief Iterator class to iterate on the nodes of the paths
5.23 *
5.24 - * \ingroup paths
5.25 * This class is used to iterate on the nodes of the paths
5.26 *
5.27 * Of course it converts to Graph::Node
5.28 @@ -255,7 +255,6 @@
5.29 /**
5.30 * \brief Class to build paths
5.31 *
5.32 - * \ingroup paths
5.33 * This class is used to fill a path with edges.
5.34 *
5.35 * You can push new edges to the front and to the back of the path in
5.36 @@ -494,7 +493,6 @@
5.37 /**
5.38 * \brief Iterator class to iterate on the edges of the paths
5.39 *
5.40 - * \ingroup paths
5.41 * This class is used to iterate on the edges of the paths
5.42 *
5.43 * Of course it converts to Graph::Edge
5.44 @@ -542,7 +540,6 @@
5.45 /**
5.46 * \brief Iterator class to iterate on the nodes of the paths
5.47 *
5.48 - * \ingroup paths
5.49 * This class is used to iterate on the nodes of the paths
5.50 *
5.51 * Of course it converts to Graph::Node
5.52 @@ -595,7 +592,6 @@
5.53 /**
5.54 * \brief Class to build paths
5.55 *
5.56 - * \ingroup paths
5.57 * This class is used to fill a path with edges.
5.58 *
5.59 * You can push new edges to the front and to the back of the path in