Doxygen: \class after \brief doesn't count as a new line - resulting docs show merged descriptions

Created on 25 Apr 2019  路  6Comments  路  Source: doxygen/doxygen

See this post on SO.

Consider the following:

/*! \brief Spawns two mettaurs on the field
 *  \class TwoMettaurMob
 * 
 * May optionally spawn an empty tile for challenge
 */

The output description will be

Spawns two mettaurs on the fieldMay optionally spawn an empty tile for challenge

The solution is to add space between the \brief and \class command

enhancement

Most helpful comment

Besides the \class command, I think, also the following commands could be set to terminate a brief description:

  • \fn
  • \var
  • \typedef
  • \property
  • \protocol
  • \enum
  • \category
  • \union
  • \struct
  • \namespace
  • \package
  • \dir
  • \def
  • \defgroup
  • \ingroup
  • \weakgroup
  • \idlexcepte
  • \interface

and to be consistent with the \section command:

  • \page
  • \mainpage
  • \file

List is based on this issue and friend command as well as on the descriptions starting with: "Indicates that a comment block contains documentation..."

@doxygen your opinion ?

All 6 comments

Besides the \class command, I think, also the following commands could be set to terminate a brief description:

  • \fn
  • \var
  • \typedef
  • \property
  • \protocol
  • \enum
  • \category
  • \union
  • \struct
  • \namespace
  • \package
  • \dir
  • \def
  • \defgroup
  • \ingroup
  • \weakgroup
  • \idlexcepte
  • \interface

and to be consistent with the \section command:

  • \page
  • \mainpage
  • \file

List is based on this issue and friend command as well as on the descriptions starting with: "Indicates that a comment block contains documentation..."

@doxygen your opinion ?

The "enhancement" label suggests there's no bug, but I think the missing whitespace between the brief description and the rest of the text is a real bug:

Spawns two mettaurs on the fieldMay optionally spawn an empty tile for challenge

There should _at least_ be a space between "field" and "May".

Besides the \class command, I think, also the following commands could be set to terminate a brief description:

* `\fn`

* `\var`

* `\typedef`

* `\property`

* `\protocol`

* `\enum`

* `\category`

* `\union`

* `\struct`

* `\namespace`

* `\package`

* `\dir`

* `\def`

* `\defgroup`

* `\ingroup`

* `\weakgroup`

* `\idlexcepte`

* `\interface`

and to be consistent with the \section command:

* `\page`

* `\mainpage`

* `\file`

List is based on this issue and friend command as well as on the descriptions starting with: "Indicates that a comment block contains documentation..."

@doxygen your opinion ?

I agree with this.

I've just pushed a proposed patch, pull request #6971

Code has been integrated in master on github (please don't close the issue as this will be done at the moment of a release).

This issue was previously marked 'fixed but not released',
which means it should be fixed in doxygen version 1.8.16.
Please verify if this is indeed the case. Reopen the
issue if you think it is not fixed and please include any additional information
that you think can be relevant (preferably in the form of a self-contained example).

Was this page helpful?
0 / 5 - 0 ratings