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

[Lemon SVN]

Author: alpar
Date: Wed Nov 16 14:15:33 2005
New Revision: 2346

Modified:
   hugo/trunk/lemon/euler.h

Log:
Better doc.

Modified: hugo/trunk/lemon/euler.h
==============================================================================
--- hugo/trunk/lemon/euler.h	(original)
+++ hugo/trunk/lemon/euler.h	Wed Nov 16 14:15:33 2005
@@ -30,12 +30,12 @@
 
   /// \ingroup topology
   ///This iterator converts to the \c Edge type of the graph and using
-  ///the ++ operator it provides an Euler tour of the graph (if there exists).
+  ///operator ++ it provides an Euler tour of the 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 the following code will print the edge IDs according to an
+  ///the following code will print the edge IDs according to an
   ///Euler tour of \c g.
   ///\code
   ///  for(EulerIt<ListGraph> e(g),e!=INVALID;++e) {
@@ -64,7 +64,7 @@
 
     ///\param _g A directed graph.
     ///\param start The starting point of the tour. If it is not given
-    ///       tho tour will start from the first node.
+    ///       the tour will start from the first node.
     EulerIt(const Graph &_g,typename Graph::Node start=INVALID)
       : g(_g), nedge(g)
     {
@@ -100,7 +100,9 @@
     }
     ///Postfix incrementation
     
-    ///\warning This gives back an Edge, not an EulerIt!
+    ///\warning This incrementation
+    ///returns an \c Edge, not an \ref EulerIt, as one may
+    ///expect.
     Edge operator++(int) 
     {
       Edge e=*this;