Commit 23b78364 authored by paulhoad's avatar paulhoad
Browse files

[clang-format] update documentation 

Summary:
  - Added example code for BreakStringLiterals;

Reviewers: MyDeveloperDay

Reviewed By: MyDeveloperDay

Patch By: mrexodia

Subscribers: cfe-commits, MyDeveloperDay

Tags: #clang-tools-extra, #clang-format, #clang

Differential Revision: https://reviews.llvm.org/D31574
parent 31b752cb

clang/docs/ClangFormatStyleOptions.rst

+11 −0
Original line number Diff line number Diff line
@@ -1321,6 +1321,17 @@ the configuration (without a prefix: ``Auto``). 
**BreakStringLiterals** (``bool``)

  Allow breaking string literals when formatting.



  .. code-block:: c++



     true:

     const char* x = "veryVeryVeryVeryVeryVe"

                     "ryVeryVeryVeryVeryVery"

                     "VeryLongString";



     false:

     const char* x =

       "veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongString";



**ColumnLimit** (``unsigned``)

  The column limit.

clang/include/clang/Format/Format.h

+11 −2
Original line number Diff line number Diff line
@@ -782,7 +782,7 @@ struct FormatStyle { 
  /// The brace breaking style to use.

  BraceBreakingStyle BreakBeforeBraces;



  // Different ways to wrap braces after control statements.

  /// Different ways to wrap braces after control statements.

  enum BraceWrappingAfterControlStatementStyle {

    /// Never wrap braces after a control statement.

    /// \code
@@ -1077,6 +1077,16 @@ struct FormatStyle { 
  bool BreakAfterJavaFieldAnnotations;



  /// Allow breaking string literals when formatting.

  /// \code

  ///    true:

  ///    const char* x = "veryVeryVeryVeryVeryVe"

  ///                    "ryVeryVeryVeryVeryVery"

  ///                    "VeryLongString";

  ///

  ///    false:

  ///    const char* x =

  ///      "veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongString";

  /// \endcode

  bool BreakStringLiterals;



  /// The column limit.
@@ -1985,7 +1995,6 @@ struct FormatStyle { 
    /// Latest: Parse and format using the latest supported language version.

    /// 'Cpp11' is an alias for LS_Latest for historical reasons.

    LS_Latest,



    /// Auto: Automatic detection based on the input.

    /// Parse using the latest language version. Format based on detected input.

    LS_Auto,