Author: sstwcw Date: 2022-03-14T04:41:40Z New Revision: 93b5505b456f75ff33be20402b0317cbb2131a66
URL: https://github.com/llvm/llvm-project/commit/93b5505b456f75ff33be20402b0317cbb2131a66 DIFF: https://github.com/llvm/llvm-project/commit/93b5505b456f75ff33be20402b0317cbb2131a66.diff LOG: [clang-format] Extract doc for entire configuration structs Previously the comments for configuration structs as a whole like `BraceWrappingFlags` did not go into the doc. Reviewed By: curdeius Differential Revision: https://reviews.llvm.org/D120361 Added: Modified: clang/docs/ClangFormatStyleOptions.rst clang/docs/tools/dump_format_style.py Removed: ################################################################################ diff --git a/clang/docs/ClangFormatStyleOptions.rst b/clang/docs/ClangFormatStyleOptions.rst index 9b5d9ee7ef298..c1af14466dd0e 100644 --- a/clang/docs/ClangFormatStyleOptions.rst +++ b/clang/docs/ClangFormatStyleOptions.rst @@ -1212,6 +1212,14 @@ the configuration (without a prefix: ``Auto``). Nested configuration flags: + Precise control over the wrapping of braces. + + .. code-block:: c++ + + # Should be declared this way: + BreakBeforeBraces: Custom + BraceWrapping: + AfterClass: true * ``bool AfterCaseLabel`` Wrap case labels. @@ -3992,6 +4000,15 @@ the configuration (without a prefix: ``Auto``). Nested configuration flags: + Precise control over the spacing before parentheses. + + .. code-block:: c++ + + # Should be declared this way: + SpaceBeforeParens: Custom + SpaceBeforeParensOptions: + AfterControlStatements: true + AfterFunctionDefinitionName: true * ``bool AfterControlStatements`` If ``true``, put space betwee control statement keywords (for/if/while...) and opening parentheses. @@ -4221,6 +4238,7 @@ the configuration (without a prefix: ``Auto``). Nested configuration flags: + Control of spaces within a single line comment * ``unsigned Minimum`` The minimum number of spaces at the start of the comment. diff --git a/clang/docs/tools/dump_format_style.py b/clang/docs/tools/dump_format_style.py index d04920987ec67..fb074435e753e 100755 --- a/clang/docs/tools/dump_format_style.py +++ b/clang/docs/tools/dump_format_style.py @@ -118,7 +118,7 @@ def __init__(self, name, comment): self.values = [] def __str__(self): - return '\n'.join(map(str, self.values)) + return self.comment + '\n' + '\n'.join(map(str, self.values)) class NestedField(object): def __init__(self, name, comment): _______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
