From 4ae9641a00677c7ead2e296ca56a2c35fb18a22d Mon Sep 17 00:00:00 2001 From: Krasimir Georgiev Date: Tue, 6 Mar 2018 13:24:01 +0000 Subject: [PATCH] [clang-format] Fix documentation for SpaceAfterCStyleCast option Patch contributed by @EricMarti! Summary: I noticed that the example for SpaceAfterCStyleCast does not match its description. I fixed the example after testing it out. Reviewers: rsmith, krasimir Reviewed By: krasimir Subscribers: klimek, cfe-commits Differential Revision: https://reviews.llvm.org/D43731 git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@326781 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/ClangFormatStyleOptions.rst | 52 ++++++++++++++++++++++++++++++-- include/clang/Format/Format.h | 2 +- 2 files changed, 51 insertions(+), 3 deletions(-) diff --git a/docs/ClangFormatStyleOptions.rst b/docs/ClangFormatStyleOptions.rst index 1ddcce8b7a..816b39f06f 100644 --- a/docs/ClangFormatStyleOptions.rst +++ b/docs/ClangFormatStyleOptions.rst @@ -629,7 +629,9 @@ the configuration (without a prefix: ``Auto``). int bar(); } - * ``bool AfterObjCDeclaration`` Wrap ObjC definitions (``@autoreleasepool``, interfaces, ..). + * ``bool AfterObjCDeclaration`` Wrap ObjC definitions (interfaces, implementations...). + @autoreleasepool and @synchronized blocks are wrapped + according to `AfterControlStatement` flag. * ``bool AfterStruct`` Wrap struct definitions. @@ -1508,6 +1510,52 @@ the configuration (without a prefix: ``Auto``). +**ObjCBinPackProtocolList** (``BinPackStyle``) + Controls bin-packing Objective-C protocol conformance list + items into as few lines as possible when they go over ``ColumnLimit``. + + If ``Auto`` (the default), delegates to the value in + ``BinPackParameters``. If that is ``true``, bin-packs Objective-C + protocol conformance list items into as few lines as possible + whenever they go over ``ColumnLimit``. + + If ``Always``, always bin-packs Objective-C protocol conformance + list items into as few lines as possible whenever they go over + ``ColumnLimit``. + + If ``Never``, lays out Objective-C protocol conformance list items + onto individual lines whenever they go over ``ColumnLimit``. + + + .. code-block:: c++ + + Always (or Auto, if BinPackParameters=true): + @interface ccccccccccccc () < + ccccccccccccc, ccccccccccccc, + ccccccccccccc, ccccccccccccc> { + } + + Never (or Auto, if BinPackParameters=false): + @interface ddddddddddddd () < + ddddddddddddd, + ddddddddddddd, + ddddddddddddd, + ddddddddddddd> { + } + + Possible values: + + * ``BPS_Auto`` (in configuration: ``Auto``) + Automatically determine parameter bin-packing behavior. + + * ``BPS_Always`` (in configuration: ``Always``) + Always bin-pack parameters. + + * ``BPS_Never`` (in configuration: ``Never``) + Never bin-pack parameters. + + + **ObjCBlockIndentWidth** (``unsigned``) The number of characters to use for indentation of ObjC blocks. @@ -1662,7 +1710,7 @@ the configuration (without a prefix: ``Auto``). .. code-block:: c++ true: false: - (int)i; vs. (int) i; + (int) i; vs. (int)i; **SpaceAfterTemplateKeyword** (``bool``) If ``true``, a space will be inserted after the 'template' keyword. diff --git a/include/clang/Format/Format.h b/include/clang/Format/Format.h index 6a508b0f71..0a8b6cfefb 100644 --- a/include/clang/Format/Format.h +++ b/include/clang/Format/Format.h @@ -1506,7 +1506,7 @@ struct FormatStyle { /// \brief If ``true``, a space is inserted after C style casts. /// \code /// true: false: - /// (int)i; vs. (int) i; + /// (int) i; vs. (int)i; /// \endcode bool SpaceAfterCStyleCast; -- 2.50.1