patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity

doc: doxygen: Enable Doxygen autobrief

Browse source 
Enable Doxygen AUTOBRIEF feature for both Javadoc and Qt style
documentation blocks. This treats the first sentence of a documentation
block as a brief description even when no @brief tag is present. This makes
the overview sections of the generated documentation much more useful.

See https://www.doxygen.nl/manual/config.html#cfg_javadoc_autobrief and
https://www.doxygen.nl/manual/config.html#cfg_qt_autobrief

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2023-07-12 17:51:08 +02:00 committed by Carles Cufí
parent 7c418a065c
commit 986d0c9e89
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/zephyr.doxyfile.in
View file

@ -199,7 +199,7 @@ SHORT_NAMES = NO
# description.)
# The default value is: NO.
JAVADOC_AUTOBRIEF = NO
JAVADOC_AUTOBRIEF = YES
# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
# such as
@ -217,7 +217,7 @@ JAVADOC_BANNER = NO
# requiring an explicit \brief command for a brief description.)
# The default value is: NO.
QT_AUTOBRIEF = NO
QT_AUTOBRIEF = YES
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
# multi-line C++ special comment block (i.e. a block of //! or /// comments) as