[clang] 40c1476 - [clang-format][NFC] Improve documentation on ReflowComments
Björn Schäpers via cfe-commits
cfe-commits at lists.llvm.org
Tue Nov 15 22:02:40 PST 2022
Author: Björn Schäpers
Date: 2022-11-16T07:02:10+01:00
New Revision: 40c1476e3ae24766426802a61b15f374285c443b
URL: https://github.com/llvm/llvm-project/commit/40c1476e3ae24766426802a61b15f374285c443b
DIFF: https://github.com/llvm/llvm-project/commit/40c1476e3ae24766426802a61b15f374285c443b.diff
LOG: [clang-format][NFC] Improve documentation on ReflowComments
Fixes https://github.com/llvm/llvm-project/issues/58403
Differential Revision: https://reviews.llvm.org/D137865
Added:
Modified:
clang/docs/ClangFormatStyleOptions.rst
clang/include/clang/Format/Format.h
Removed:
################################################################################
diff --git a/clang/docs/ClangFormatStyleOptions.rst b/clang/docs/ClangFormatStyleOptions.rst
index a905117341776..4d4f08690ecbf 100644
--- a/clang/docs/ClangFormatStyleOptions.rst
+++ b/clang/docs/ClangFormatStyleOptions.rst
@@ -3795,7 +3795,9 @@ the configuration (without a prefix: ``Auto``).
**ReflowComments** (``Boolean``) :versionbadge:`clang-format 3.8`
- If ``true``, clang-format will attempt to re-flow comments.
+ If ``true``, clang-format will attempt to re-flow comments. That is it
+ will touch a comment and *reflow* long comments into new lines, trying to
+ obey the ``ColumnLimit``.
.. code-block:: c++
@@ -4610,9 +4612,11 @@ the configuration (without a prefix: ``Auto``).
/// - Foo /// - Foo
/// - Bar /// - Bar
+ This option has only effect if ``ReflowComments`` is set to ``true``.
+
Nested configuration flags:
- Control of spaces within a single line comment
+ Control of spaces within a single line comment.
* ``unsigned Minimum`` The minimum number of spaces at the start of the comment.
diff --git a/clang/include/clang/Format/Format.h b/clang/include/clang/Format/Format.h
index 276725406f295..ba56ef732dab0 100644
--- a/clang/include/clang/Format/Format.h
+++ b/clang/include/clang/Format/Format.h
@@ -3070,7 +3070,9 @@ struct FormatStyle {
ReferenceAlignmentStyle ReferenceAlignment;
// clang-format off
- /// If ``true``, clang-format will attempt to re-flow comments.
+ /// If ``true``, clang-format will attempt to re-flow comments. That is it
+ /// will touch a comment and *reflow* long comments into new lines, trying to
+ /// obey the ``ColumnLimit``.
/// \code
/// false:
/// // veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongComment with plenty of information
@@ -3821,7 +3823,7 @@ struct FormatStyle {
/// \version 3.7
bool SpacesInCStyleCastParentheses;
- /// Control of spaces within a single line comment
+ /// Control of spaces within a single line comment.
struct SpacesInLineComment {
/// The minimum number of spaces at the start of the comment.
unsigned Minimum;
@@ -3858,6 +3860,8 @@ struct FormatStyle {
/// /// - Foo /// - Foo
/// /// - Bar /// - Bar
/// \endcode
+ ///
+ /// This option has only effect if ``ReflowComments`` is set to ``true``.
/// \version 13
SpacesInLineComment SpacesInLineCommentPrefix;
More information about the cfe-commits
mailing list