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

[Lemon SVN]

Author: alpar
Date: Tue Jul 11 15:51:52 2006
New Revision: 2836

Modified:
   hugo/trunk/lemon/list_graph.h
   hugo/trunk/lemon/smart_graph.h

Log:
Minor doc improvements

Modified: hugo/trunk/lemon/list_graph.h
==============================================================================
--- hugo/trunk/lemon/list_graph.h	(original)
+++ hugo/trunk/lemon/list_graph.h	Tue Jul 11 15:51:52 2006
@@ -166,6 +166,8 @@
 
     /// 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.)
     Node addNode() {     
@@ -349,6 +351,8 @@
     ///\note The <tt>Edge</tt>s and <tt>OutEdgeIt</tt>s referencing
     ///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); 
     }
@@ -359,6 +363,8 @@
     ///\note The <tt>Edge</tt>s and <tt>InEdgeIt</tt>s referencing
     ///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);
     }
@@ -368,6 +374,8 @@
     ///\note The <tt>Edge</tt>s referencing the changed edge remain
     ///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);
       changeTarget(e,source(e));
@@ -379,7 +387,7 @@
 
     ///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); };
 
@@ -404,6 +412,8 @@
     ///referencing a moved edge remain
     ///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) 
     {
       for(OutEdgeIt e(*this,b);e!=INVALID;) {
@@ -680,9 +690,7 @@
       
       /// \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();
 	while(!added_edges.empty()) {

Modified: hugo/trunk/lemon/smart_graph.h
==============================================================================
--- hugo/trunk/lemon/smart_graph.h	(original)
+++ hugo/trunk/lemon/smart_graph.h	Tue Jul 11 15:51:52 2006
@@ -239,7 +239,7 @@
   ///that <b> it does support only limited (only stack-like)
   ///node and edge deletions</b>.
   ///It conforms to 
-  ///the \ref concept::Graph "Graph" concept.
+  ///the \ref concept::Graph "Graph concept".
   ///\sa concept::Graph.
   ///
   ///\author Alpar Juttner
@@ -370,7 +370,7 @@
   /// that <b> it does support only limited (only stack-like)
   /// node and edge deletions</b>.
   /// Except from this it conforms to 
-  /// the \ref concept::UGraph "UGraph" concept.
+  /// the \ref concept::UGraph "UGraph concept".
   /// \sa concept::UGraph.
   ///
   /// \todo Snapshot hasn't been implemented yet.
@@ -604,7 +604,7 @@
   /// It is also quite memory efficient, but at the price
   /// that <b> it does not support node and edge deletions</b>.
   /// Except from this it conforms to 
-  /// the \ref concept::BpUGraph "BpUGraph" concept.
+  /// the \ref concept::BpUGraph "BpUGraph concept".
   /// \sa concept::BpUGraph.
   ///
   class SmartBpUGraph : public ExtendedSmartBpUGraphBase {};