Re: [boost] Why use Boost?

From: David Maisonave (dmaisonave_at_[hidden])
Date: 2006-02-03 10:33:34

"David Abrahams" <dave_at_[hidden]> wrote in message
news:<ud5i4hat0.fsf_at_[hidden]>...
> "David Maisonave" <dmaisonave_at_[hidden]> writes:
> >> > Actually, I would rather invest the time in creating an automated
> >> > documentation wizard.
> >> 
> >> Great!  Any contribution that you can make will have a huge impact.
> >> What do you have in mind, if I may ask?
> >
> > I was thinking of a web based form.
> 
> I wasn't asking what the specific medium would be; I was wondering 
> what it would actually *do*.

At first I was think of a step by step wizard, in which it would ask you
for specifics of the target code, and required documentation for the
code.

Example Form:
------------------------------------------------------------------------
--------------------
Object name:
Introduction:
Two-minute tutorial: (optional)
Parameters:
Required Headers:
Example Usage:
See Also: (optional)
Motivation (Rationale): (optional)
Notes: (optional)
FAQ:  (optional)
Members: Introduction, Parameters, (Requirements)Required-Preconditions,

         Postconditions, Effects, Returns, Throws, Notes,
Synopsis:
------------------------------------------------------------------------
--------------------