Boost logo

Boost :

Subject: Re: [boost] Improving Documentation
From: Mathias Gaunard (mathias.gaunard_at_[hidden])
Date: 2013-10-11 13:03:08


On 11/10/13 18:58, Felipe Magno de Almeida wrote:
> On Fri, Oct 11, 2013 at 4:57 PM, Mathias Gaunard
> <mathias.gaunard_at_[hidden]> wrote:
>> On 11/10/13 15:31, TONGARI J wrote:
>>
>>> I think Doxygen is fine for "regular" libraries, but I always have a
>>> question: how could a library like Spirit be doucumented with it?
>>
>>
>> Same as any other library.
>> You document the data types and the functions.
>
> So you don't document the grammar?

The grammar is a property of the input, which is documented as part of
the preconditions of each function.


Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk