Re: [boost] [doc] General Boost documentation suggestion

From: Edward Diener (eldiener_at_[hidden])
Date: 2008-08-18 09:31:38

John Maddock wrote:
> Edward Diener wrote:
>> Numerous times, using the functionality of an otherwise wonderful
>> Boost library, I have had to hunt through the rest of that library's
>> documentation to find the full namespace and header file which must be
>> included in order to correctly use a particular function or class.
>> This is irritatingly time consuming and can be remedied in all cases 
>> by the
>> suggestion above.
> 
> I'd second that. 
> Of course it's quite possible I may be guilty of the above as well....

You are occasionally, but so are most Boost developers in the reference
documentation for a library.

It would be real nice if, as a generally agreed documentation convention
for Boost libraries, the #include file and namespace were listed
separately at the top of each detailed explanation in a library's
reference documentation.

I have posted this as a Trac item, as Dave suggested.