Re: Add a header -> library index?

From: Daryle Walker (darylew_at_[hidden])
Date: 2001-06-05 12:55:34

on 6/5/01 3:30 PM, Bill Kempf at williamkempf_at_[hidden] wrote:

> --- In boost_at_y..., Daryle Walker <darylew_at_m...> wrote:
>> The documentation has a page listing each of the libraries, and we can look
>> in each one to see what headers go with a library.  Sometimes, I need to go
>> the other way; I need to know where the documentation is for a header at
>> which I'm looking.  The answer isn't always obvious from the header's name;
>> and we shouldn't have to be guessing anyway, even for "obvious" names. Could
>> we add a documentation page that lists each (public) header file and gives
>> where the header's documentation is?
> 
> Wouldn't it be handier to have the link embedded in a comment at the top of
> the header file?

Possibly, but we would risk having to update headers only for documentation
maintenance.

>> On a separate note, maybe that page could list the mandatory source files.
> 
> That sounds like overkill, especially with the coming Boost.Build system.  Or
> am I missing some reason beyond building that you think this information would
> be good for?

No, I'm just pondering.  It's also works in the case the user can't/won't
use the build system.

-- 
Daryle Walker
Mac, Internet, and Video Game Junkie
darylew AT mac DOT com