[Boost-commit] svn:boost r61795 - trunk/libs/graph/doc

Subject: [Boost-commit] svn:boost r61795 - trunk/libs/graph/doc
From: jewillco_at_[hidden]
Date: 2010-05-05 14:40:48

Author: jewillco
Date: 2010-05-05 14:40:47 EDT (Wed, 05 May 2010)
New Revision: 61795
URL: http://svn.boost.org/trac/boost/changeset/61795

Log:
Fixed documentation of edge()
Text files modified: 
   trunk/libs/graph/doc/adjacency_list.html |     6 ++++--                                  
   1 files changed, 4 insertions(+), 2 deletions(-)

Modified: trunk/libs/graph/doc/adjacency_list.html
==============================================================================
--- trunk/libs/graph/doc/adjacency_list.html	(original)
+++ trunk/libs/graph/doc/adjacency_list.html	2010-05-05 14:40:47 EDT (Wed, 05 May 2010)
@@ -763,8 +763,10 @@
 edge(vertex_descriptor u, vertex_descriptor v,
      const adjacency_list& g)
 </pre>
-Returns an edge connecting vertex <tt>u</tt> to vertex <tt>v</tt> in
-graph <tt>g</tt>.
+If an edge from vertex <tt>u</tt> to vertex <tt>v</tt> exists, return a pair
+containing one such edge and <tt>true</tt>.  If there are no edges between
+<tt>u</tt> and <tt>v</tt>, return a pair with an arbitrary edge descriptor and
+<tt>false</tt>.
 
 <hr>