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

Consider adding doxygen for python #637

Closed
1 of 5 tasks
PlasmaHH opened this issue Oct 18, 2023 · 2 comments · Fixed by #640
Closed
1 of 5 tasks

Consider adding doxygen for python #637

PlasmaHH opened this issue Oct 18, 2023 · 2 comments · Fixed by #640

Comments

@PlasmaHH
Copy link

Documentation standard
According to e.g. https://www.woolseyworkshop.com/2020/06/25/documenting-python-programs-with-doxygen/ doxygen supports its syntax in python docstrings ( where applicable ).

It's not the most popular style, but in cases where you have multiple languages, something like doxygen that supports all of them might be useful ( we started using python in such an environment and currently experimenting with doxygen support, so I can't give much examples of how it would look like )

Maybe every supported language should have a doxygen compatible documentation standard available?

How popular is the doc standard?

  • Not popular at all
  • Some people use it
  • Quite a lot of people use it
  • It's not the most popular one, but a good alternative
  • Everyone is using it
@kkoomen
Copy link
Owner

kkoomen commented Oct 27, 2023

Hi,

Doxygen is mentioned indeed online by a small subset of people who work together with some C/C++ projects, so I approve this request. I've already implemented it in #640 and will release it in the next version, which I'll do today.

@kkoomen
Copy link
Owner

kkoomen commented Oct 27, 2023

This feature has been merged and released in v4.6.0.

Feel free to submit any new issues if you experience any unwanted behavior in the future. Thanks for your contribution.

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

Successfully merging a pull request may close this issue.

2 participants