Boost logo

Boost :

Subject: Re: [boost] Improving Documentation
From: Mathias Gaunard (mathias.gaunard_at_[hidden])
Date: 2013-10-12 08:33:01

On 11/10/13 20:49, Robert Ramey wrote:
> Mathias Gaunard 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.
> what about the type constraints - aka concepts?
> and templates?

What about them?
No problem with any of those.

Concepts being entities outside of the source code, you don't use
Doxygen to define them. The definition of the concept has to be written
in Boostbook.

You can then reference your concept in Doxygen in the documentation of a
function (template or not), or from Quickbook.

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