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

doxypypy still relevant with Doxygen 1.9.* ? #88

Open
buhtz opened this issue Mar 7, 2022 · 2 comments
Open

doxypypy still relevant with Doxygen 1.9.* ? #88

buhtz opened this issue Mar 7, 2022 · 2 comments

Comments

@buhtz
Copy link

buhtz commented Mar 7, 2022

I was migrating my Doxygen 1.8 to Doxygen 1.9.1 (Debian stable). Upstream is at 1.9.4 by the way.

I found that there is a "new" option in the generated Doxyfile.

# By default Python docstrings are displayed as preformatted text and doxygen's
# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
# doxygen's special commands can be used and the contents of the docstring
# documentation blocks is shown as doxygen documentation.
# The default value is: YES.

PYTHON_DOCSTRING       = YES

I do not understand the details and internals of how Doxygen and doxypypy interact with each other. But does this option indicates that the need to use doxypypy is gone because Doxygen now handels Python code by itself the proper way?

@buhtz buhtz changed the title doxypypy still relevant with Doxygen 1.9.* doxypypy still relevant with Doxygen 1.9.* ? Mar 7, 2022
@MuellerSeb
Copy link

It is relevant if you still want to have google docstring style in your python module. Otherwise you need to use the doxygen commands to indicate parameters etc.

@sebsken
Copy link

sebsken commented Jan 22, 2024

Actually, you need a particular kind of google docstring: the variable type must be after the colon and the return variables must have a name. You can easily customize the google template for that.

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

3 participants