Re: [boost] QuickBook generate table of references?

Subject: Re: [boost] QuickBook generate table of references?
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2016-01-27 12:18:54

> -----Original Message-----
> From: Boost [mailto:boost-bounces_at_[hidden]] On Behalf Of Nat Goodspeed
> Sent: 27 January 2016 15:18
> To: boost_at_[hidden]
> Subject: Re: [boost] QuickBook generate table of references?
> 
> On Wed, Jan 27, 2016 at 10:16 AM, Nat Goodspeed <nat_at_[hidden]> wrote:
> 
> > I would like to insert into the middle of the document (well, early
> > on, but whatever) a list of class::method names, each of which links
> > to its own documentation section.
> 
> But this should be a list of the specifically marked class::methods, rather than a comprehensive
list of
> all methods described in the document.

I can't see how to do this automatically rather than a manual Quickbook table one of whose fields is
links to the matching anchor for the method documentation.

If you are willing to go the Doxygen syntax route, then you could 

* control which methods *generate documentation* by using the Doxygen setting to only include
methods for which doxygen syntax documentation is provided (in the header file of course - where it
belongs IMO) 

and then 

* insert an index of methods anywhere you like in the Quickbook document.  This would look like the
method index in the example I gave earlier, but not provide links to anchor, but links to the
Doxygen syntax documentation directly.

Sounds like you shouldn't start from where you are!

I suspect that you are better off doing it by hand, however tedious.  But of course if you change
anything, you will have to change the documentation by hand, exactly what an automated system is
trying to avoid.

Paul

---
Paul A. Bristow
Prizet Farmhouse
Kendal UK LA8 8AB
[phone]