Boost logo

Boost :

Subject: Re: [boost] dynamically coupling documentation to unit testing
From: Eric Niebler (eniebler_at_[hidden])
Date: 2014-06-27 14:52:13


On 06/25/2014 07:23 AM, Roger Martin wrote:
> Hi,
>
> Been thinking.
>
> What I've come to like in documentation is a section at the top of a
> class or functor that includes some real examples code in the 'doxygen'
> section that shows how to use.

If you're already using the "standard" Boost documentation toolchain
(doxygen and Quickbook), you get this out of the box.

http://www.boost.org/doc/libs/1_55_0/doc/html/quickbook/syntax/block.html#quickbook.syntax.block.import

I see others have already pointed you to working examples.

\e


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