[boost] BGL: concept docs buglets

From: Vladimir Prus (ghost_at_[hidden])
Date: 2003-01-05 04:24:35

I think that BGL concept docs are a little bit out of sync with
the concept cheking code. I've corrected some of problems and
attach a patch. Is it OK to apply it?

Another issue is that doc talk about MutablePropertyGraphConcept,
while code has LvaluePropertyGraphConcept. I'm not sure which one
is correct.

- Volodya


? boost/graph/ChangeLog
Index: boost/graph/graph_concepts.hpp
===================================================================
RCS file: /cvsroot/boost/boost/boost/graph/graph_concepts.hpp,v
retrieving revision 1.30
diff -u -r1.30 graph_concepts.hpp
--- boost/graph/graph_concepts.hpp	18 Jan 2002 03:12:23 -0000	1.30
+++ boost/graph/graph_concepts.hpp	5 Jan 2003 09:18:24 -0000
@@ -217,6 +217,15 @@
     G g;
   };
 
+  template <class G>
+  struct VertexAndEdgeListGraphConcept
+  {
+    void constraints() {
+      function_requires< VertexListGraphConcept<G> >();    
+      function_requires< EdgeListGraphConcept<G> >();
+    }
+  };
+
   // Where to put the requirement for this constructor?
   //      G g(n_vertices);
   // Not in mutable graph, then LEDA graph's can't be models of
Index: libs/graph/doc/BidirectionalGraph.html
===================================================================
RCS file: /cvsroot/boost/boost/libs/graph/doc/BidirectionalGraph.html,v
retrieving revision 1.5
diff -u -r1.5 BidirectionalGraph.html
--- libs/graph/doc/BidirectionalGraph.html	24 Jun 2002 16:37:02 -0000	1.5
+++ libs/graph/doc/BidirectionalGraph.html	5 Jan 2003 09:18:24 -0000
@@ -144,7 +144,7 @@
 
 <PRE>
   template &lt;class G&gt;
-  struct BidirectionalGraph_concept
+  struct BidirectionalGraphConcept
   {
     typedef typename boost::graph_traits&lt;G&gt;::in_edge_iterator
       in_edge_iterator;
Index: libs/graph/doc/VertexAndEdgeListGraph.html
===================================================================
RCS file: /cvsroot/boost/boost/libs/graph/doc/VertexAndEdgeListGraph.html,v
retrieving revision 1.3
diff -u -r1.3 VertexAndEdgeListGraph.html
--- libs/graph/doc/VertexAndEdgeListGraph.html	1 Nov 2001 17:22:28 -0000	1.3
+++ libs/graph/doc/VertexAndEdgeListGraph.html	5 Jan 2003 09:18:24 -0000
@@ -52,7 +52,7 @@
 <P>
 <PRE>
   template &lt;class G&gt;
-  struct VertexAndEdgeListGraph
+  struct VertexAndEdgeListGraphConcept
   {
     void constraints() {
       function_requires&lt; VertexListGraphConcept&lt;G&gt; &gt;();