neo_doxygen: Include a tip for Python in the `README`.
authorJean-Christophe Beaupré <jcbrinfo@users.noreply.github.com>
Wed, 17 Dec 2014 20:24:16 +0000 (15:24 -0500)
committerJean-Christophe Beaupré <jcbrinfo@users.noreply.github.com>
Fri, 19 Dec 2014 16:32:49 +0000 (11:32 -0500)
Signed-off-by: Jean-Christophe Beaupré <jcbrinfo@users.noreply.github.com>

contrib/neo_doxygen/README.md

index 9da5b92..454cd86 100644 (file)
@@ -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.