Feneric / doxypypy

A more Pythonic version of doxypy, a Doxygen filter for Python.
GNU General Public License v2.0
149 stars 48 forks source link

doxypypy still relevant with Doxygen 1.9.* ? #88

Open buhtz opened 2 years ago

buhtz commented 2 years ago

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?

MuellerSeb commented 1 year ago

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 commented 7 months ago

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.