[Doxygen-users] Null-op comments

[Stephen G. <ste...@el...>]

Is there a proper way to do the following with Doxygen?

Inside a header file I have a number of Doxygen comment blocks that
follow each other; for example, just above an enum appears:

/*-----------------------------------------*/
/*! \defgroup enum_entity Entities

  Blather to describe what an entity is
*/
/*-----------------------------------------*/
/*! \ingroup enum_entity

  Blah blah
*/
enum Entity
{
 // interesting stuff in here
};

where the lines of dashes in a comment are just there to break things up
and make it easier to spot where the break is between the (in reality,
pretty big) Doxygen comments.

Left as it appears above, when you look at Doxygen's page listing source
of this header, as the Dox-comments are not included in that page, there
are a load of mysterious separator lines in the listing, with nothing to
separate:

/*-----------------------------------------*/
/*-----------------------------------------*/
enum Entity

...etc

To tidy things up, I've just turned the separator lines into Doxygen
comments with the addition of a pling:

/*!-----------------------------------------*/

and both the original source and the Doxygen listing look lovely.

BUT I can't help thinking that Doxygen is doing _something_ with those
extra dox-comments and they'll re-appear somewhere unexpected, perhaps
not today, but soon...

Is there a proper, Doxygen-sanctioned way of adding these null-op,
'noise', comments and being sure that Doxygen will strip them from the
generated listing page but otherwise just ignore them?

TIA,
Stephen Goudge