sstwcw created this revision.
sstwcw added a reviewer: clang-format.
sstwcw added a project: clang-format.
sstwcw requested review of this revision.
Herald added a project: clang.
Herald added a subscriber: cfe-commits.
Previously the comments for configuration structs as a whole like
``BraceWrappingFlags`` did not go into the doc.
Repository:
rG LLVM Github Monorepo
https://reviews.llvm.org/D120361
Files:
clang/docs/ClangFormatStyleOptions.rst
clang/docs/tools/dump_format_style.py
Index: clang/docs/tools/dump_format_style.py
===================================================================
--- clang/docs/tools/dump_format_style.py
+++ clang/docs/tools/dump_format_style.py
@@ -118,7 +118,7 @@
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):
Index: clang/docs/ClangFormatStyleOptions.rst
===================================================================
--- clang/docs/ClangFormatStyleOptions.rst
+++ clang/docs/ClangFormatStyleOptions.rst
@@ -1209,6 +1209,14 @@
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.
@@ -3989,6 +3997,15 @@
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.
@@ -4218,6 +4235,7 @@
Nested configuration flags:
+ Control of spaces within a single line comment
* ``unsigned Minimum`` The minimum number of spaces at the start of the
comment.
Index: clang/docs/tools/dump_format_style.py
===================================================================
--- clang/docs/tools/dump_format_style.py
+++ clang/docs/tools/dump_format_style.py
@@ -118,7 +118,7 @@
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):
Index: clang/docs/ClangFormatStyleOptions.rst
===================================================================
--- clang/docs/ClangFormatStyleOptions.rst
+++ clang/docs/ClangFormatStyleOptions.rst
@@ -1209,6 +1209,14 @@
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.
@@ -3989,6 +3997,15 @@
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.
@@ -4218,6 +4235,7 @@
Nested configuration flags:
+ Control of spaces within a single line comment
* ``unsigned Minimum`` The minimum number of spaces at the start of the comment.
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
