This is an archive of the discontinued LLVM Phabricator instance.

Differential D11281

Doxygen: Enable autobrief feature, matching llvm config/coding standards.
ClosedPublic

Authored by jdennett on Jul 16 2015, 3:09 PM.

Details

Reviewers
eliben
Commits
rGd8b775a16609: Doxygen: Enable autobrief feature, matching llvm config/coding standards.
rC242485: Doxygen: Enable autobrief feature, matching llvm config/coding standards.
rL242485: Doxygen: Enable autobrief feature, matching llvm config/coding standards.
Summary

This corresponds to the change made in r237417 - "Doxygen: Enable autobrief feature and update coding standards."

Diff Detail

Event Timeline

jdennett updated this revision to Diff 29952.Jul 16 2015, 3:09 PM
jdennett retitled this revision from to Doxygen: Enable autobrief feature, matching llvm config/coding standards..
jdennett updated this object.
jdennett set the repository for this revision to rL LLVM.
jdennett added a subscriber: cfe-commits.
eliben accepted this revision.Jul 16 2015, 4:03 PM
eliben added a reviewer: eliben.
eliben added a subscriber: eliben.

lgtm

This revision is now accepted and ready to land.Jul 16 2015, 4:03 PM
jdennett closed this revision.Jul 16 2015, 4:17 PM

Revision Contents

PathSize
docs/
4 lines

Diff 29952

docs/doxygen.cfg.in

Show First 20 Lines • Show All 163 Lines • ▼ Show 20 Lines
# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
# first line (until the first dot) of a Javadoc-style comment as the brief # first line (until the first dot) of a Javadoc-style comment as the brief
# description. If set to NO, the Javadoc-style will behave just like regular Qt- # description. If set to NO, the Javadoc-style will behave just like regular Qt-
# style comments (thus requiring an explicit @brief command for a brief # style comments (thus requiring an explicit @brief command for a brief
# 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
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
# 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
# a brief description. This used to be the default behavior. The new default is # a brief description. This used to be the default behavior. The new default is
# to treat a multi-line C++ comment block as a detailed description. Set this # to treat a multi-line C++ comment block as a detailed description. Set this
# tag to YES if you prefer the old behavior instead. # tag to YES if you prefer the old behavior instead.
# #
# Note that setting this tag to YES also means that rational rose comments are # Note that setting this tag to YES also means that rational rose comments are
▲ Show 20 Lines • Show All 2,117 Lines • Show Last 20 Lines