Skip to content

Commit 5dfffed

Browse files
committed
Rename child description to documentation
1 parent 56ef324 commit 5dfffed

File tree

8 files changed

+166
-172
lines changed

8 files changed

+166
-172
lines changed

CodeGeneration/Sources/SyntaxSupport/AttributeNodes.swift

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -39,19 +39,19 @@ public let ATTRIBUTE_NODES: [Node] = [
3939
Child(
4040
name: "AtSignToken",
4141
kind: .token(choices: [.token(tokenKind: "AtSignToken")]),
42-
description: "The `@` sign."
42+
documentation: "The `@` sign."
4343
),
4444
Child(
4545
name: "AttributeName",
4646
kind: .node(kind: .type),
4747
nameForDiagnostics: "name",
48-
description: "The name of the attribute.",
48+
documentation: "The name of the attribute.",
4949
classification: "Attribute"
5050
),
5151
Child(
5252
name: "LeftParen",
5353
kind: .token(choices: [.token(tokenKind: "LeftParenToken")]),
54-
description: "If the attribute takes arguments, the opening parenthesis.",
54+
documentation: "If the attribute takes arguments, the opening parenthesis.",
5555
isOptional: true
5656
),
5757
Child(
@@ -138,13 +138,13 @@ public let ATTRIBUTE_NODES: [Node] = [
138138
kind: .node(kind: .documentationAttributeArguments)
139139
),
140140
]),
141-
description: "The arguments of the attribute. In case the attribute takes multiple arguments, they are gather in the appropriate takes first.",
141+
documentation: "The arguments of the attribute. In case the attribute takes multiple arguments, they are gather in the appropriate takes first.",
142142
isOptional: true
143143
),
144144
Child(
145145
name: "RightParen",
146146
kind: .token(choices: [.token(tokenKind: "RightParenToken")]),
147-
description: "If the attribute takes arguments, the closing parenthesis.",
147+
documentation: "If the attribute takes arguments, the closing parenthesis.",
148148
isOptional: true
149149
),
150150
]
@@ -160,12 +160,12 @@ public let ATTRIBUTE_NODES: [Node] = [
160160
name: "Label",
161161
kind: .token(choices: [.keyword(text: "availability")]),
162162
nameForDiagnostics: "label",
163-
description: "The label of the argument"
163+
documentation: "The label of the argument"
164164
),
165165
Child(
166166
name: "Colon",
167167
kind: .token(choices: [.token(tokenKind: "ColonToken")]),
168-
description: "The colon separating the label and the value"
168+
documentation: "The colon separating the label and the value"
169169
),
170170
Child(
171171
name: "AvailabilityList",
@@ -193,7 +193,7 @@ public let ATTRIBUTE_NODES: [Node] = [
193193
Child(
194194
name: "TrailingComma",
195195
kind: .token(choices: [.token(tokenKind: "CommaToken")]),
196-
description: "A trailing comma if the argument is followed by another argument",
196+
documentation: "A trailing comma if the argument is followed by another argument",
197197
isOptional: true
198198
),
199199
]
@@ -219,17 +219,17 @@ public let ATTRIBUTE_NODES: [Node] = [
219219
Child(
220220
name: "BeforeLabel",
221221
kind: .token(choices: [.keyword(text: "before")]),
222-
description: "The \"before\" label."
222+
documentation: "The \"before\" label."
223223
),
224224
Child(
225225
name: "Colon",
226226
kind: .token(choices: [.token(tokenKind: "ColonToken")]),
227-
description: "The colon separating \"before\" and the parameter list."
227+
documentation: "The colon separating \"before\" and the parameter list."
228228
),
229229
Child(
230230
name: "VersionList",
231231
kind: .collection(kind: .availabilityVersionRestrictionList, collectionElementName: "Availability"),
232-
description: "The list of OS versions in which the declaration became ABI stable."
232+
documentation: "The list of OS versions in which the declaration became ABI stable."
233233
),
234234
]
235235
),
@@ -244,7 +244,7 @@ public let ATTRIBUTE_NODES: [Node] = [
244244
Child(
245245
name: "ConventionLabel",
246246
kind: .token(choices: [.token(tokenKind: "IdentifierToken")]),
247-
description: "The convention label."
247+
documentation: "The convention label."
248248
),
249249
Child(
250250
name: "Comma",
@@ -300,13 +300,13 @@ public let ATTRIBUTE_NODES: [Node] = [
300300
name: "DeclBaseName",
301301
kind: .token(choices: [.token(tokenKind: "IdentifierToken"), .token(tokenKind: "BinaryOperatorToken"), .keyword(text: "init"), .keyword(text: "self"), .keyword(text: "Self")]),
302302
nameForDiagnostics: "base name",
303-
description: "The base name of the protocol's requirement."
303+
documentation: "The base name of the protocol's requirement."
304304
),
305305
Child(
306306
name: "DeclNameArguments",
307307
kind: .node(kind: .declNameArguments),
308308
nameForDiagnostics: "arguments",
309-
description: "The argument labels of the protocol's requirement if it is a function requirement.",
309+
documentation: "The argument labels of the protocol's requirement if it is a function requirement.",
310310
isOptional: true
311311
),
312312
]
@@ -327,28 +327,28 @@ public let ATTRIBUTE_NODES: [Node] = [
327327
Child(
328328
name: "OfLabel",
329329
kind: .token(choices: [.keyword(text: "of")]),
330-
description: "The \"of\" label."
330+
documentation: "The \"of\" label."
331331
),
332332
Child(
333333
name: "Colon",
334334
kind: .token(choices: [.token(tokenKind: "ColonToken")]),
335-
description: "The colon separating the \"of\" label and the original declaration name."
335+
documentation: "The colon separating the \"of\" label and the original declaration name."
336336
),
337337
Child(
338338
name: "OriginalDeclName",
339339
kind: .node(kind: .qualifiedDeclName),
340-
description: "The referenced original declaration name."
340+
documentation: "The referenced original declaration name."
341341
),
342342
Child(
343343
name: "Period",
344344
kind: .token(choices: [.token(tokenKind: "PeriodToken")]),
345-
description: "The period separating the original declaration name and the accessor name.",
345+
documentation: "The period separating the original declaration name and the accessor name.",
346346
isOptional: true
347347
),
348348
Child(
349349
name: "AccessorKind",
350350
kind: .token(choices: [.keyword(text: "get"), .keyword(text: "set")]),
351-
description: "The accessor name.",
351+
documentation: "The accessor name.",
352352
isOptional: true
353353
),
354354
Child(
@@ -406,12 +406,12 @@ public let ATTRIBUTE_NODES: [Node] = [
406406
Child(
407407
name: "WrtLabel",
408408
kind: .token(choices: [.keyword(text: "wrt")]),
409-
description: "The \"wrt\" label."
409+
documentation: "The \"wrt\" label."
410410
),
411411
Child(
412412
name: "Colon",
413413
kind: .token(choices: [.token(tokenKind: "ColonToken")]),
414-
description: "The colon separating \"wrt\" and the parameter list."
414+
documentation: "The colon separating \"wrt\" and the parameter list."
415415
),
416416
Child(
417417
name: "Parameters",
@@ -444,7 +444,7 @@ public let ATTRIBUTE_NODES: [Node] = [
444444
Child(
445445
name: "DiffParams",
446446
kind: .collection(kind: .differentiabilityParamList, collectionElementName: "DifferentiabilityParam"),
447-
description: "The parameters for differentiation."
447+
documentation: "The parameters for differentiation."
448448
),
449449
Child(
450450
name: "RightParen",
@@ -471,7 +471,7 @@ public let ATTRIBUTE_NODES: [Node] = [
471471
Child(
472472
name: "DiffKindComma",
473473
kind: .token(choices: [.token(tokenKind: "CommaToken")]),
474-
description: "The comma following the differentiability kind, if it exists.",
474+
documentation: "The comma following the differentiability kind, if it exists.",
475475
isOptional: true
476476
),
477477
Child(
@@ -482,7 +482,7 @@ public let ATTRIBUTE_NODES: [Node] = [
482482
Child(
483483
name: "DiffParamsComma",
484484
kind: .token(choices: [.token(tokenKind: "CommaToken")]),
485-
description: "The comma following the differentiability parameters clause, if it exists.",
485+
documentation: "The comma following the differentiability parameters clause, if it exists.",
486486
isOptional: true
487487
),
488488
Child(
@@ -526,7 +526,7 @@ public let ATTRIBUTE_NODES: [Node] = [
526526
Child(
527527
name: "TrailingComma",
528528
kind: .token(choices: [.token(tokenKind: "CommaToken")]),
529-
description: "A trailing comma if this argument is followed by another one",
529+
documentation: "A trailing comma if this argument is followed by another one",
530530
isOptional: true
531531
),
532532
]
@@ -605,24 +605,24 @@ public let ATTRIBUTE_NODES: [Node] = [
605605
name: "Type",
606606
kind: .node(kind: .type),
607607
nameForDiagnostics: "type",
608-
description: "The type for which the method with this attribute implements a requirement."
608+
documentation: "The type for which the method with this attribute implements a requirement."
609609
),
610610
Child(
611611
name: "Comma",
612612
kind: .token(choices: [.token(tokenKind: "CommaToken")]),
613-
description: "The comma separating the type and method name"
613+
documentation: "The comma separating the type and method name"
614614
),
615615
Child(
616616
name: "DeclBaseName",
617617
kind: .node(kind: .token),
618618
nameForDiagnostics: "declaration base name",
619-
description: "The base name of the protocol's requirement."
619+
documentation: "The base name of the protocol's requirement."
620620
),
621621
Child(
622622
name: "DeclNameArguments",
623623
kind: .node(kind: .declNameArguments),
624624
nameForDiagnostics: "declaration name arguments",
625-
description: "The argument labels of the protocol's requirement if it is a function requirement.",
625+
documentation: "The argument labels of the protocol's requirement if it is a function requirement.",
626626
isOptional: true
627627
),
628628
]
@@ -643,23 +643,23 @@ public let ATTRIBUTE_NODES: [Node] = [
643643
name: "Label",
644644
kind: .node(kind: .token),
645645
nameForDiagnostics: "label",
646-
description: "The label of the argument"
646+
documentation: "The label of the argument"
647647
),
648648
Child(
649649
name: "Colon",
650650
kind: .token(choices: [.token(tokenKind: "ColonToken")]),
651-
description: "The colon separating the label and the value"
651+
documentation: "The colon separating the label and the value"
652652
),
653653
Child(
654654
name: "Value",
655655
kind: .node(kind: .token),
656656
nameForDiagnostics: "value",
657-
description: "The value for this argument"
657+
documentation: "The value for this argument"
658658
),
659659
Child(
660660
name: "TrailingComma",
661661
kind: .token(choices: [.token(tokenKind: "CommaToken")]),
662-
description: "A trailing comma if this argument is followed by another one",
662+
documentation: "A trailing comma if this argument is followed by another one",
663663
isOptional: true
664664
),
665665
]
@@ -704,7 +704,7 @@ public let ATTRIBUTE_NODES: [Node] = [
704704
Child(
705705
name: "MangledName",
706706
kind: .node(kind: .stringLiteralExpr),
707-
description: "The mangled name of a declaration."
707+
documentation: "The mangled name of a declaration."
708708
),
709709
Child(
710710
name: "Comma",
@@ -713,7 +713,7 @@ public let ATTRIBUTE_NODES: [Node] = [
713713
Child(
714714
name: "Ordinal",
715715
kind: .token(choices: [.token(tokenKind: "IntegerLiteralToken")]),
716-
description: "The ordinal corresponding to the 'some' keyword that introduced this opaque type."
716+
documentation: "The ordinal corresponding to the 'some' keyword that introduced this opaque type."
717717
),
718718
]
719719
),
@@ -766,7 +766,7 @@ public let ATTRIBUTE_NODES: [Node] = [
766766
name: "BaseType",
767767
kind: .node(kind: .type),
768768
nameForDiagnostics: "base type",
769-
description: "The base type of the qualified name, optionally specified.",
769+
documentation: "The base type of the qualified name, optionally specified.",
770770
isOptional: true
771771
),
772772
Child(
@@ -778,13 +778,13 @@ public let ATTRIBUTE_NODES: [Node] = [
778778
name: "Name",
779779
kind: .token(choices: [.token(tokenKind: "IdentifierToken"), .keyword(text: "self"), .keyword(text: "Self"), .keyword(text: "init"), .token(tokenKind: "BinaryOperatorToken")]),
780780
nameForDiagnostics: "base name",
781-
description: "The base name of the referenced function."
781+
documentation: "The base name of the referenced function."
782782
),
783783
Child(
784784
name: "Arguments",
785785
kind: .node(kind: .declNameArguments),
786786
nameForDiagnostics: "arguments",
787-
description: "The argument labels of the referenced function, optionally specified.",
787+
documentation: "The argument labels of the referenced function, optionally specified.",
788788
isOptional: true
789789
),
790790
]
@@ -818,23 +818,23 @@ public let ATTRIBUTE_NODES: [Node] = [
818818
name: "Label",
819819
kind: .token(choices: [.keyword(text: "target")]),
820820
nameForDiagnostics: "label",
821-
description: "The label of the argument"
821+
documentation: "The label of the argument"
822822
),
823823
Child(
824824
name: "Colon",
825825
kind: .token(choices: [.token(tokenKind: "ColonToken")]),
826-
description: "The colon separating the label and the value"
826+
documentation: "The colon separating the label and the value"
827827
),
828828
Child(
829829
name: "Declname",
830830
kind: .node(kind: .declName),
831831
nameForDiagnostics: "declaration name",
832-
description: "The value for this argument"
832+
documentation: "The value for this argument"
833833
),
834834
Child(
835835
name: "TrailingComma",
836836
kind: .token(choices: [.token(tokenKind: "CommaToken")]),
837-
description: "A trailing comma if this argument is followed by another one",
837+
documentation: "A trailing comma if this argument is followed by another one",
838838
isOptional: true
839839
),
840840
]

CodeGeneration/Sources/SyntaxSupport/AvailabilityNodes.swift

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,12 @@ public let AVAILABILITY_NODES: [Node] = [
3838
kind: .node(kind: .availabilityLabeledArgument)
3939
),
4040
]),
41-
description: "The actual argument"
41+
documentation: "The actual argument"
4242
),
4343
Child(
4444
name: "TrailingComma",
4545
kind: .token(choices: [.token(tokenKind: "CommaToken")]),
46-
description: "A trailing comma if the argument is followed by another argument",
46+
documentation: "A trailing comma if the argument is followed by another argument",
4747
isOptional: true
4848
),
4949
]
@@ -61,12 +61,12 @@ public let AVAILABILITY_NODES: [Node] = [
6161
name: "Label",
6262
kind: .token(choices: [.keyword(text: "message"), .keyword(text: "renamed"), .keyword(text: "introduced"), .keyword(text: "obsoleted"), .keyword(text: "deprecated")]),
6363
nameForDiagnostics: "label",
64-
description: "The label of the argument"
64+
documentation: "The label of the argument"
6565
),
6666
Child(
6767
name: "Colon",
6868
kind: .token(choices: [.token(tokenKind: "ColonToken")]),
69-
description: "The colon separating label and value"
69+
documentation: "The colon separating label and value"
7070
),
7171
Child(
7272
name: "Value",
@@ -81,7 +81,7 @@ public let AVAILABILITY_NODES: [Node] = [
8181
),
8282
]),
8383
nameForDiagnostics: "value",
84-
description: "The value of this labeled argument"
84+
documentation: "The value of this labeled argument"
8585
),
8686
]
8787
),
@@ -106,7 +106,7 @@ public let AVAILABILITY_NODES: [Node] = [
106106
name: "Platform",
107107
kind: .token(choices: [.token(tokenKind: "IdentifierToken")]),
108108
nameForDiagnostics: "platform",
109-
description: "The name of the OS on which the availability should be restricted or 'swift' if the availability should be restricted based on a Swift version.",
109+
documentation: "The name of the OS on which the availability should be restricted or 'swift' if the availability should be restricted based on a Swift version.",
110110
classification: "Keyword"
111111
),
112112
Child(
@@ -128,12 +128,12 @@ public let AVAILABILITY_NODES: [Node] = [
128128
Child(
129129
name: "Period",
130130
kind: .token(choices: [.token(tokenKind: "PeriodToken")]),
131-
description: "The period of this version component"
131+
documentation: "The period of this version component"
132132
),
133133
Child(
134134
name: "Number",
135135
kind: .token(choices: [.token(tokenKind: "IntegerLiteralToken")]),
136-
description: "The version number of this component"
136+
documentation: "The version number of this component"
137137
),
138138
]
139139
),
@@ -156,12 +156,12 @@ public let AVAILABILITY_NODES: [Node] = [
156156
Child(
157157
name: "Major",
158158
kind: .token(choices: [.token(tokenKind: "IntegerLiteralToken")]),
159-
description: "The major version."
159+
documentation: "The major version."
160160
),
161161
Child(
162162
name: "Components",
163163
kind: .collection(kind: .versionComponentList, collectionElementName: "VersionComponent"),
164-
description: "Any version components that are not the major version . For example, for `1.2.0`, this will contain `.2.0`",
164+
documentation: "Any version components that are not the major version . For example, for `1.2.0`, this will contain `.2.0`",
165165
isOptional: true
166166
),
167167
]

0 commit comments

Comments
 (0)