Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cannot externally document C++11 enumeration values. (Origin: bugzilla #691073) #5014

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Copy link
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity major in component general for ---
Reported in version 1.8.3-SVN on platform Other
Assigned to: Dimitri van Heesch

On 2013-01-03 15:22:32 +0000, Reece H. Dunn wrote:

Specifying the documentation at the place where the enumeration values are defined works:

/** @brief A foo enumeration. */
enum class Foo
{
    A, /**< @brief The first value. */
    B, /**< @brief The second value. */
};

Documenting the enumeration type outside the definition works:

/** @enum Foo
  * @brief A foo enumeration.
  */

However, documenting the values outside the definition does not:

/** @var Foo A
  * @brief The first value.
  */

/** @var Foo B
  * @brief The second value.
  */

Nor does qualifying the values:

/** @var Foo Foo::A
  * @brief The first value.
  */

/** @var Foo Foo::B
  * @brief The second value.
  */

These all work for C++98/03 enumeration values.

On 2013-01-19 16:30:10 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next subversion update.

On 2013-01-20 13:34:56 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.3.1. Please verify if this is indeed the case. Reopen the
bug if you think it is not fixed and please include any additional information
that you think can be relevant.

On 2013-01-20 14:42:08 +0000, Reece H. Dunn wrote:

This now works in 1.8.3.1. Thank you for fixing this issue.

@doxygen doxygen closed this Jul 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.