Re: [Boost-docs] Quickbook with Doxygen autodoc - How to get the function (and enum) descriptions?

Subject: Re: [Boost-docs] Quickbook with Doxygen autodoc - How to get the function (and enum) descriptions?
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2009-03-09 10:39:54

> -----Original Message-----
> From: boost-docs-bounces_at_[hidden] [mailto:boost-docs-
> bounces_at_[hidden]] On Behalf Of Daniel James
> Sent: 08 March 2009 10:04
> To: Discussion of Boost Documentation
> Subject: Re: [Boost-docs] Quickbook with Doxygen autodoc - How to get the
function
> (and enum) descriptions?
> 
> 2009/3/2 Paul A. Bristow <pbristow_at_[hidden]>:
> >
> > I expect/hope_very_much to see the comment as well, like this:
> >
> >   size_t series_count(); // Get number of normal data points in this
data
> > series.
> >
> > So what I am doing wrong that I don't get the <purpose> information
shown in
> > either place?
> 
> Boostbook wasn't displaying any purposes that just contained plain
> text (which is what doxygen generates). I've fixed that, although the
> purpose is displayed in the description section of the page not in the
> synopsis.
> 
> I tried building your documentation to see if it this makes a
> difference, but the build failed. Something about a missing
> 'auto-index.jam' file.

Thanks for looking into this.

I've updated to 

Completed: At revision: 51655  

On trunk

But this doesn't seem to fix the problem (unless I have screwed up -
Tortoise doesn't give this file the green tick despite saying updated OK, so
I might have blundered somewhere) .  I'll check more carefully - and why you
could not build as well. 

Since I now have almost 300 functions documented - but not showing comments
describing their functions, this is a matter of some serious concern to me
;-)

I had started to ponder this myself.  Some notes on what I thought might
perhaps be a solution is attached.

Am I at all warm on this?

Thanks.

Paul

---
Paul A. Bristow
Prizet Farmhouse
Kendal, UK   LA8 8AB
[phone], mobile [phone]
pbristow_at_[hidden]