[Boost-docs] Why do the Doxygen member functions comments not appear in the ?

Subject: [Boost-docs] Why do the Doxygen member functions comments not appear in the ?
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2009-03-12 09:45:03


Do any Doxygen Doctors know why/how to get the \brief member function info
to appear on the Functions lists.

Especially when it comes through using autodoc into Quickbook, Docbook...
but it's a Doxygen issue, not any post processing.

You will see below in the synopsis that the member variables at the bottom
have their comments appended,
But the functions do not (although the line at the bottom from the fully
members list shows that there is a comment).

IMO It would be neater for the

// In header: <boost/svg_plot/svg.hpp>

class svg {
public:
  // construct/copy/destruct
  svg();
  svg(const svg &);
  // private member functions
  void write_header(std::ostream &) ;
...
  // public member functions
void x_size(unsigned int) ;
void y_size(unsigned int) ;
unsigned int x_size() ;
unsigned int y_size() ;
...
g_element & g(int) ;

// member variables
unsigned int x_size_; // SVG image X-axis size (in SVG units (default
pixels).
unsigned int y_size_; // SVG image Y-axis size (in SVG units (default
pixels).
...

In the section below

svg private member functions
1.
void write_header(std::ostream & s_out) ;
Output the DTD SVG 1.1 header into the svg g_element document.

IMO It would be neater for the synopsis to be like this
...
// private member functions
void write_header(std::ostream &) ; // Output the DTD SVG 1.1 header into
the svg g_element document.
...
// member variables
unsigned int x_size_; // SVG image X-axis size (in SVG units (default
pixels).
...
Suggestions/views? Is there something (else) I've missed in RTFM?

Paul

---
Paul A. Bristow
Prizet Farmhouse
Kendal, UK   LA8 8AB
+44 1539 561830, mobile +44 7714330204
pbristow_at_[hidden]

This archive was generated by hypermail 2.1.7 : 2017-11-11 08:50:41 UTC