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

@protected and @private will be ignored #21

Open
raabf opened this issue May 1, 2015 · 1 comment
Open

@protected and @private will be ignored #21

raabf opened this issue May 1, 2015 · 1 comment

Comments

@raabf
Copy link

raabf commented May 1, 2015

Actually you add the @protected and @private commands if the function has an single underscore _ respectively double underscore __.
The interpretation of the underscores is correct but doxygen will ignore them if the language is object-oriented:

\protected
Indicates that the member documented by the comment block is protected, i.e., should only be accessed by other members in the same or derived classes.

Note that Doxygen automatically detects the protection level of members in object-oriented languages. This command is intended for use only when the language does not support the concept of protection level natively (e.g. C, PHP 4).

(same for private)

doxygen actually mark everything as private which begins with one or more underscore.
Of course you can nothing do to change that, I want to only leave this information here for users which are confused (and that you do not have to add the @protected and @private commands).
I opened an issue so that it will be corrected.

@Feneric
Copy link
Owner

Feneric commented Jul 7, 2016

Yeah, over the years a few other similar issues have been raised but there's not too much we can do about them. Our policy has been to make doxypypy send the best data that it can even knowing it may be ignored by the current version of Doxygen. If at some point that data gets considered we'll be ready.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants