[Boost-commit] svn:boost r53366 - trunk/libs/graph_parallel/doc

Subject: [Boost-commit] svn:boost r53366 - trunk/libs/graph_parallel/doc
From: ngedmond_at_[hidden]
Date: 2009-05-28 18:01:17

Author: ngedmond
Date: 2009-05-28 18:01:16 EDT (Thu, 28 May 2009)
New Revision: 53366
URL: http://svn.boost.org/trac/boost/changeset/53366

Log:
Corrected type of some parameters (OUT vs. IN, etc.) 

Text files modified: 
   trunk/libs/graph_parallel/doc/connected_components.rst |     4 ++--                                    
   trunk/libs/graph_parallel/doc/strong_components.rst    |     4 ++--                                    
   2 files changed, 4 insertions(+), 4 deletions(-)

Modified: trunk/libs/graph_parallel/doc/connected_components.rst
==============================================================================
--- trunk/libs/graph_parallel/doc/connected_components.rst	(original)
+++ trunk/libs/graph_parallel/doc/connected_components.rst	2009-05-28 18:01:16 EDT (Thu, 28 May 2009)
@@ -80,7 +80,7 @@
 IN:  ``Graph& g``
   The graph typed must be a model of `Distributed Graph`_.
 
-IN:  ``ComponentMap c``
+OUT:  ``ComponentMap c``
   The algorithm computes how many connected components are in the
   graph, and assigns each component an integer label.  The algorithm
   then records to which component each vertex in the graph belongs by
@@ -92,7 +92,7 @@
   component map and parent information will be provided in the parent
   map. 
 
-IN:  ``ParentMap p``
+UTIL:  ``ParentMap p``
   A parent map may be supplied to the algorithm, if not supplied the
   parent map will be constructed automatically.  The ``ParentMap`` type
   must be a `Distributed Property Map`_.  The value type and key type

Modified: trunk/libs/graph_parallel/doc/strong_components.rst
==============================================================================
--- trunk/libs/graph_parallel/doc/strong_components.rst	(original)
+++ trunk/libs/graph_parallel/doc/strong_components.rst	2009-05-28 18:01:16 EDT (Thu, 28 May 2009)
@@ -61,7 +61,7 @@
   The graph type must be a model of `Distributed Graph`_.  The graph
   type must also model the `Incidence Graph`_ and be directed.
 
-IN:  ``ComponentMap c``
+OUT:  ``ComponentMap c``
   The algorithm computes how many strongly connected components are in the
   graph, and assigns each component an integer label.  The algorithm
   then records to which component each vertex in the graph belongs by
@@ -70,7 +70,7 @@
   value type must be the ``vertices_size_type`` of the graph.  The key
   type must be the graph's vertex descriptor type.
 
-IN:  ``VertexComponentMap r``
+UTIL:  ``VertexComponentMap r``
   The algorithm computes a mapping from each vertex to the
   representative of the strong component, stored in this property map.
   The ``VertexComponentMap`` type must be a `Distributed Property Map`_.