====== doxypy ======

===== About =====

doxypy is an input filter for [[http://doxygen.org|Doxygen]]. It reformats python
comments to conform to [[http://www.stack.nl/~dimitri/doxygen/docblocks.html#pythonblocks|doxygen 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 non-python documentation blocks or to document code redundantly.

Should you discover any bugs, please [[http://github.com/0xCAFEBABE/doxypy/issues|report them]].

doxypy's source can be found on [[http://github.com/0xCAFEBABE/doxypy|Github]]. It is licensed under the [[http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt|GPLv2]].
===== Authors =====

doxypy was written by 
  * [[http://foosel.net|Gina 'foosel' Häußge]] ([[gina@foosel.net]])
  * [[http://demod.org|Philippe 'demod' Neumann]] ([[doxypy@demod.org]])

===== Contributors =====

  * Mark Streatfield and Rob Pieké
  * Matthieu Walter
  * Anthony Foglia
  * Greg Smith


===== Usage =====

In order to make Doxygen preprocess files through doxypy simply install it by running

<code>
sudo python setup.py install
</code>

and then add the following lines to your ''Doxyfile''

<code>
FILTER_SOURCE_FILES = YES
INPUT_FILTER = "python /usr/local/bin/doxypy.py"
</code>

That's it. Doxygen will now preprocess every source file through doxypy and then process doxypy's output.

If you want to make Doxygen recognize your module docstrings, you have to add a ''namespace'' command to the docstring (see the [[http://www.stack.nl/~dimitri/doxygen/commands.html#cmdnamespace|Doxygen documentation]]).

Should you be unfamiliar with doxygen and using it to document python code you might want to take a look at [[http://notemagnet.blogspot.com/2009/10/using-doxypy-for-python-code.html|this tutorial]] by Greg Smith.

===== Download =====

  * [[http://code.foosel.org/files/doxypy-0.4.2.tar.gz|doxypy-0.4.2.tar.gz]] (2009-10-14)
    * Removed malfunctioning setup.py workaround
  * [[http://code.foosel.org/files/doxypy-0.4.1.tar.gz|doxypy-0.4.1.tar.gz]] (2008-12-05)
    * Fixed [[bug>34|FS#34]]
  * [[http://code.foosel.org/files/doxypy-0.4.tar.gz|doxypy-0.4.tar.gz]] (2008-11-13)
    * Fixed [[bug>33|FS#33]]
    * Switched to line-based input processing
    * Added ''%%--debug%%'' option for generating debug output on stderr
  * [[http://code.foosel.org/files/doxypy-0.3.tar.gz|doxypy-0.3.tar.gz]] (2008-06-12)
    * Added support for string prefixes for docstrings
  * [[http://code.foosel.org/files/doxypy-0.3rc2.tar.gz|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)

===== Development Resources =====

  * [[doxypy:fsm|State machine diagram of doxypy's internal FSM]]