[clang-format] Make sure rst documentation matches comments

clang/docs/tools/dump_format_style.py is used to read the comments
from clang/include/clang/Format/Format.h and update the contents of
clang/docs/ClangFormatStyleOptions.rst

Recent changes made these out of date. This commit syncs them by
folding the improved wording back to the comments and then
regenerating the rst file.

Differential Revision: https://reviews.llvm.org/D84103
This commit is contained in:
Anders Waldenborg 2020-07-18 17:26:06 +02:00
parent 3ab0f53ef3
commit 6d7ec54170
2 changed files with 13 additions and 7 deletions

View File

@ -2694,8 +2694,11 @@ the configuration (without a prefix: ``Auto``).
Use tabs whenever we need to fill whitespace that spans at least from
one tab stop to the next one.
**WhitespaceSensitiveMacros** (``std::vector<std::string>``)
A vector of macros which are whitespace-sensitive and should not be touched.
A vector of macros which are whitespace-sensitive and should not
be touched.
These are expected to be macros of the form:
@ -2709,9 +2712,7 @@ the configuration (without a prefix: ``Auto``).
WhitespaceSensitiveMacros: ['STRINGIZE', 'PP_STRINGIZE']
For example: BOOST_PP_STRINGIZE.
For example: BOOST_PP_STRINGIZE
.. END_FORMAT_STYLE_OPTIONS

View File

@ -1425,15 +1425,20 @@ struct FormatStyle {
/// For example: TESTSUITE
std::vector<std::string> NamespaceMacros;
/// A vector of macros which are whitespace-sensitive and shouldn't be
/// touched.
/// A vector of macros which are whitespace-sensitive and should not
/// be touched.
///
/// These are expected to be macros of the form:
/// \code
/// STRINGIZE(...)
/// \endcode
///
/// For example: STRINGIZE
/// In the .clang-format configuration file, this can be configured like:
/// \code{.yaml}
/// WhitespaceSensitiveMacros: ['STRINGIZE', 'PP_STRINGIZE']
/// \endcode
///
/// For example: BOOST_PP_STRINGIZE
std::vector<std::string> WhitespaceSensitiveMacros;
tooling::IncludeStyle IncludeStyle;