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

anonymous union member marked as 'not documented' (Origin: bugzilla #691071) #5013

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

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity normal in component general for ---
Reported in version 1.8.3.1 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2013-01-03 14:21:11 +0000, Matthias Kluwe wrote:

Example:

/// class
class Foo {
public:
private:
/// foo
union {
double d;
int i;
} u;
};

This generates the warning: Member u (variable) of class Foo is not documented.

IIRC, this did not happen in release 1.8.1.2.

On 2013-02-27 12:49:55 +0000, james.q.arnold@boeing.com wrote:

I do not see the warning message (probably different
configuration file settings). But I do see a variant
of the problem, where the documentation for Foo::u
does not appear in the HTML output. In the example
above, the "/// foo" comment should have generated
HTML output, but it silently disappears.

I have C code, not C++, but the issue is the same.
I am using 1.8.3.1.

On 2013-02-27 13:08:03 +0000, Matthias Kluwe wrote:

Probably configuration file settings matter. To produce the issue I've set JAVADOC_AUTOBRIEF and EXTRACT_PRIVATE.

On 2013-05-10 12:07:05 +0000, Matthias Kluwe wrote:

Created attachment 243767
doxyfile used

On 2013-11-15 13:44:55 +0000, Matthias Kluwe wrote:

(In reply to comment # 0)

Example:

/// class
class Foo {
public:
private:
/// foo
union {
double d;
int i;
} u;
};

This generates the warning: Member u (variable) of class Foo is not documented.

IIRC, this did not happen in release 1.8.1.2.

I found out that the member u can be documented by putting the doc comment in the "correct" line. This does what I want:

/// class
class Foo {
public:
private:
union {
double d;
int i;
/// foo
} u;
};

On 2013-12-24 12:05:40 +0000, Dimitri van Heesch wrote:

I just checked and since version 1.8.4 either place (before the union or before the variable name) produces the correct results, so this bug seems to be fixed.

Please reopen this bug report if you still see this issue with the latest version of doxygen. Add a self-contained example (source+config file in a zip or tar) if possible.

@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