Re: [Doxygen-users] comments in comments

[Dimitri v. H. <di...@st...>]

On Wed, Feb 27, 2002 at 11:21:35AM +0100, Volker Boerchers wrote:
> Hi,
> 
> beside documenting code we are using doxygen also for some specification
> documents (using \page). Until some weeks ago one could use /* */ -
> comments inside a \page for comments that were ignored by doxygen. This
> (undocumented!) feature is broken now. Instead such comments lead to
> parsing errors. It seems as if doxygen takes the closing '*/' as the end
> of the comment-block. A warning 'comment inside a comment' would be
> helpful. (Note that these pages are never compiled so no compiler will do
> this job.)

Comments inside comments only work inside @code ... @endcode and
@verbatim ... @endverbatim blocks.

> Looking for a replacement I figured out that XML-style comments work
> instead. Since I couldn't find this feature documented anywhere (I'ld
> expect it in the "HTML Commands" section), I'ld like to know if this
> feature is "officially" supported or not.

The use of <!-- ... --> as comments inside a comment block is officially
supported by doxygen. I'll put a note in the docs.

Regards,
  Dimitri