Changeset 1970:bd88ea06ab69 in lemon-0.x

Timestamp:

02/20/06 07:38:18 (18 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2554

Message:

Doc changes

File:

• lemon/euler.h (modified) (3 diffs)

lemon/euler.h

@@ -35 +35 @@
   /// \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>
@@ -119 +122 @@
 
   /// \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
@@ -137 +142 @@
   ///
   ///If \c g is not Euler then the resulted tour will not be full or closed.
+  ///\sa EulerIt
   ///\todo Test required
   template<class Graph>