From: Jean-Christophe Beaupré Date: Wed, 17 Dec 2014 20:24:16 +0000 (-0500) Subject: neo_doxygen: Include a tip for Python in the `README`. X-Git-Tag: v0.7~14^2 X-Git-Url: http://nitlanguage.org neo_doxygen: Include a tip for Python in the `README`. Signed-off-by: Jean-Christophe Beaupré --- diff --git a/contrib/neo_doxygen/README.md b/contrib/neo_doxygen/README.md index 9da5b92..454cd86 100644 --- a/contrib/neo_doxygen/README.md +++ b/contrib/neo_doxygen/README.md @@ -69,3 +69,11 @@ Also, they **must** be run with the current working directory set to the present directory. `gen-one.sh` handle only one project at a time while `gen-all.sh` works on a collection of projects grouped in a directory. For detail about how to invoke each script, see the comments in these scripts. + + +## Python + +The built-in filter of Doxygen for Python is very basic. For example, it +recognizes anything in the “docstrings” as verbatim detailed description. In +order to enhance the processing of the Python scripts, the +[doxypypy](https://github.com/Feneric/doxypypy) filter may be used.