[Lemon-commits] [lemon_svn] alpar: r2554 - hugo/trunk/lemon

[Lemon SVN]

Author: alpar
Date: Mon Feb 20 07:38:18 2006
New Revision: 2554

Modified:
   hugo/trunk/lemon/euler.h

Log:
Doc changes

Modified: hugo/trunk/lemon/euler.h
==============================================================================
--- hugo/trunk/lemon/euler.h	(original)
+++ hugo/trunk/lemon/euler.h	Mon Feb 20 07:38:18 2006
@@ -34,19 +34,22 @@
 
   /// \ingroup topology
   ///This iterator converts to the \c Edge type of the graph and using
-  ///operator ++ it provides an Euler tour of the graph (if there exists).
+  ///operator ++ it provides an Euler tour of a \e directed
+  ///graph (if there exists).
   ///
   ///For example
   ///if the given graph if Euler (i.e it has only one nontrivial component
   ///and the in-degree is equal to the out-degree for all nodes),
-  ///the following code will print the edge IDs according to an
+  ///the following code will put the edges of \c g
+  ///to the vector \c et according to an
   ///Euler tour of \c g.
   ///\code
-  ///  for(EulerIt<ListGraph> e(g),e!=INVALID;++e) {
-  ///    std::cout << g.id(e) << std::eol;
-  ///  }
+  ///  std::vector<ListGraph::Edge> et;
+  ///  for(EulerIt<ListGraph> e(g),e!=INVALID;++e)
+  ///    et.push_back(e);
   ///\endcode
   ///If \c g is not Euler then the resulted tour will not be full or closed.
+  ///\sa UEulerIt
   ///\todo Test required
   template<class Graph>
   class EulerIt 
@@ -118,8 +121,10 @@
   ///Euler iterator for undirected graphs.
 
   /// \ingroup topology
-  ///This iterator converts to the \c Edge type of the graph and using
-  ///operator ++ it provides an Euler tour of the graph (if there exists).
+  ///This iterator converts to the \c Edge (or \cUEdge)
+  ///type of the graph and using
+  ///operator ++ it provides an Euler tour of an \undirected
+  ///graph (if there exists).
   ///
   ///For example
   ///if the given graph if Euler (i.e it has only one nontrivial component
@@ -136,6 +141,7 @@
   ///returns directed edges (that convert to the undirected ones, of course).
   ///
   ///If \c g is not Euler then the resulted tour will not be full or closed.
+  ///\sa EulerIt
   ///\todo Test required
   template<class Graph>
   class UEulerIt