Skip to content

Commit 3b5965e

Browse files
authored
[clang-format][doc] fix documentation for clang-format (#83415)
Fixes typo in documentation for clang-format Fixes #83207.
1 parent 1c9125c commit 3b5965e

File tree

3 files changed

+13
-12
lines changed

3 files changed

+13
-12
lines changed

clang/docs/ClangFormatStyleOptions.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -318,9 +318,9 @@ the configuration (without a prefix: ``Auto``).
318318

319319
.. code-block:: c++
320320

321-
AlignConsecutiveMacros: AcrossEmptyLines
321+
AlignConsecutiveAssignments: AcrossEmptyLines
322322

323-
AlignConsecutiveMacros:
323+
AlignConsecutiveAssignments:
324324
Enabled: true
325325
AcrossEmptyLines: true
326326
AcrossComments: false
@@ -460,9 +460,9 @@ the configuration (without a prefix: ``Auto``).
460460

461461
.. code-block:: c++
462462

463-
AlignConsecutiveMacros: AcrossEmptyLines
463+
AlignConsecutiveBitFields: AcrossEmptyLines
464464

465-
AlignConsecutiveMacros:
465+
AlignConsecutiveBitFields:
466466
Enabled: true
467467
AcrossEmptyLines: true
468468
AcrossComments: false
@@ -602,9 +602,9 @@ the configuration (without a prefix: ``Auto``).
602602

603603
.. code-block:: c++
604604

605-
AlignConsecutiveMacros: AcrossEmptyLines
605+
AlignConsecutiveDeclarations: AcrossEmptyLines
606606

607-
AlignConsecutiveMacros:
607+
AlignConsecutiveDeclarations:
608608
Enabled: true
609609
AcrossEmptyLines: true
610610
AcrossComments: false
@@ -983,9 +983,9 @@ the configuration (without a prefix: ``Auto``).
983983

984984
.. code-block:: c++
985985

986-
AlignConsecutiveMacros: AcrossEmptyLines
986+
AlignConsecutiveTableGenCondOperatorColons: AcrossEmptyLines
987987

988-
AlignConsecutiveMacros:
988+
AlignConsecutiveTableGenCondOperatorColons:
989989
Enabled: true
990990
AcrossEmptyLines: true
991991
AcrossComments: false
@@ -1123,9 +1123,9 @@ the configuration (without a prefix: ``Auto``).
11231123

11241124
.. code-block:: c++
11251125

1126-
AlignConsecutiveMacros: AcrossEmptyLines
1126+
AlignConsecutiveTableGenDefinitionColons: AcrossEmptyLines
11271127

1128-
AlignConsecutiveMacros:
1128+
AlignConsecutiveTableGenDefinitionColons:
11291129
Enabled: true
11301130
AcrossEmptyLines: true
11311131
AcrossComments: false

clang/docs/tools/dump_format_style.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,7 @@ def __str__(self):
129129
s += indent(
130130
"\n\nNested configuration flags:\n\n%s\n" % self.nested_struct, 2
131131
)
132+
s = s.replace("<option-name>", self.name)
132133
return s
133134

134135

clang/include/clang/Format/Format.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,9 +154,9 @@ struct FormatStyle {
154154
/// For example, to align across empty lines and not across comments, either
155155
/// of these work.
156156
/// \code
157-
/// AlignConsecutiveMacros: AcrossEmptyLines
157+
/// <option-name>: AcrossEmptyLines
158158
///
159-
/// AlignConsecutiveMacros:
159+
/// <option-name>:
160160
/// Enabled: true
161161
/// AcrossEmptyLines: true
162162
/// AcrossComments: false

0 commit comments

Comments
 (0)