RE: [Doxygen-users] Comment Folding

[Glenn M. <gle...@vo...>]

Sorry to be chiming in late on this thread. I was on vacation.

As another person already pointed out, your comment above "void Bar();"
also needs to be a Doxygen formatted comment (e.g., "//! ...").

In addition, I would force it to be the brief description with:

//! @brief Establishes a connection to the properties database.
void Bar();

Do not have another brief description in the CPP file.

HTH,

Glenn Conrad Maxey
ma...@pr...
108 W. Byers Place #207=20
Denver, CO 80223 (USA)
(h) Tel. +1 303.282.4578
(w) Tel. +1 303.223.5164

[Home address and telephone may change soon. E-mail will remain valid.]

> -----Original Message-----
> From: Christian Ratliff [mailto:cra...@de...]
> Sent: Thursday, November 01, 2001 2:43 PM
> To: dox...@li...
> Subject: [Doxygen-users] Comment Folding
>=20
>=20
> doxygen-1.2.11.1
> Windows XP (release)
>=20
>   I noticed that doxygen does not appear to fold together the=20
> brief and
> detailed descriptions when producing the documentation. I=20
> segment my docs as
> follows:
>=20
> ---foo.h---
>=20
> class Foo
> {
> 	// Establishes a connection to the properties database.
> 	void Bar();
> }
> ---foo.h----
>=20
> --foo.cpp---
> /**
>  * More detailed information about this method without repeating the
>  * summary comment.
>  *
>  * @throws ...
>  *
>  * @author etc...
>  */
> Void Foo::Bar()
> {
> }
> --foo.cpp---
>=20
>   This allows people viewing the header to see the short=20
> description for the
> method, but reserves the large comment for the source file.=20
> It also prevents
> having duplicate copies of the same text. I had thought that=20
> these settings
> would fix it, but no luck:
>=20
> BRIEF_MEMBER_DESC      =3D YES
> REPEAT_BRIEF           =3D YES
> JAVADOC_AUTOBRIEF      =3D YES
>=20
>   Does anyone already fix this or some advice?
>=20
> Christian