[Boost-bugs] [Boost C++ Libraries] #4386: Some documentation bugs

Subject: [Boost-bugs] [Boost C++ Libraries] #4386: Some documentation bugs
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2010-06-28 19:37:26

#4386: Some documentation bugs
------------------------------------------------------+---------------------
 Reporter:  Matthias Berndt <matthias_berndt@…>       |       Owner:  asutton
     Type:  Bugs                                      |      Status:  new    
Milestone:  To Be Determined                          |   Component:  graph  
  Version:  Boost 1.43.0                              |    Severity:  Problem
 Keywords:                                            |  
------------------------------------------------------+---------------------
 Hi,

 i have hit a few documentation bugs in the graph library's documentation
 that made it hard for me to make sense of it.

 On http://www.boost.org/doc/libs/1_43_0/libs/graph/doc/graph_concepts.html

 it says that VertexListGraph refines IncidenceGraph and AdjacencyGraph,
 but this can't be seen in the diagram in figure 1.

 On
 http://www.boost.org/doc/libs/1_43_0/libs/graph/doc/VertexListGraph.html

 it says that VertexListGraph refines Graph, but it doesn't say that it
 refines AdjacencyGraph and IncidenceGraph.

 On http://www.boost.org/doc/libs/1_43_0/libs/graph/doc/astar_search.html

 it says: "Please note that astar_search_no_init() must be used for
 implicit graphs; the basic astar_search() function requires a graph that
 models VertexListGraph". This seems to imply that astar_search_no_init()
 doesn't require a VertexListGraph. Nevertheless, the template parameter in
 the prototype for the function is called VertexListGraph. Shouldn't that
 be IncidenceGraph?

-- 
Ticket URL: <https://svn.boost.org/trac/boost/ticket/4386>
Boost C++ Libraries <http://www.boost.org/>
Boost provides free peer-reviewed portable C++ source libraries.