Subject: Re: [boost] QuickBook generate table of references?
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2016-01-27 05:47:59
> -----Original Message-----
> From: Boost [mailto:boost-bounces_at_[hidden]] On Behalf Of Nat Goodspeed
> Sent: 27 January 2016 00:04
> To: boost_at_[hidden]
> Subject: [boost] QuickBook generate table of references?
> I have a biggish document consisting of a number of different .qbk files -- big enough to make it
> unreasonable to start over with a different toolchain.
> I would like to mark up particular methods of particular classes in such a way that QuickBook will
> produce a consolidated list of links to those methods.
> I read a little about DocBook being able to generate tables of figures, etc., but between
> syntax and the final output document, my mental model has a big "then a miracle occurs" cloud.
> Will someone please show me how this is achieved? Thank you!
I recommend using Doxygen and marking up the include files containing the methods/functions using
the Doxygen Syntax http://www.stack.nl/~dimitri/doxygen/manual/commands.html.
You can then use also Boost Autoindex to get an index of all methods (and classes etc).
Getting set up to build docs is a bit tiresome, but works slickly once set up.
to get the flavour of what you get, you can see some unfinished work in progress:
Some typical Doxygen syntax comments (starting with /*!) are in this file, for example
If you are fumbling (I did) with the setup, contact me off-list. I can provide a dummy docs that
will allow you to check that all is working right before altering your real project files.
--- Paul A. Bristow Prizet Farmhouse Kendal UK LA8 8AB +44 (0) 1539 561830
Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk