on Wed Jul 11 2007, "John Maddock" <john-AT-johnmaddock.co.uk> wrote:
> David Abrahams wrote: >> ...unless the code examples in our documentation are tested, they >> will be wrong... >> >> For those willing to use RestructuredText, there is LitRe, in the >> tools subdirectory of the Boost tree. Aleksey and I used that for our >> book and Daniel and I used it for the Boost.Parameter docs. >> http://lists.boost.org/boost-testing/2005/03/0493.php > > You can already use quickbook to import your code examples (AKA "reverse > literate programming"), I know. > so it is possible to have only one version of an > example, and to have it tested as well as in the docs, albeit not in the way > you invision. > > It would still make a great feature though.. Yeah. Well it doesn't need to be a feature of quickbook... in fact it probably shouldn't be. It should be a postprocessing step on the QB XML output. We can use QB templates to generate special XML tags that enclose testing instructions. Most of the infrastructure of LitRe could be reused. -- Dave Abrahams Boost Consulting http://www.boost-consulting.com The Astoria Seminar ==> http://www.astoriaseminar.com ------------------------------------------------------------------------- This SF.net email is sponsored by DB2 Express Download DB2 Express C - the FREE version of DB2 express and take control of your XML. No limits. Just data. Click to get it now. http://sourceforge.net/powerbar/db2/ _______________________________________________ Boost-docs mailing list [email protected] Unsubscribe and other administrative requests: https://lists.sourceforge.net/lists/listinfo/boost-docs
