From 35de495a9133b7da5a53db95109c2b3e706c1087 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Jean-Christophe=20Beaupr=C3=A9?= Date: Wed, 17 Dec 2014 15:24:16 -0500 Subject: [PATCH] neo_doxygen: Include a tip for Python in the `README`. MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jean-Christophe Beaupré --- contrib/neo_doxygen/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) 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. -- 1.7.9.5