Enable AUTOBRIEF for doxygen
Summary: Enabling this option will treat first sentence of a documentation comment as a 'brief' description. This removes the need for explicitly typing `@brief` for a *single* sentence. In case of a larger brief paragraph, `@brief` is still required. Reviewers: florijan, mislav.bradac, buda, dgleich, mferencevic Reviewed By: buda Subscribers: pullbot Differential Revision: https://phabricator.memgraph.io/D418
This commit is contained in:
parent
f0422c0e11
commit
4d63f8b44e
4
Doxyfile
4
Doxyfile
@ -177,7 +177,7 @@ SHORT_NAMES = NO
|
|||||||
# description.)
|
# description.)
|
||||||
# The default value is: NO.
|
# The default value is: NO.
|
||||||
|
|
||||||
JAVADOC_AUTOBRIEF = NO
|
JAVADOC_AUTOBRIEF = YES
|
||||||
|
|
||||||
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
|
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
|
||||||
# line (until the first dot) of a Qt-style comment as the brief description. If
|
# line (until the first dot) of a Qt-style comment as the brief description. If
|
||||||
@ -185,7 +185,7 @@ JAVADOC_AUTOBRIEF = NO
|
|||||||
# requiring an explicit \brief command for a brief description.)
|
# requiring an explicit \brief command for a brief description.)
|
||||||
# The default value is: NO.
|
# 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
|
# 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
|
# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
|
||||||
|
Loading…
Reference in New Issue
Block a user