Boost logo

Boost :

Subject: Re: [boost] Change to documentation writing guidelines
From: Edward Diener (eldiener_at_[hidden])
Date: 2009-06-01 09:36:51

Daniel James wrote:
> Hi,
> I'd like to change the guideline for writing reference documentation
> to include header and namespace information in the detailed
> documentation. If you arrive at a page by a link or from a search
> engine, it isn't always easy to work this out. I'll add them to the
> list here:

Thanks for pushing this through. I know I suggested this in a Trac
ticket and, as an end user of Boost libraries, I think it will make it
easier and quicker to use library functionality when header and
namespace is explicitly stated for the classes and functions in a
library in the reference docs. Hopefully library authors will follow up
with this in their own documentation.

Boost list run by bdawes at, gregod at, cpdaniel at, john at