[boost] [doc] General Boost documentation suggestion

From: Edward Diener (eldiener_at_[hidden])
Date: 2008-08-17 22:02:27

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 !