Minor doc improvements
authoralpar
Tue, 11 Jul 2006 13:51:52 +0000
changeset 212385c6f5e82108
parent 2122 5b3737aa595a
child 2124 c3b9c574fa3e
Minor doc improvements
lemon/list_graph.h
lemon/smart_graph.h
     1.1 --- a/lemon/list_graph.h	Tue Jul 11 12:37:53 2006 +0000
     1.2 +++ b/lemon/list_graph.h	Tue Jul 11 13:51:52 2006 +0000
     1.3 @@ -166,6 +166,8 @@
     1.4  
     1.5      /// Adds a new node to the graph.
     1.6  
     1.7 +    /// Adds a new node to the graph.
     1.8 +    ///
     1.9      /// \warning It adds the new node to the front of the list.
    1.10      /// (i.e. the lastly added node becomes the first.)
    1.11      Node addNode() {     
    1.12 @@ -349,6 +351,8 @@
    1.13      ///\note The <tt>Edge</tt>s and <tt>OutEdgeIt</tt>s referencing
    1.14      ///the changed edge remain valid. However <tt>InEdgeIt</tt>s are
    1.15      ///invalidated.
    1.16 +    ///\warning This functionality cannot be used together with the Snapshot
    1.17 +    ///feature.
    1.18      void changeTarget(Edge e, Node n) { 
    1.19        Parent::changeTarget(e,n); 
    1.20      }
    1.21 @@ -359,6 +363,8 @@
    1.22      ///\note The <tt>Edge</tt>s and <tt>InEdgeIt</tt>s referencing
    1.23      ///the changed edge remain valid. However <tt>OutEdgeIt</tt>s are
    1.24      ///invalidated.
    1.25 +    ///\warning This functionality cannot be used together with the Snapshot
    1.26 +    ///feature.
    1.27      void changeSource(Edge e, Node n) { 
    1.28        Parent::changeSource(e,n);
    1.29      }
    1.30 @@ -368,6 +374,8 @@
    1.31      ///\note The <tt>Edge</tt>s referencing the changed edge remain
    1.32      ///valid. However <tt>OutEdgeIt</tt>s and <tt>InEdgeIt</tt>s are
    1.33      ///invalidated.
    1.34 +    ///\warning This functionality cannot be used together with the Snapshot
    1.35 +    ///feature.
    1.36      void reverseEdge(Edge e) {
    1.37        Node t=target(e);
    1.38        changeTarget(e,source(e));
    1.39 @@ -379,7 +387,7 @@
    1.40  
    1.41      ///Using this it is possible to avoid the superfluous memory
    1.42      ///allocation: if you know that the graph you want to build will
    1.43 -    ///contain at least 10 million nodes then it is worth to reserve
    1.44 +    ///contain at least 10 million nodes then it is worth reserving
    1.45      ///space for this amount before starting to build the graph.
    1.46      void reserveNode(int n) { nodes.reserve(n); };
    1.47  
    1.48 @@ -404,6 +412,8 @@
    1.49      ///referencing a moved edge remain
    1.50      ///valid. However <tt>InEdge</tt>s and <tt>OutEdge</tt>s
    1.51      ///may be invalidated.
    1.52 +    ///\warning This functionality cannot be used together with the Snapshot
    1.53 +    ///feature.
    1.54      void contract(Node a, Node b, bool r = true) 
    1.55      {
    1.56        for(OutEdgeIt e(*this,b);e!=INVALID;) {
    1.57 @@ -680,9 +690,7 @@
    1.58        
    1.59        /// \brief Undo the changes until the last snapshot.
    1.60        // 
    1.61 -      /// Undo the changes until last snapshot created by save().
    1.62 -      ///
    1.63 -      /// \todo This function might be called undo().
    1.64 +      /// Undo the changes until the last snapshot created by save().
    1.65        void restore() {
    1.66  	detach();
    1.67  	while(!added_edges.empty()) {
     2.1 --- a/lemon/smart_graph.h	Tue Jul 11 12:37:53 2006 +0000
     2.2 +++ b/lemon/smart_graph.h	Tue Jul 11 13:51:52 2006 +0000
     2.3 @@ -239,7 +239,7 @@
     2.4    ///that <b> it does support only limited (only stack-like)
     2.5    ///node and edge deletions</b>.
     2.6    ///It conforms to 
     2.7 -  ///the \ref concept::Graph "Graph" concept.
     2.8 +  ///the \ref concept::Graph "Graph concept".
     2.9    ///\sa concept::Graph.
    2.10    ///
    2.11    ///\author Alpar Juttner
    2.12 @@ -370,7 +370,7 @@
    2.13    /// that <b> it does support only limited (only stack-like)
    2.14    /// node and edge deletions</b>.
    2.15    /// Except from this it conforms to 
    2.16 -  /// the \ref concept::UGraph "UGraph" concept.
    2.17 +  /// the \ref concept::UGraph "UGraph concept".
    2.18    /// \sa concept::UGraph.
    2.19    ///
    2.20    /// \todo Snapshot hasn't been implemented yet.
    2.21 @@ -604,7 +604,7 @@
    2.22    /// It is also quite memory efficient, but at the price
    2.23    /// that <b> it does not support node and edge deletions</b>.
    2.24    /// Except from this it conforms to 
    2.25 -  /// the \ref concept::BpUGraph "BpUGraph" concept.
    2.26 +  /// the \ref concept::BpUGraph "BpUGraph concept".
    2.27    /// \sa concept::BpUGraph.
    2.28    ///
    2.29    class SmartBpUGraph : public ExtendedSmartBpUGraphBase {};