doxypy is an input filter for Doxygen. It preprocesses python files so that docstrings of classes and functions are reformatted into Doxygen conform documentation blocks. This makes it possible to use the Doxygen/Javadoc syntax inside of docstrings when writing code documentation and automatically generate API documentation out of it, instead of being forced to use the non-native documentation blocks over the standard docstrings or to document everything twice.
doxypy is licensed under the GPLv2.
Should you discover any bugs, please report them.
doxypy was written by
In order to make Doxygen preprocess files through doxypy, simply
add the following lines to your Doxyfile
FILTER_SOURCE_FILES = YES INPUT_FILTER = "python /path/to/doxypy.py"
That's it. Doxygen will now run every source file through doxypy and then process doxypys output.
If you want to make Doxygen recognize your module docstrings, you have to add a namespace command to the docstring (see the Doxygen documentation).
--debug option for generating debug output on stderr--autobrief option