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

From: David Abrahams (dave_at_[hidden])
Date: 2008-08-17 23:45:21

on Sun Aug 17 2008, Edward Diener <eldiener-AT-tropicsoft.com> wrote:

> This is an impassioned plea for all library developers writing
> documentation about classes and/or functions ( including class
> templates and function templates ). Please, please put somewhere in
> the low-level description/explanation of that class and function both
> the full namespace it is in and the header file which must be
> included.
>
> 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.
>
> Thank you !

Hi Edward,

Please enter tickets into our trac when that happens to you, or most
opportunities to make corrections will surely be overlooked.

Thanks,

-- 
Dave Abrahams
BoostPro Computing
http://www.boostpro.com