[Lemon-commits] [lemon_svn] athos: r2793 - in hugo/trunk/lemon: . bits

[Lemon SVN]

Author: athos
Date: Tue Jun 20 17:20:08 2006
New Revision: 2793

Modified:
   hugo/trunk/lemon/bits/graph_extender.h
   hugo/trunk/lemon/list_graph.h

Log:
Slight changes in doc.

Modified: hugo/trunk/lemon/bits/graph_extender.h
==============================================================================
--- hugo/trunk/lemon/bits/graph_extender.h	(original)
+++ hugo/trunk/lemon/bits/graph_extender.h	Tue Jun 20 17:20:08 2006
@@ -189,13 +189,13 @@
 
     /// \brief Base node of the iterator
     ///
-    /// Returns the base node (ie. the source in this case) of the iterator
+    /// Returns the base node (i.e. the source in this case) of the iterator
     Node baseNode(const OutEdgeIt &e) const {
       return Parent::source(e);
     }
     /// \brief Running node of the iterator
     ///
-    /// Returns the running node (ie. the target in this case) of the
+    /// Returns the running node (i.e. the target in this case) of the
     /// iterator
     Node runningNode(const OutEdgeIt &e) const {
       return Parent::target(e);
@@ -203,13 +203,13 @@
 
     /// \brief Base node of the iterator
     ///
-    /// Returns the base node (ie. the target in this case) of the iterator
+    /// Returns the base node (i.e. the target in this case) of the iterator
     Node baseNode(const InEdgeIt &e) const {
       return Parent::target(e);
     }
     /// \brief Running node of the iterator
     ///
-    /// Returns the running node (ie. the source in this case) of the
+    /// Returns the running node (i.e. the source in this case) of the
     /// iterator
     Node runningNode(const InEdgeIt &e) const {
       return Parent::source(e);

Modified: hugo/trunk/lemon/list_graph.h
==============================================================================
--- hugo/trunk/lemon/list_graph.h	(original)
+++ hugo/trunk/lemon/list_graph.h	Tue Jun 20 17:20:08 2006
@@ -316,8 +316,8 @@
 
   ///This is a simple and fast erasable graph implementation.
   ///
-  ///It addition that it conforms to the
-  ///\ref concept::ErasableGraph "ErasableGraph" concept,
+  ///It conforms to the
+  ///\ref concept::ErasableGraph "ErasableGraph" concept and
   ///it also provides several additional useful extra functionalities.
   ///\sa concept::ErasableGraph.
 
@@ -330,9 +330,9 @@
 
     /// Changes the target of \c e to \c n
     ///
-    ///\note The <tt>Edge</tt>'s and <tt>OutEdge</tt>'s
+    ///\note The <tt>Edge</tt>s and <tt>OutEdge</tt>s
     ///referencing the changed edge remain
-    ///valid. However <tt>InEdge</tt>'s are invalidated.
+    ///valid. However <tt>InEdge</tt>s are invalidated.
     void changeTarget(Edge e, Node n) { 
       _changeTarget(e,n); 
     }
@@ -340,27 +340,27 @@
 
     /// Changes the source of \c e to \c n
     ///
-    ///\note The <tt>Edge</tt>'s and <tt>InEdge</tt>'s
+    ///\note The <tt>Edge</tt>s and <tt>InEdge</tt>s
     ///referencing the changed edge remain
-    ///valid. However <tt>OutEdge</tt>'s are invalidated.
+    ///valid. However <tt>OutEdge</tt>s are invalidated.
     void changeSource(Edge e, Node n) { 
       _changeSource(e,n);
     }
 
     /// Invert the direction of an edge.
 
-    ///\note The <tt>Edge</tt>'s
+    ///\note The <tt>Edge</tt>s
     ///referencing the changed edge remain
-    ///valid. However <tt>OutEdge</tt>'s  and <tt>InEdge</tt>'s are invalidated.
+    ///valid. However <tt>OutEdge</tt>s  and <tt>InEdge</tt>s are invalidated.
     void reverseEdge(Edge e) {
       Node t=target(e);
       _changeTarget(e,source(e));
       _changeSource(e,t);
     }
 
-    ///Using this it possible to avoid the superfluous memory allocation.
+    ///Using this it is possible to avoid the superfluous memory allocation.
 
-    ///Using this it possible to avoid the superfluous memory allocation.
+    ///Using this it is possible to avoid the superfluous memory allocation.
     ///\todo more docs...
     void reserveEdge(int n) { edges.reserve(n); };
 
@@ -369,13 +369,13 @@
     ///This function contracts two nodes.
     ///
     ///Node \p b will be removed but instead of deleting
-    ///its neighboring edges, they will be joined to \p a.
+    ///incident edges, they will be joined to \p a.
     ///The last parameter \p r controls whether to remove loops. \c true
     ///means that loops will be removed.
     ///
     ///\note The <tt>Edge</tt>s
     ///referencing a moved edge remain
-    ///valid. However <tt>InEdge</tt>'s and <tt>OutEdge</tt>'s
+    ///valid. However <tt>InEdge</tt>s and <tt>OutEdge</tt>s
     ///may be invalidated.
     void contract(Node a, Node b, bool r = true) 
     {
@@ -406,7 +406,7 @@
     ///
     ///\note The <tt>Edge</tt>s
     ///referencing a moved edge remain
-    ///valid. However <tt>InEdge</tt>'s and <tt>OutEdge</tt>'s
+    ///valid. However <tt>InEdge</tt>s and <tt>OutEdge</tt>s
     ///may be invalidated.
     ///\warning This functionality cannot be used together with the Snapshot
     ///feature.
@@ -426,12 +426,12 @@
       
     ///Split an edge.
 
-    ///This function splits an edge. First a new node \c b is added to the graph,
-    ///then the original edge is re-targetes to \c b. Finally an edge
-    ///from \c b to the original target is added.
-    ///\return The newly created node.
-    ///\warning This functionality cannot be used together with the Snapshot
-    ///feature.
+    ///This function splits an edge. First a new node \c b is added to
+    ///the graph, then the original edge is re-targeted to \c
+    ///b. Finally an edge from \c b to the original target is added.
+    ///\return The newly created node.  
+    ///\warning This functionality
+    ///cannot be used together with the Snapshot feature.
     Node split(Edge e) 
     {
       Node b = addNode();
@@ -440,9 +440,9 @@
       return b;
     }
       
-    ///Class to make a snapshot of the graph and to restrore to it later.
+    ///Class to make a snapshot of the graph and to restore  it later.
 
-    ///Class to make a snapshot of the graph and to restrore to it later.
+    ///Class to make a snapshot of the graph and to restore  it later.
     ///
     ///The newly added nodes and edges can be removed using the
     ///restore() function.