Re: [boost] Change to documentation writing guidelines

Subject: Re: [boost] Change to documentation writing guidelines
From: Stewart, Robert (Robert.Stewart_at_[hidden])
Date: 2009-06-01 11:42:26

Edward Diener wrote
On Monday, June 01, 2009 9:37 AM
> >
> > I'd like to change the guideline for writing reference documentation
> > to include header and namespace information in the detailed
> > documentation.
>
> 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.

+1

_____
Rob Stewart                           robert.stewart_at_[hidden]
Software Engineer, Core Software      using std::disclaimer;
Susquehanna International Group, LLP  http://www.sig.com

IMPORTANT: The information contained in this email and/or its attachments is confidential. If you are not the intended recipient, please notify the sender immediately by reply and immediately delete this message and all its attachments. Any review, use, reproduction, disclosure or dissemination of this message or any attachment by an unintended recipient is strictly prohibited. Neither this message nor any attachment is intended as or should be construed as an offer, solicitation or recommendation to buy or sell any security or other financial instrument. Neither the sender, his or her employer nor any of their respective affiliates makes any warranties as to the completeness or accuracy of any of the information contained herein or that this message or any of its attachments is free of viruses.