]> granicus.if.org Git - clang/commitdiff
clang-format: Fix documentation generation
authorFrancois Ferrand <thetypz@gmail.com>
Thu, 14 Jun 2018 13:32:14 +0000 (13:32 +0000)
committerFrancois Ferrand <thetypz@gmail.com>
Thu, 14 Jun 2018 13:32:14 +0000 (13:32 +0000)
Summary:
It seems that the changes done to `ClangFormatStyleOptions.rst` @334408 are causing the generation of the documentation to fail, with the following error:

  Warning, treated as error:
    /llvm/tools/clang/docs/ClangFormatStyleOptions.rst:1060: WARNING: Definition list ends without a blank line; unexpected unindent.

This is due to missing indent in some code block, and fixed by this patch.

Reviewers: krasimir, djasper, klimek

Reviewed By: krasimir

Subscribers: cfe-commits

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

git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@334709 91177308-0d34-0410-b5e6-96231b3b80d8

docs/ClangFormatStyleOptions.rst
include/clang/Format/Format.h

index 976362f1ee2f0e1993ecc27a9ec87e0babf8fc32..64008b50a0dc24f8b705ef11fb58ba508a054b8c 100644 (file)
@@ -1019,9 +1019,9 @@ the configuration (without a prefix: ``Auto``).
 
     .. code-block:: c++
 
-    Constructor()
-        : initializer1(),
-          initializer2()
+       Constructor()
+           : initializer1(),
+             initializer2()
 
   * ``BCIS_BeforeComma`` (in configuration: ``BeforeComma``)
     Break constructor initializers before the colon and commas, and align
@@ -1029,18 +1029,18 @@ the configuration (without a prefix: ``Auto``).
 
     .. code-block:: c++
 
-    Constructor()
-        : initializer1()
-        , initializer2()
+       Constructor()
+           : initializer1()
+           , initializer2()
 
   * ``BCIS_AfterColon`` (in configuration: ``AfterColon``)
     Break constructor initializers after the colon and commas.
 
     .. code-block:: c++
 
-    Constructor() :
-        initializer1(),
-        initializer2()
+       Constructor() :
+           initializer1(),
+           initializer2()
 
 
 
@@ -1054,10 +1054,10 @@ the configuration (without a prefix: ``Auto``).
 
     .. code-block:: c++
 
-    class Foo
-        : Base1,
-          Base2
-    {};
+       class Foo
+           : Base1,
+             Base2
+       {};
 
   * ``BILS_BeforeComma`` (in configuration: ``BeforeComma``)
     Break inheritance list before the colon and commas, and align
@@ -1065,18 +1065,20 @@ the configuration (without a prefix: ``Auto``).
 
     .. code-block:: c++
 
-    Constructor()
-        : initializer1()
-        , initializer2()
+       class Foo
+           : Base1
+           , Base2
+       {};
 
   * ``BILS_AfterColon`` (in configuration: ``AfterColon``)
     Break inheritance list after the colon and commas.
 
     .. code-block:: c++
 
-    Constructor() :
-        initializer1(),
-        initializer2()
+       class Foo :
+           Base1,
+           Base2
+       {};
 
 
 
index efc7cf643b291a827868c6e966bd6f35b5641fc5..1d135fe1bd2d9624c136ce51e4cc0dd949203cf5 100644 (file)
@@ -840,24 +840,24 @@ struct FormatStyle {
   enum BreakConstructorInitializersStyle {
     /// Break constructor initializers before the colon and after the commas.
     /// \code
-    /// Constructor()
-    ///     : initializer1(),
-    ///       initializer2()
+    ///    Constructor()
+    ///        : initializer1(),
+    ///          initializer2()
     /// \endcode
     BCIS_BeforeColon,
     /// Break constructor initializers before the colon and commas, and align
     /// the commas with the colon.
     /// \code
-    /// Constructor()
-    ///     : initializer1()
-    ///     , initializer2()
+    ///    Constructor()
+    ///        : initializer1()
+    ///        , initializer2()
     /// \endcode
     BCIS_BeforeComma,
     /// Break constructor initializers after the colon and commas.
     /// \code
-    /// Constructor() :
-    ///     initializer1(),
-    ///     initializer2()
+    ///    Constructor() :
+    ///        initializer1(),
+    ///        initializer2()
     /// \endcode
     BCIS_AfterColon
   };
@@ -897,25 +897,27 @@ struct FormatStyle {
   enum BreakInheritanceListStyle {
     /// Break inheritance list before the colon and after the commas.
     /// \code
-    /// class Foo
-    ///     : Base1,
-    ///       Base2
-    /// {};
+    ///    class Foo
+    ///        : Base1,
+    ///          Base2
+    ///    {};
     /// \endcode
     BILS_BeforeColon,
     /// Break inheritance list before the colon and commas, and align
     /// the commas with the colon.
     /// \code
-    /// Constructor()
-    ///     : initializer1()
-    ///     , initializer2()
+    ///    class Foo
+    ///        : Base1
+    ///        , Base2
+    ///    {};
     /// \endcode
     BILS_BeforeComma,
     /// Break inheritance list after the colon and commas.
     /// \code
-    /// Constructor() :
-    ///     initializer1(),
-    ///     initializer2()
+    ///    class Foo :
+    ///        Base1,
+    ///        Base2
+    ///    {};
     /// \endcode
     BILS_AfterColon
   };