r312716 - Refresh the clang format options doc with the recent changes

Sylvestre Ledru via cfe-commits cfe-commits at lists.llvm.org
Thu Sep 7 05:08:49 PDT 2017


Author: sylvestre
Date: Thu Sep  7 05:08:49 2017
New Revision: 312716

URL: http://llvm.org/viewvc/llvm-project?rev=312716&view=rev
Log:
Refresh the clang format options doc with the recent changes

Summary:
Looks like we are out of sync between the doc and the code.


Reviewers: djasper

Reviewed By: djasper

Subscribers: cfe-commits

Differential Revision: https://reviews.llvm.org/D37558

Modified:
    cfe/trunk/docs/ClangFormatStyleOptions.rst

Modified: cfe/trunk/docs/ClangFormatStyleOptions.rst
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/docs/ClangFormatStyleOptions.rst?rev=312716&r1=312715&r2=312716&view=diff
==============================================================================
--- cfe/trunk/docs/ClangFormatStyleOptions.rst (original)
+++ cfe/trunk/docs/ClangFormatStyleOptions.rst Thu Sep  7 05:08:49 2017
@@ -679,7 +679,7 @@ the configuration (without a prefix: ``A
 
   * ``bool IndentBraces`` Indent the wrapped braces themselves.
 
-  * ``bool SplitEmptyFunctionBody`` If ``false``, empty function body can be put on a single line.
+  * ``bool SplitEmptyFunction`` If ``false``, empty function body can be put on a single line.
     This option is used only if the opening brace of the function has
     already been wrapped, i.e. the `AfterFunction` brace wrapping mode is
     set, and the function could/should not be put on a single line (as per
@@ -691,6 +691,28 @@ the configuration (without a prefix: ``A
       {}              {
                       }
 
+  * ``bool SplitEmptyRecord`` If ``false``, empty record (e.g. class, struct or union) body
+    can be put on a single line. This option is used only if the opening
+    brace of the record has already been wrapped, i.e. the `AfterClass`
+    (for classes) brace wrapping mode is set.
+
+    .. code-block:: c++
+
+      class Foo   vs.  class Foo
+      {}               {
+                       }
+
+  * ``bool SplitEmptyNamespace`` If ``false``, empty namespace body can be put on a single line.
+    This option is used only if the opening brace of the namespace has
+    already been wrapped, i.e. the `AfterNamespace` brace wrapping mode is
+    set.
+
+    .. code-block:: c++
+
+      namespace Foo   vs.  namespace Foo
+      {}                   {
+                           }
+
 
 **BreakAfterJavaFieldAnnotations** (``bool``)
   Break after each annotation on a field in Java files.
@@ -1144,7 +1166,7 @@ the configuration (without a prefix: ``A
     IncludeCategories:
       - Regex:           '^"(llvm|llvm-c|clang|clang-c)/'
         Priority:        2
-      - Regex:           '^(<|"(gtest|isl|json)/)'
+      - Regex:           '^(<|"(gtest|gmock|isl|json)/)'
         Priority:        3
       - Regex:           '.*'
         Priority:        1
@@ -1180,7 +1202,7 @@ the configuration (without a prefix: ``A
      }                                      }
 
 **IndentPPDirectives** (``PPDirectiveIndentStyle``)
-  Indent preprocessor directives on conditionals.
+  The preprocessor directive indenting style to use.
 
   Possible values:
 
@@ -1189,22 +1211,24 @@ the configuration (without a prefix: ``A
 
     .. code-block:: c++
 
-      #if FOO
-      #if BAR
-      #include <foo>
-      #endif
-      #endif
+       #if FOO
+       #if BAR
+       #include <foo>
+       #endif
+       #endif
 
   * ``PPDIS_AfterHash`` (in configuration: ``AfterHash``)
     Indents directives after the hash.
 
     .. code-block:: c++
 
-      #if FOO
-      #  if BAR
-      #    include <foo>
-      #  endif
-      #endif
+       #if FOO
+       #  if BAR
+       #    include <foo>
+       #  endif
+       #endif
+
+
 
 **IndentWidth** (``unsigned``)
   The number of columns to use for indentation.
@@ -1318,6 +1342,10 @@ the configuration (without a prefix: ``A
   * ``LK_TableGen`` (in configuration: ``TableGen``)
     Should be used for TableGen code.
 
+  * ``LK_TextProto`` (in configuration: ``TextProto``)
+    Should be used for Protocol Buffer messages in text format
+    (https://developers.google.com/protocol-buffers/).
+
 
 
 **MacroBlockBegin** (``std::string``)




More information about the cfe-commits mailing list