[clang] f926bcf - [clang-format][doc] Fix the description of BreakBinaryOperations

Owen Pan via cfe-commits cfe-commits at lists.llvm.org
Thu Jan 9 18:56:50 PST 2025


Author: Owen Pan
Date: 2025-01-09T18:56:42-08:00
New Revision: f926bcf9068c808b643a56322b7ef6910eb36599

URL: https://github.com/llvm/llvm-project/commit/f926bcf9068c808b643a56322b7ef6910eb36599
DIFF: https://github.com/llvm/llvm-project/commit/f926bcf9068c808b643a56322b7ef6910eb36599.diff

LOG: [clang-format][doc] Fix the description of BreakBinaryOperations

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 637ec23e0abaf7..0edf7af72c24e9 100644
--- a/clang/docs/ClangFormatStyleOptions.rst
+++ b/clang/docs/ClangFormatStyleOptions.rst
@@ -3441,7 +3441,7 @@ the configuration (without a prefix: ``Auto``).
 .. _BreakBinaryOperations:
 
 **BreakBinaryOperations** (``BreakBinaryOperationsStyle``) :versionbadge:`clang-format 20` :ref:`ΒΆ <BreakBinaryOperations>`
-  The break constructor initializers style to use.
+  The break binary operations style to use.
 
   Possible values:
 
@@ -3764,6 +3764,7 @@ the configuration (without a prefix: ``Auto``).
   lists.
 
   Important 
diff erences:
+
   * No spaces inside the braced list.
   * No line break before the closing brace.
   * Indentation with the continuation indent, not with the block indent.

diff  --git a/clang/include/clang/Format/Format.h b/clang/include/clang/Format/Format.h
index 8d410775496901..7c2afd4d94ab0d 100644
--- a/clang/include/clang/Format/Format.h
+++ b/clang/include/clang/Format/Format.h
@@ -2298,7 +2298,7 @@ struct FormatStyle {
     BBO_RespectPrecedence
   };
 
-  /// The break constructor initializers style to use.
+  /// The break binary operations style to use.
   /// \version 20
   BreakBinaryOperationsStyle BreakBinaryOperations;
 
@@ -2510,6 +2510,7 @@ struct FormatStyle {
   /// lists.
   ///
   /// Important 
diff erences:
+  ///
   /// * No spaces inside the braced list.
   /// * No line break before the closing brace.
   /// * Indentation with the continuation indent, not with the block indent.


        


More information about the cfe-commits mailing list