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

• Gina 'foosel' Häußge (gina@foosel.net)
• Philippe 'demod' Neumann (doxypy@demod.org)

• Mark Streatfield and Rob Pieké
• Matthieu Walter
• Anthony Foglia

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).

• doxypy-0.4.tar.gz (2008-11-13)
  • Fixed FS#33
  • Switched to line-based input processing
  • Added --debug option for generating debug output on stderr
• doxypy-0.3.tar.gz (2008-06-12)
  • Added support for string prefixes for docstrings
• doxypy-0.3rc2.tar.gz (2007-12-18)
  • Multiline function and class definitions will now be handled correctly
  • Added the --autobrief option
• doxypy-0.3rc1.tar.gz (2007-12-02)
  • Complete rewrite as a Finite State Machine
• doxypy-0.2.2.py (2007-07-27)
  • Added support for single quote comment delimiters
  • Minor cleanups
• doxypy-0.2.1.py (2006-10-21)
  • Minor bugfixes
  • Trimming of codeblocks is now disabled by default
• doxypy-0.2.py (2006-10-15)

• State machine diagram of doxypy's internal FSM