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

From: Edward Diener (eldiener_at_[hidden])
Date: 2007-11-18 08:21:01

David Abrahams wrote:
> on Fri Nov 16 2007, Beman Dawes <bdawes-AT-acm.org> 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.
> 
> Without giving precise directions for identifying the library (not
> just a typical example), I don't see how the result can be useful to
> scripts.
> 

Why not enforce some Doxygen rules for such things among Boost 
developers, which would help Python scripts find what is necessary in 
header files ?