Changeset 2123:85c6f5e82108 in lemon-0.x for lemon/list_graph.h

Timestamp:

07/11/06 15:51:52 (18 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

Minor doc improvements

File:

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

lemon/list_graph.h

@@ -167 +167 @@
     /// Adds a new node to the graph.
 
+    /// Adds a new node to the graph.
+    ///
     /// \warning It adds the new node to the front of the list.
     /// (i.e. the lastly added node becomes the first.)
@@ -350 +352 @@
     ///the changed edge remain valid. However <tt>InEdgeIt</tt>s are
     ///invalidated.
+    ///\warning This functionality cannot be used together with the Snapshot
+    ///feature.
     void changeTarget(Edge e, Node n) { 
       Parent::changeTarget(e,n); 
@@ -360 +364 @@
     ///the changed edge remain valid. However <tt>OutEdgeIt</tt>s are
     ///invalidated.
+    ///\warning This functionality cannot be used together with the Snapshot
+    ///feature.
     void changeSource(Edge e, Node n) { 
       Parent::changeSource(e,n);
@@ -369 +375 @@
     ///valid. However <tt>OutEdgeIt</tt>s and <tt>InEdgeIt</tt>s are
     ///invalidated.
+    ///\warning This functionality cannot be used together with the Snapshot
+    ///feature.
     void reverseEdge(Edge e) {
       Node t=target(e);
@@ -380 +388 @@
     ///Using this it is possible to avoid the superfluous memory
     ///allocation: if you know that the graph you want to build will
-    ///contain at least 10 million nodes then it is worth to reserve
+    ///contain at least 10 million nodes then it is worth reserving
     ///space for this amount before starting to build the graph.
     void reserveNode(int n) { nodes.reserve(n); };
@@ -405 +413 @@
     ///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.
     void contract(Node a, Node b, bool r = true) 
     {
@@ -681 +691 @@
       /// \brief Undo the changes until the last snapshot.
       // 
-      /// Undo the changes until last snapshot created by save().
-      ///
-      /// \todo This function might be called undo().
+      /// Undo the changes until the last snapshot created by save().
       void restore() {
         detach();