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

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


I can fully understand your reluctance to fiddle further - it's clearly
complicated.

But it was Doxygen itself that I was asking about first - not the downstream
issues.

If I compare the Doxygen display (not anything from Quickbook or Docbook),

I see NO comments (\brief nor \details) after the functions C++ description

Public Member Functions
align_style alignment ()
text_element & alignment (align_style a)

but I DO see them after the variables (attributes)

Private Attributes
align_style align_
         left_align, right_align, center_align

where this ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ is the C++ comment for variable
align_

The function descriptions do exist - but you have click on them to get to
them. It would suit me (and I am sure users) better to see a brief
description on the line for each function - then you get an overview
(especially useful if there are lots of them ;-)

I can't see why I can't have both - but can't see a Doxygen switch that
would do this. I thought I might have missed it.

Perhaps I should ask on the Doxygen site?

Thanks

Paul

---
Paul A. Bristow
Prizet Farmhouse
Kendal, UK   LA8 8AB
+44 1539 561830, mobile +44 7714330204
pbristow_at_[hidden]
> -----Original Message-----
> From: boost-docs-bounces_at_[hidden] [mailto:boost-docs-
> bounces_at_[hidden]] On Behalf Of Daniel James
> Sent: 12 March 2009 13:00
> To: Discussion of Boost Documentation
> Subject: Re: [Boost-docs] Why do the Doxygen member functions comments not
> appear in the ?

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