Re: [boost] Proposal: Identifying libraries

From: Peter Dimov (pdimov_at_[hidden])
Date: 2002-12-16 13:10:18

From: "Beman Dawes" <bdawes_at_[hidden]>
> At 11:15 AM 12/16/2002, Douglas Gregor wrote:
>
>  >On Monday 16 December 2002 09:17 am, Beman Dawes wrote:
>  >> I'd like to propose changing that (particularly for headers) to:
>  >>
>  >> // See http://www.boost.org/library-name for documentation.
>  >
>  >I assume you mean "http://www.boost.org/libs/library-name"?
>  >
>  >> and require that it be the first instance of "http://www.boost.org/"
in
> a
>  >> source file.
>  >>
>  >> That will make it easy to associate a header with the library it
> belongs
>  >> to, and may also help users reach documentation quickly.
>  >>
>  >> Comments?
>  >>
>  >> --Beman
>  >
>  >Sounds good. I think we should try to do the conversion automatically,
at
>
>  >least for all files in subdirectories (e.g., the file boost/xxx/yyy.hpp
>  >would be assumed to be a part of library xxx if libs/xxx exists) and for
>  >files boost/xxx.hpp where there is a library in libs/xxx. We don't want
>  >to do this conversion by hand :)
>
> Good point! I'll whack together a little program to do the above (after
> waiting awhile to make sure such a change is acceptable to others.)

I agree with the general intent of the proposal (in fact I've been using
direct links to the .html file with the documentation for some time now) but
how does this affect (implementation detail) headers that aren't necessarily
part of a specific library? boost/detail/lightweight_mutex.hpp,
boost/assert.hpp, boost/throw_exception.hpp, for example.