Re: [Boost-users] [BGL] boost/graph/graph_utility.hpp - cannot find any documentation

Subject: Re: [Boost-users] [BGL] boost/graph/graph_utility.hpp - cannot find any documentation
From: Jeremiah Willcock (jewillco_at_[hidden])
Date: 2011-10-07 17:26:13

On Fri, 7 Oct 2011, Christoph wrote:

> Hi,
>
> i would like to know why it is, that there is no documentation about
>
> boost/graph/graph_utility.hpp
>
> Functions like 'print_graph' or 'print_edges' are used quite often in
> the examples, for instance here
>
> http://www.boost.org/doc/libs/1_47_0/libs/graph/doc/filtered_graph.html
>
> For a newbie, as i am, it is always confusing to have to deal with
> undocumented functions.
>
> How should i start in such a case. I finally did something like
>
> find ./ | xargs grep print_edges
>
> inside of my boost directory. Are there any other undocumented functions
> within the Boost Graph Library?

There are a bunch, mostly from things being put in and then people 
forgetting to document them.  Examples should not be using undocumented 
functions, though.

-- Jeremiah Willcock