Addressing @owenca's feedback.

Author: ichaer

clang/include/clang/Format/Format.h

@@ -3814,7 +3814,7 @@ struct FormatStyle {
   ReferenceAlignmentStyle ReferenceAlignment;
 
   // clang-format off
-  /// \brief Types of comment re-flow style.
+  /// \brief Types of comment reflow style.
   enum ReflowCommentsStyle : int8_t {
     /// Leave comments untouched.
     /// \code
@@ -3833,7 +3833,7 @@ struct FormatStyle {
     ///     * and a misaligned second line */
     /// \endcode
     RCS_IndentOnly,
-    /// Apply indentation rules and re-flow long comments into new lines, trying
+    /// Apply indentation rules and reflow long comments into new lines, trying
     /// to obey the ``ColumnLimit``.
     /// \code
     ///    // veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongComment with plenty of

clang/lib/Format/BreakableToken.cpp

@@ -420,10 +420,8 @@ BreakableComment::getSplit(unsigned LineIndex, unsigned TailOffset,
                            unsigned ColumnLimit, unsigned ContentStartColumn,
                            const llvm::Regex &CommentPragmasRegex) const {
   // Don't break lines matching the comment pragmas regex.
-  if (Style.ReflowComments != FormatStyle::RCS_Always ||
-      CommentPragmasRegex.match(Content[LineIndex])) {
+  if (!AlwaysReflow || CommentPragmasRegex.match(Content[LineIndex]))
     return Split(StringRef::npos, 0);
-  }
   return getCommentSplit(Content[LineIndex].substr(TailOffset),
                          ContentStartColumn, ColumnLimit, Style.TabWidth,
                          Encoding, Style);
@@ -610,10 +608,8 @@ BreakableToken::Split BreakableBlockComment::getSplit(
     unsigned LineIndex, unsigned TailOffset, unsigned ColumnLimit,
     unsigned ContentStartColumn, const llvm::Regex &CommentPragmasRegex) const {
   // Don't break lines matching the comment pragmas regex.
-  if (Style.ReflowComments != FormatStyle::RCS_Always ||
-      CommentPragmasRegex.match(Content[LineIndex])) {
+  if (!AlwaysReflow || CommentPragmasRegex.match(Content[LineIndex]))
     return Split(StringRef::npos, 0);
-  }
   return getCommentSplit(Content[LineIndex].substr(TailOffset),
                          ContentStartColumn, ColumnLimit, Style.TabWidth,
                          Encoding, Style, Decoration.ends_with("*"));
@@ -859,7 +855,7 @@ bool BreakableBlockComment::mayReflow(
   StringRef IndentContent = Content[LineIndex];
   if (Lines[LineIndex].ltrim(Blanks).starts_with("*"))
     IndentContent = Lines[LineIndex].ltrim(Blanks).substr(1);
-  return LineIndex > 0 && Style.ReflowComments == FormatStyle::RCS_Always &&
+  return LineIndex > 0 && AlwaysReflow &&
          !CommentPragmasRegex.match(IndentContent) &&
          mayReflowContent(Content[LineIndex]) && !Tok.Finalized &&
          !switchesFormatting(tokenAt(LineIndex));
@@ -1165,7 +1161,7 @@ bool BreakableLineCommentSection::mayReflow(
   // // text that protrudes
   // //    into text with different indent
   // We do reflow in that case in block comments.
-  return LineIndex > 0 && Style.ReflowComments == FormatStyle::RCS_Always &&
+  return LineIndex > 0 && AlwaysReflow &&
          !CommentPragmasRegex.match(IndentContent) &&
          mayReflowContent(Content[LineIndex]) && !Tok.Finalized &&
          !switchesFormatting(tokenAt(LineIndex)) &&

clang/lib/Format/BreakableToken.h

@@ -384,6 +384,8 @@ class BreakableComment : public BreakableToken {
   // The intended start column of the first line of text from this section.
   unsigned StartColumn;
 
+  const bool AlwaysReflow = Style.ReflowComments == FormatStyle::RCS_Always;
+
   // The prefix to use in front a line that has been reflown up.
   // For example, when reflowing the second line after the first here:
   // // comment 1

clang/lib/Format/Format.cpp

@@ -520,6 +520,7 @@ template <> struct ScalarEnumerationTraits<FormatStyle::ReflowCommentsStyle> {
     IO.enumCase(Value, "Never", FormatStyle::RCS_Never);
     IO.enumCase(Value, "IndentOnly", FormatStyle::RCS_IndentOnly);
     IO.enumCase(Value, "Always", FormatStyle::RCS_Always);
+    // For backward compatibility:
     IO.enumCase(Value, "false", FormatStyle::RCS_Never);
     IO.enumCase(Value, "true", FormatStyle::RCS_Always);
   }

clang/lib/Format/UnwrappedLineParser.cpp

@@ -4605,11 +4605,11 @@ bool UnwrappedLineParser::isOnNewLine(const FormatToken &FormatTok) {
 
 // Checks if \p FormatTok is a line comment that continues the line comment
 // section on \p Line.
-static bool continuesLineCommentSection(
-    const FormatToken &FormatTok, const UnwrappedLine &Line,
-    const FormatStyle::ReflowCommentsStyle ReflowCommentsStyle,
-    const llvm::Regex &CommentPragmasRegex) {
-  if (Line.Tokens.empty() || ReflowCommentsStyle != FormatStyle::RCS_Always)
+static bool
+continuesLineCommentSection(const FormatToken &FormatTok,
+                            const UnwrappedLine &Line, const FormatStyle &Style,
+                            const llvm::Regex &CommentPragmasRegex) {
+  if (Line.Tokens.empty() || Style.ReflowComments != FormatStyle::RCS_Always)
     return false;
 
   StringRef IndentContent = FormatTok.TokenText;
@@ -4721,8 +4721,8 @@ void UnwrappedLineParser::flushComments(bool NewlineBeforeNext) {
     //
     // FIXME: Consider putting separate line comment sections as children to the
     // unwrapped line instead.
-    Tok->ContinuesLineCommentSection = continuesLineCommentSection(
-        *Tok, *Line, Style.ReflowComments, CommentPragmasRegex);
+    Tok->ContinuesLineCommentSection =
+        continuesLineCommentSection(*Tok, *Line, Style, CommentPragmasRegex);
     if (isOnNewLine(*Tok) && JustComments && !Tok->ContinuesLineCommentSection)
       addUnwrappedLine();
     pushToken(Tok);
@@ -4796,7 +4796,7 @@ void UnwrappedLineParser::distributeComments(
       FormatTok->ContinuesLineCommentSection = false;
     } else {
       FormatTok->ContinuesLineCommentSection = continuesLineCommentSection(
-          *FormatTok, *Line, Style.ReflowComments, CommentPragmasRegex);
+          *FormatTok, *Line, Style, CommentPragmasRegex);
     }
     if (!FormatTok->ContinuesLineCommentSection &&
         (isOnNewLine(*FormatTok) || FormatTok->IsFirst)) {