Changeset 2128:509846825ddf in lemon-0.x for lemon/concept/graph.h

Timestamp:

07/11/06 18:09:49 (18 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

• Disable the copy constructor and operator= of {List|Smart}[U]Graph.
• Improve graph doc
• Also put private members into the doc (if they are documented)

File:

• lemon/concept/graph.h (modified) (4 diffs)

lemon/concept/graph.h

@@ -54 +54 @@
       ///
       Graph() { }
-
-      /// The base type of node iterators, 
-      /// or in other words, the trivial node iterator.
-
-      /// This is the base type of each node iterator,
-      /// thus each kind of node iterator converts to this.
-      /// More precisely each kind of node iterator should be inherited 
-      /// from the trivial node iterator.
+      /// Class for identifying a node of the graph
+
+      /// This class identifies a node of the graph. It also serves
+      /// as a base class of the node iterators,
+      /// thus they will convert to this type.
       class Node {
       public:
@@ -150 +147 @@
     
     
-      /// The base type of the edge iterators.
-
-      /// The base type of the edge iterators.
-      ///
+      /// Class for identifying an edge of the graph
+
+      /// This class identifies an edge of the graph. It also serves
+      /// as a base class of the edge iterators,
+      /// thus they will convert to this type.
       class Edge {
       public:
@@ -385 +383 @@
       /// ReadWrite map of the nodes to type \c T.
       /// \sa Reference
-      /// \warning Making maps that can handle bool type (NodeMap<bool>)
-      /// needs some extra attention!
       template<class T> 
       class NodeMap : public ReadWriteMap< Node, T > {
@@ -410 +406 @@
       /// Reference map of the edges to type \c T.
       /// \sa Reference
-      /// \warning Making maps that can handle bool type (EdgeMap<bool>)
-      /// needs some extra attention!
       template<class T> 
       class EdgeMap : public ReadWriteMap<Edge,T> {