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

Subject: Re: [Boost-docs] Quickbook with Doxygen autodoc - How to getthe function (and enum) descriptions?
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2009-03-09 17:18:47

 -----Original Message-----
> From: boost-docs-bounces_at_[hidden] [mailto:boost-docs-
> bounces_at_[hidden]] On Behalf Of John Maddock
> Sent: 09 March 2009 16:07
> To: Discussion of Boost Documentation
> Subject: Re: [Boost-docs] Quickbook with Doxygen autodoc - How to getthe
function
> (and enum) descriptions?
> 
> >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.
> 
> Paul, I tried building the current SVN docs for svg_plot and it looks like
> <purpose> elements are getting pushed through OK, for example in
> svg_1d_plot_series.html I see:
> 
> "18. size_t series_count() ;
> 
> Get number of normal data points in this data series. "
> 
> Maybe you need to do a bjam -a to force the docbook files to be
regenerated?

At long last I've stopped making *that* mistake ;-)  (Well not quite as
often).

But as I feared, I didn't get the update to the boost2docbook.xslt right,
but I think I have now.

The results are even more confusing (to me at least).

I get *some* of the functions comments OK, but not others  - most :-(

Text_style  is OK for example

So still in blundering mode ;-)

But thanks - I'll get back to investigating when I've sorted out the
svg_plot coding errors resulting from recent 'improvments'.

I also get these messages now

Generating XML output for the main page
<draw_plot_point_values>:4: Warning: explicit link request to 'x00A0' could
not be resolved
^^^^^This must be a missing \ before a &, but I can't see it yet.

xslt-xsltproc
..\bin.v2\doc\msvc-9.0\debug\threading-multi\autodoc-xml.doxygen
xslt-xsltproc
..\bin.v2\doc\msvc-9.0\debug\threading-multi\autodoc-xml.boostbook
I:/boost-sandbox/SOC/2007/visualization/boost/svg_plot/detail/svg_tag.hpp:26
7: Cannot handle memberdef element with kind=friend (name=operator==) 
I:/boost-sandbox/SOC/2007/visualization/boost/svg_plot/detail/svg_tag.hpp:26
8: Cannot handle memberdef element with kind=friend (name=operator!=) 
I:/boost-sandbox/SOC/2007/visualization/boost/svg_plot/detail/svg_tag.hpp:16
46: Cannot handle memberdef element with kind=friend (name=operator<<) 
I:/boost-sandbox/SOC/2007/visualization/boost/svg_plot/detail/svg_tag.hpp:16
47: Cannot handle memberdef element with kind=friend (name=operator<<) 
I:/boost-sandbox/SOC/2007/visualization/boost/svg_plot/detail/svg_tag.hpp:18
33: Cannot handle memberdef element with kind=friend (name=operator<<) 
I:/boost-sandbox/SOC/2007/visualization/boost/svg_plot/svg_1d_plot.hpp:256:
Cannot handle memberdef element with kind=friend
(name=detail::axis_plot_frame< svg_1d_plot >) 
I:/boost-sandbox/SOC/2007/visualization/boost/svg_plot/svg_1d_plot.hpp:255:
Cannot handle memberdef element with kind=friend (name=show_plot_settings) 
I:/boost-sandbox/SOC/2007/visualization/boost/svg_plot/svg_2d_plot.hpp:72:
Cannot handle memberdef element with kind=friend (name=draw_straight_lines) 
I:/boost-sandbox/SOC/2007/visualization/boost/svg_plot/svg_2d_plot.hpp:339:
Cannot handle memberdef element with kind=friend
(name=detail::axis_plot_frame< svg_2d_plot >) 
I:/boost-sandbox/SOC/2007/visualization/boost/svg_plot/svg_2d_plot.hpp:337:
Cannot handle memberdef element with kind=friend (name=show_plot_settings) 
I:/boost-sandbox/SOC/2007/visualization/boost/svg_plot/svg_boxplot.hpp:632:
Cannot handle memberdef element with kind=friend
(name=detail::axis_plot_frame< svg_boxplot >) 
I:/boost-sandbox/SOC/2007/visualization/boost/svg_plot/svg_color.hpp:84:
Cannot handle memberdef element with kind=friend (name=operator<<) 
I:/boost-sandbox/SOC/2007/visualization/boost/svg_plot/svg_style.hpp:105:
Cannot handle memberdef element with kind=friend (name=operator<<) 
I:/boost-sandbox/SOC/2007/visualization/boost/svg_plot/svg_style.hpp:303:
Cannot handle memberdef element with kind=friend (name=operator<<) 
I:/boost-sandbox/SOC/2007/visualization/boost/svg_plot/svg_style.hpp:304:
Cannot handle memberdef element with kind=friend (name=operator==) 
I:/boost-sandbox/SOC/2007/visualization/boost/svg_plot/svg_style.hpp:305:
Cannot handle memberdef element with kind=friend (name=operator!=) 
I:/boost-sandbox/SOC/2007/visualization/boost/svg_plot/svg_style.hpp:653:
Cannot handle memberdef element with kind=friend (name=operator<<) 
I:/boost-sandbox/SOC/2007/visualization/boost/svg_plot/svg_style.hpp:1081:
Cannot handle memberdef element with kind=friend (name=svg_2d_plot) 
I:/boost-sandbox/SOC/2007/visualization/boost/svg_plot/uncertain.hpp:46:
Cannot handle memberdef element with kind=friend (name=operator<<) 
I:/boost-sandbox/SOC/2007/visualization/boost/svg_plot/uncertain.hpp:47:
Cannot handle memberdef element with kind=friend (name=operator<<)

Paul

> Just blundering around yours, John.
> 
> P.S.  Not at all keen on the internal data variables being declared
public.

Nor me - but I found making them private caused some grief, but haven't
figured out how to stop them showing in the index yet - and they are very
useful for reminding me what they were for the time being, memory being not
what it was ;-)