[boost] BGL: more doc buglets

[Vladimir Prus]

I've come across more problems with documentation.

1. The docs for topological_sort say that if (u,v) edge is present,
then u comes before v in the topological order. I was assuming
that if I store the order in vector, then u will be found before
v. Instead, the order is reversed! This can only be learned from
the example at the botton -- which is the last place to look at.

2. The example for the same function is wrong. The graph has a
5 -> 5 edge and is not DAG. libs/graph/example/topo_sort.cpp
fails for that reason.

3. Docs the the same function say that the default value of i_map
parameter is "get(vertex_index, g)". Unless I'm missing something,
this should be "get(vertex_index_t(), g)".

4. The docs for the "write_graphviz" function do not mention the
"default_writer" class. I believe they should --- it's important
when one want to output onle edge properties.

5. libs/graph/doc/PropertyGraph.html says:

boost::property_map<G, PropertyTag>::type
The type of the property map for the property specified by PropertyTag.
This type must be a model of ReadWritePropertyMap with a key type the same
as the graph's vertex or (****) descriptor type.

"edge" is missing in the marked position.

6. I did not see anywhere the stament that property map obtained from
PropertyGraph are actually a kind of references into the internal
property map. I can conjecure this is so, but a clean statement would
we better.

It would be nice to fix those problem. In fact, I can fix most of them myself, if Jeremy doesn't mind.

- Volodya

_______________________________________________
Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost