**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++
/// - 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.
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
/// \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;
/// /// - Foo /// - Foo
/// /// - Bar /// - Bar
/// \endcode
+ ///
+ /// This option has only effect if ``ReflowComments`` is set to ``true``.
/// \version 13
SpacesInLineComment SpacesInLineCommentPrefix;