[clang] f4a7f81 - [clang-format][doc] Minor cleanup

Owen Pan via cfe-commits cfe-commits at lists.llvm.org
Mon Jun 3 01:04:13 PDT 2024


Author: Owen Pan
Date: 2024-06-03T01:04:05-07:00
New Revision: f4a7f81a914ca8aceddd9b7a71e36bb0828ae052

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

LOG: [clang-format][doc] Minor cleanup

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 677dac25df68e..bb00c20922d36 100644
--- a/clang/docs/ClangFormatStyleOptions.rst
+++ b/clang/docs/ClangFormatStyleOptions.rst
@@ -5117,7 +5117,7 @@ the configuration (without a prefix: ``Auto``).
 
   .. note::
 
-   It must contain ``type``.
+   It **must** contain ``type``.
 
   Items to the left of ``type`` will be placed to the left of the type and
   aligned in the order supplied. Items to the right of ``type`` will be
@@ -6410,6 +6410,7 @@ the configuration (without a prefix: ``Auto``).
 
     TableGenBreakInsideDAGArg: BreakAll
     TableGenBreakingDAGArgOperators: [ins, outs]
+
   makes the line break only occurs inside DAGArgs beginning with the
   specified identifiers ``ins`` and ``outs``.
 
@@ -6537,7 +6538,7 @@ The goal of the clang-format project is more on the side of supporting a
 limited set of styles really well as opposed to supporting every single style
 used by a codebase somewhere in the wild. Of course, we do want to support all
 major projects and thus have established the following bar for adding style
-options. Each new style option must ..
+options. Each new style option must:
 
   * be used in a project of significant size (have dozens of contributors)
   * have a publicly accessible style guide

diff  --git a/clang/include/clang/Format/Format.h b/clang/include/clang/Format/Format.h
index 9bae252df366c..4fd6e013df25b 100644
--- a/clang/include/clang/Format/Format.h
+++ b/clang/include/clang/Format/Format.h
@@ -3650,7 +3650,7 @@ struct FormatStyle {
   ///   * type
   ///
   /// \note
-  ///  It \b must contain ``type``.
+  ///  It **must** contain ``type``.
   /// \endnote
   ///
   /// Items to the left of ``type`` will be placed to the left of the type and


        


More information about the cfe-commits mailing list