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-10 09:58:19

> -----Original Message-----
> From: boost-docs-bounces_at_[hidden] [mailto:boost-docs-
> bounces_at_[hidden]] On Behalf Of Daniel James
> Sent: 10 March 2009 08:09
> To: Discussion of Boost Documentation
> Subject: Re: [Boost-docs] Quickbook with Doxygen autodoc - How to getthe
function
> (and enum) descriptions?
> 
> 2009/3/9 Paul A. Bristow <pbristow_at_[hidden]>:
> >
> > The class unc is OK, but svg is not showing the comments for the
functions.
> >
> > The <purpose> does not seems to be present in autodocs.xml.
> 
> Right, doxygen puts comments in method bodies into an XML element
> called '<inbodydescription>' which doxygen2boostbook.xml wasn't
> dealing with. I've just tried to fix this in trunk, but I'm not sure
> about what I'm doing here so I might have it revert it if it messes
> something up.

Looking good so far :-))

I've now got the comments coming through in svg_style and I'm just checking
more - none found missing yet :-))

I note that neither definitions nor comments are showing for 

  std::ostream& operator<< (std::ostream& os, svg_style& s)
  {  /*! Output a string description of a svg_style.
         Usage: svg_style my_svg_style; cout << my_svg_style << endl;
         Outputs:  svg_style(RGB(0,0,0), RGB(0,0,0), 0, no fill, no stroke,
no width)
     */
...
}

Which is declared as

  friend std::ostream& operator<< (std::ostream&, svg_style&);

I presume this is linked with the messages below.

It would be jolly nice if they worked too :-))

But many thanks for making a big step forward - though it reveals much
inconsistency in the format of my comments :-( 

And problems with duplicates. Since the declarations and definitions, it is
nice to place the comment in both places.  I think I remember a switch to
prevent this?

And the function index isn't quite what I expected. I had expected a list of
just functions but there seem to be lots more (indirect?) entries which make
it less useful. I'd better RTFM more carefully.

Paul

---
Paul A. Bristow
Prizet Farmhouse
Kendal, UK   LA8 8AB
[phone], mobile [phone]
pbristow_at_[hidden]
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:648:
Cannot handle memberdef element with kind=friend (name=operator<<) 
I:/boost-sandbox/SOC/2007/visualization/boost/svg_plot/svg_style.hpp:1076:
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<<)