Re: [boost] Improving Documentation

-----Original Message----- From: Boost [mailto:boost-bounces@lists.boost.org] On Behalf Of Andrew Hundt Sent: Friday, October 11, 2013 8:42 PM To: boost@lists.boost.org Subject: Re: [boost] Improving Documentation

On Fri, Oct 11, 2013 at 2:49 PM, 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?

You can document template parameters with doxygen. If you are using the boost concept check

you can also use those classes to document your concepts. I believe gil does that if you would

library like an

example. You can also always add custom fields fairly easily if none of the existing ones meet you needs.

You can also document \pre and \post conditions - aka 'concepts'. This with \returns \param and \tparam allows one to match the info and style of SGI style documentation (but with hyperlinking). (and there are others like \sa = see also). Paul