From 62daeb6e40df4e09df5171083c43804fb0a662ee Mon Sep 17 00:00:00 2001 From: =?utf8?q?Jean-Christophe=20Beaupr=C3=A9?= Date: Thu, 18 Dec 2014 10:51:37 -0500 Subject: [PATCH] neo_doxygen: Add a section about brief descriptions 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 | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/contrib/neo_doxygen/README.md b/contrib/neo_doxygen/README.md index 454cd86..c33e770 100644 --- a/contrib/neo_doxygen/README.md +++ b/contrib/neo_doxygen/README.md @@ -71,6 +71,17 @@ 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 -- 1.7.9.5