diff --git a/clang/docs/ClangFormatStyleOptions.rst b/clang/docs/ClangFormatStyleOptions.rst index a905117341776a..4d4f08690ecbf7 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 276725406f295e..ba56ef732dab0d 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;