Re: [boost] [lib maintainers] Please identify headers in boost-root/boost

From: Beman Dawes (bdawes_at_[hidden])
Date: 2007-11-17 15:23:36

Beman Dawes wrote:
> For the headers that appear in boost-root/boost, rather than a library 
> specific subdirectory, it is very helpful if they self-identify what 
> library they belong to. This allows scripts to associate the header with 
> a library.
> 
> The usual way to do this is to include a comment. A typical example:
> 
>      //  See http://www.boost.org/libs/config for documentation
> 
> The exact format doesn't matter. What does matter is that the library 
> name be found somewhere in the file, immediately following a string 
> which contains "/libs/".
> 
> Below is the result of doing:
> 
>      grep -L "/libs/" *.h*
> 
> I'd appreciate maintainers adding a library identifying comment to these 
> files. Otherwise I'll do it, which carries a slight risk that I'll get 
> it wrong.

I've now updated many of the headers that didn't have such a comment. 
There were a bunch (see below) where it wasn't obvious to me where they 
were documented.

I'd appreciate it if the authors would add a comment identifying the 
library where the docs live. If there aren't any docs, write something! 
Use libs/utility as the home for anything not associated with a 
particular library.

Thanks,

--Beman

aligned_storage.hpp
blank.hpp
blank_fwd.hpp
dynamic_property_map.hpp
function_equal.hpp
function_output_iterator.hpp
get_pointer.hpp
implicit_cast.hpp
is_placeholder.hpp
non_type.hpp
pfto.hpp
pointer_cast.hpp
smart_cast.hpp
state_saver.hpp
strong_typedef.hpp
type.hpp