Changeset 2102:eb73ab0e4c74 in lemon-0.x for lemon/list_graph.h

Timestamp:

06/20/06 17:20:08 (17 years ago)

Author:

athos

Branch:

default

Phase:

public

Convert:

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

Message:

Slight changes in doc.

File:

• lemon/list_graph.h (modified) (10 diffs)

lemon/list_graph.h

@@ -317 +317 @@
   ///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.
@@ -331 +331 @@
     /// 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); 
@@ -341 +341 @@
     /// 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);
@@ -350 +350 @@
     /// 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);
@@ -359 +359 @@
     }
 
-    ///Using this it 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.
+
+    ///Using this it is possible to avoid the superfluous memory allocation.
     ///\todo more docs...
     void reserveEdge(int n) { edges.reserve(n); };
@@ -370 +370 @@
     ///
     ///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.
@@ -376 +376 @@
     ///\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) 
@@ -407 +407 @@
     ///\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
@@ -427 +427 @@
     ///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) 
     {
@@ -441 +441 @@
     }
       
-    ///Class to make a snapshot of the graph and to restrore to 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.
+
+    ///Class to make a snapshot of the graph and to restore  it later.
     ///
     ///The newly added nodes and edges can be removed using the