X-Git-Url: http://nitlanguage.org diff --git a/contrib/neo_doxygen/README.md b/contrib/neo_doxygen/README.md index 67b0e52..c33e770 100644 --- a/contrib/neo_doxygen/README.md +++ b/contrib/neo_doxygen/README.md @@ -6,7 +6,7 @@ Neo4j that is readable by the `nx` tool. ## Installation -Ensure that you have a working version of `nitg` in `../../bin` then run `make` +Ensure that you have a working version of `nitc` in `../../bin` then run `make` in the present directory. The executable will be then generated at `bin/neo_doxygen`. @@ -69,3 +69,22 @@ 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. + + +## Brief descriptions + +To populate the first line of a description (used as brief description in +Nitdoc), `neo_doxygen` uses the brief description provided by Doxygen. So, you +may need to change settings like `JAVADOC_AUTOBRIEF`, `QT_AUTOBRIEF` and +`MULTILINE_CPP_IS_BRIEF` in Doxygen to make `neo_doxygen` properly split the +brief description from the detailed description. In absence of brief +description, `neo_doxygen` will use the first block (usually, the first +paragraph) of the detailed as brief description. + + +## 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.