Re: [boost] graph library questions

From: Beman Dawes (beman_at_[hidden])
Date: 2000-09-29 13:15:22

At 12:14 PM 9/29/2000 -0400, David Abrahams wrote:
 >
 >>  > I tried to find some of the answers by going through the source 
code,
 >>  > but as I am just getting familiar with STL, it is a daunting task at
 >>  > the moment :-)
 >>
 >> Some of these answers are in the new HTML documentation. I'll also
 >> be filling in the docs more (especially with answers that I give
 >> to email questions).
 >>
 >> http://www.boost.org/libs/graph/docs/adjacency_list.html
 >> and
 >> http://www.boost.org/libs/graph/docs/using_adjacency_list.html
 >
 >That's great, but we should also get a lot more commentary into the code
 >itself, especially if the hope is to pass maintenance responsibility on
 >someday.

I've been trying something in some industrial code I maintain that seems to 
be useful:

In the C++ source file, I include comments like:

     do_adjacency_list_func(); // See docs/adjacency_list.html

I wrote a little VC++ plugin that invokes any selected text as a 
command.  So you select docs/adjacency_list.html, and click the plugin's 
toolbar icon, and the browser starts, displaying docs/adjacency_list.html.

Now if IDE vendors would just start building that functionality into their 
source editors...

--Beman