[Doxygen] Enable autobrief, as claimed by the manual.

Clarify manual to state that first *sentence* will be used as the
brief documentation.

Thanks to Budiarto Herman <budiarto.herman@magister.fi> for pointing
out the required configuration.
This commit is contained in:
Peter D. Barnes, Jr.
2013-12-18 11:24:36 -08:00
parent 762131e218
commit 1558d08adf
2 changed files with 6 additions and 6 deletions

View File

@@ -151,7 +151,7 @@ SHORT_NAMES = NO
# comments will behave just like regular Qt-style comments
# (thus requiring an explicit @brief command for a brief description.)
JAVADOC_AUTOBRIEF = NO
JAVADOC_AUTOBRIEF = YES
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
# interpret the first line (until the first dot) of a Qt-style
@@ -159,7 +159,7 @@ JAVADOC_AUTOBRIEF = NO
# will behave just like regular Qt-style comments (thus requiring
# an explicit \brief command for a brief description.)
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 ///

View File

@@ -23,7 +23,7 @@ To build all the standard documentation:
.. sourcecode:: bash
$ waf docs
$ ./waf docs
For more specialized options, read on.
@@ -131,7 +131,7 @@ To build all the Sphinx documentation:
.. sourcecode:: bash
$ waf sphinx
$ ./waf sphinx
To build just the Models documentation:
@@ -330,7 +330,7 @@ Some items to note:
* Use sentence case, including the initial capital.
* Use punctuation, especially \`.'s at the end of sentences or phrases.
* The ``\brief`` tag is not needed; the first paragraph will be
* The ``\brief`` tag is not needed; the first sentence will be
used as the brief description.
Every class, method, typedef, member variable, function argument
@@ -366,7 +366,7 @@ Building the Doxygen documentation is pretty simple:
.. sourcecode:: bash
$ waf doxygen
$ ./waf doxygen
This builds using the default configuration, which generates documentation
sections for *all* items, even if they do not have explicit comment