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

Support ##< for documenting members and variables #9911

Closed
marknelsonengineer opened this issue Mar 14, 2023 · 4 comments
Closed

Support ##< for documenting members and variables #9911

marknelsonengineer opened this issue Mar 14, 2023 · 4 comments
Labels
enhancement a request to enhance doxygen, not a bug Python

Comments

@marknelsonengineer
Copy link

Putting documentation after members is very helpful. The feature is documented here: https://www.doxygen.nl/manual/docblocks.html#memberdoc

I'd like to extend this support to Python code. Specifically, I'd like the following code to work:

OUTPUT_FILE = "STATISTICS.md"    ##< All output is redirected to this file
@albert-github albert-github added enhancement a request to enhance doxygen, not a bug Python labels Mar 14, 2023
albert-github added a commit to albert-github/doxygen that referenced this issue Mar 19, 2023
Implement the possibility of comments after a definition in Python.
@albert-github
Copy link
Collaborator

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

Example: example.tar.gz

doxygen added a commit that referenced this issue Mar 25, 2023
issue #9911 Support ##< for documenting members and variables
@albert-github albert-github added the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Mar 25, 2023
@albert-github
Copy link
Collaborator

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

sven2000-miun pushed a commit to sven2000-miun/doxygen that referenced this issue Apr 9, 2023
Implement the possibility of comments after a definition in Python.
sven2000-miun pushed a commit to sven2000-miun/doxygen that referenced this issue Apr 9, 2023
Implement the possibility of comments after a definition in Python.
sven2000-miun pushed a commit to sven2000-miun/doxygen that referenced this issue Apr 9, 2023
Implement the possibility of comments after a definition in Python.
sven2000-miun pushed a commit to sven2000-miun/doxygen that referenced this issue Apr 9, 2023
Implement the possibility of comments after a definition in Python.
@doxygen
Copy link
Owner

doxygen commented May 18, 2023

This issue was previously marked 'fixed but not released',
which means it should be fixed in doxygen version 1.9.7.
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).

@doxygen doxygen removed the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label May 18, 2023
@doxygen doxygen closed this as completed May 18, 2023
@marknelsonengineer
Copy link
Author

@albert-github and @doxygen. I wanted to say thank you both for this fix. I have verified that it works on my code base.

Overall, the update looks good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement a request to enhance doxygen, not a bug Python
Projects
None yet
Development

No branches or pull requests

3 participants