Skip to content

Commit 0857b48

Browse files
ahoppenahoppen
committed
Remove empty generated lines for syntax node doc comments
1 parent 7f2f43c commit 0857b48

File tree

9 files changed

+14
-403
lines changed

9 files changed

+14
-403
lines changed

‎CodeGeneration/Sources/generate-swiftsyntax/templates/swiftsyntax/SyntaxCollectionsFile.swift

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,15 @@ import Utils
1717

1818
let syntaxCollectionsFile = SourceFileSyntax(leadingTrivia: copyrightHeader) {
1919
for node in SYNTAX_NODES.compactMap(\.collectionNode) {
20+
let documentation = """
21+
\(node.documentation)
22+
\(node.documentation.isEmpty ? "" : "///")
23+
\(node.grammar)
24+
""".removingEmptyLines
25+
2026
try! StructDeclSyntax(
2127
"""
22-
\(raw: node.documentation)
23-
\(raw: node.documentation.isEmpty ? "" : "///")
24-
\(raw: node.grammar)
28+
\(raw: documentation)
2529
public struct \(node.kind.syntaxType): SyntaxCollection, SyntaxHashable
2630
"""
2731
) {

‎CodeGeneration/Sources/generate-swiftsyntax/templates/swiftsyntax/SyntaxNodesFile.swift

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,18 @@ extension Child {
3333
func syntaxNode(emitKind: SyntaxNodeKind) -> SourceFileSyntax {
3434
SourceFileSyntax(leadingTrivia: copyrightHeader) {
3535
for node in SYNTAX_NODES.compactMap(\.layoutNode) where node.base == emitKind {
36+
let documentation = """
37+
\(node.documentation)
38+
\(node.documentation.isEmpty ? "" : "///")
39+
\(node.grammar)
40+
""".removingEmptyLines
41+
3642
// We are actually handling this node now
3743
try! StructDeclSyntax(
3844
"""
3945
// MARK: - \(raw: node.kind.syntaxType)
4046
41-
\(raw: node.documentation)
42-
\(raw: node.documentation.isEmpty ? "" : "///")
43-
\(raw: node.grammar)
47+
\(raw: documentation)
4448
public struct \(raw: node.kind.syntaxType): \(raw: node.baseType.syntaxBaseName)Protocol, SyntaxHashable
4549
"""
4650
) {

‎Sources/SwiftSyntax/generated/SyntaxCollections.swift

Lines changed: 0 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212
//
1313
//===----------------------------------------------------------------------===//
1414

15-
16-
1715
/// ### Children
1816
///
1917
/// ``AccessorDeclSyntax``*
@@ -32,7 +30,6 @@ public struct AccessorListSyntax: SyntaxCollection, SyntaxHashable {
3230
public static let syntaxKind = SyntaxKind.accessorList
3331
}
3432

35-
3633
/// ### Children
3734
///
3835
/// ``ArrayElementSyntax``*
@@ -51,7 +48,6 @@ public struct ArrayElementListSyntax: SyntaxCollection, SyntaxHashable {
5148
public static let syntaxKind = SyntaxKind.arrayElementList
5249
}
5350

54-
5551
/// ### Children
5652
///
5753
/// (``AttributeSyntax`` | ``IfConfigDeclSyntax``) `*`
@@ -112,7 +108,6 @@ public struct AttributeListSyntax: SyntaxCollection, SyntaxHashable {
112108
public static let syntaxKind = SyntaxKind.attributeList
113109
}
114110

115-
116111
/// ### Children
117112
///
118113
/// ``AvailabilityArgumentSyntax``*
@@ -131,7 +126,6 @@ public struct AvailabilitySpecListSyntax: SyntaxCollection, SyntaxHashable {
131126
public static let syntaxKind = SyntaxKind.availabilitySpecList
132127
}
133128

134-
135129
/// ### Children
136130
///
137131
/// ``AvailabilityVersionRestrictionListEntrySyntax``*
@@ -150,7 +144,6 @@ public struct AvailabilityVersionRestrictionListSyntax: SyntaxCollection, Syntax
150144
public static let syntaxKind = SyntaxKind.availabilityVersionRestrictionList
151145
}
152146

153-
154147
/// ### Children
155148
///
156149
/// ``CaseItemSyntax``*
@@ -169,7 +162,6 @@ public struct CaseItemListSyntax: SyntaxCollection, SyntaxHashable {
169162
public static let syntaxKind = SyntaxKind.caseItemList
170163
}
171164

172-
173165
/// ### Children
174166
///
175167
/// ``CatchClauseSyntax``*
@@ -188,7 +180,6 @@ public struct CatchClauseListSyntax: SyntaxCollection, SyntaxHashable {
188180
public static let syntaxKind = SyntaxKind.catchClauseList
189181
}
190182

191-
192183
/// ### Children
193184
///
194185
/// ``CatchItemSyntax``*
@@ -207,7 +198,6 @@ public struct CatchItemListSyntax: SyntaxCollection, SyntaxHashable {
207198
public static let syntaxKind = SyntaxKind.catchItemList
208199
}
209200

210-
211201
/// ### Children
212202
///
213203
/// ``ClosureCaptureItemSyntax``*
@@ -226,7 +216,6 @@ public struct ClosureCaptureItemListSyntax: SyntaxCollection, SyntaxHashable {
226216
public static let syntaxKind = SyntaxKind.closureCaptureItemList
227217
}
228218

229-
230219
/// ### Children
231220
///
232221
/// ``ClosureParamSyntax``*
@@ -245,7 +234,6 @@ public struct ClosureParamListSyntax: SyntaxCollection, SyntaxHashable {
245234
public static let syntaxKind = SyntaxKind.closureParamList
246235
}
247236

248-
249237
/// ### Children
250238
///
251239
/// ``ClosureParameterSyntax``*
@@ -264,7 +252,6 @@ public struct ClosureParameterListSyntax: SyntaxCollection, SyntaxHashable {
264252
public static let syntaxKind = SyntaxKind.closureParameterList
265253
}
266254

267-
268255
/// ### Children
269256
///
270257
/// ``CodeBlockItemSyntax``*
@@ -283,7 +270,6 @@ public struct CodeBlockItemListSyntax: SyntaxCollection, SyntaxHashable {
283270
public static let syntaxKind = SyntaxKind.codeBlockItemList
284271
}
285272

286-
287273
/// ### Children
288274
///
289275
/// ``CompositionTypeElementSyntax``*
@@ -302,7 +288,6 @@ public struct CompositionTypeElementListSyntax: SyntaxCollection, SyntaxHashable
302288
public static let syntaxKind = SyntaxKind.compositionTypeElementList
303289
}
304290

305-
306291
/// ### Children
307292
///
308293
/// ``ConditionElementSyntax``*
@@ -321,7 +306,6 @@ public struct ConditionElementListSyntax: SyntaxCollection, SyntaxHashable {
321306
public static let syntaxKind = SyntaxKind.conditionElementList
322307
}
323308

324-
325309
/// ### Children
326310
///
327311
/// ``DeclNameArgumentSyntax``*
@@ -340,7 +324,6 @@ public struct DeclNameArgumentListSyntax: SyntaxCollection, SyntaxHashable {
340324
public static let syntaxKind = SyntaxKind.declNameArgumentList
341325
}
342326

343-
344327
/// ### Children
345328
///
346329
/// ``DesignatedTypeElementSyntax``*
@@ -359,7 +342,6 @@ public struct DesignatedTypeListSyntax: SyntaxCollection, SyntaxHashable {
359342
public static let syntaxKind = SyntaxKind.designatedTypeList
360343
}
361344

362-
363345
/// ### Children
364346
///
365347
/// ``DictionaryElementSyntax``*
@@ -378,7 +360,6 @@ public struct DictionaryElementListSyntax: SyntaxCollection, SyntaxHashable {
378360
public static let syntaxKind = SyntaxKind.dictionaryElementList
379361
}
380362

381-
382363
/// ### Children
383364
///
384365
/// ``DifferentiabilityParamSyntax``*
@@ -457,7 +438,6 @@ public struct EnumCaseElementListSyntax: SyntaxCollection, SyntaxHashable {
457438
public static let syntaxKind = SyntaxKind.enumCaseElementList
458439
}
459440

460-
461441
/// ### Children
462442
///
463443
/// ``EnumCaseParameterSyntax``*
@@ -496,7 +476,6 @@ public struct ExprListSyntax: SyntaxCollection, SyntaxHashable {
496476
public static let syntaxKind = SyntaxKind.exprList
497477
}
498478

499-
500479
/// ### Children
501480
///
502481
/// ``FunctionParameterSyntax``*
@@ -515,7 +494,6 @@ public struct FunctionParameterListSyntax: SyntaxCollection, SyntaxHashable {
515494
public static let syntaxKind = SyntaxKind.functionParameterList
516495
}
517496

518-
519497
/// ### Children
520498
///
521499
/// ``GenericArgumentSyntax``*
@@ -534,7 +512,6 @@ public struct GenericArgumentListSyntax: SyntaxCollection, SyntaxHashable {
534512
public static let syntaxKind = SyntaxKind.genericArgumentList
535513
}
536514

537-
538515
/// ### Children
539516
///
540517
/// ``GenericParameterSyntax``*
@@ -553,7 +530,6 @@ public struct GenericParameterListSyntax: SyntaxCollection, SyntaxHashable {
553530
public static let syntaxKind = SyntaxKind.genericParameterList
554531
}
555532

556-
557533
/// ### Children
558534
///
559535
/// ``GenericRequirementSyntax``*
@@ -572,7 +548,6 @@ public struct GenericRequirementListSyntax: SyntaxCollection, SyntaxHashable {
572548
public static let syntaxKind = SyntaxKind.genericRequirementList
573549
}
574550

575-
576551
/// ### Children
577552
///
578553
/// ``IfConfigClauseSyntax``*
@@ -591,7 +566,6 @@ public struct IfConfigClauseListSyntax: SyntaxCollection, SyntaxHashable {
591566
public static let syntaxKind = SyntaxKind.ifConfigClauseList
592567
}
593568

594-
595569
/// ### Children
596570
///
597571
/// ``ImportPathComponentSyntax``*
@@ -610,7 +584,6 @@ public struct ImportPathSyntax: SyntaxCollection, SyntaxHashable {
610584
public static let syntaxKind = SyntaxKind.importPath
611585
}
612586

613-
614587
/// ### Children
615588
///
616589
/// ``InheritedTypeSyntax``*
@@ -629,7 +602,6 @@ public struct InheritedTypeListSyntax: SyntaxCollection, SyntaxHashable {
629602
public static let syntaxKind = SyntaxKind.inheritedTypeList
630603
}
631604

632-
633605
/// ### Children
634606
///
635607
/// ``KeyPathComponentSyntax``*
@@ -648,7 +620,6 @@ public struct KeyPathComponentListSyntax: SyntaxCollection, SyntaxHashable {
648620
public static let syntaxKind = SyntaxKind.keyPathComponentList
649621
}
650622

651-
652623
/// ### Children
653624
///
654625
/// ``MemberDeclListItemSyntax``*
@@ -667,7 +638,6 @@ public struct MemberDeclListSyntax: SyntaxCollection, SyntaxHashable {
667638
public static let syntaxKind = SyntaxKind.memberDeclList
668639
}
669640

670-
671641
/// ### Children
672642
///
673643
/// ``DeclModifierSyntax``*
@@ -686,7 +656,6 @@ public struct ModifierListSyntax: SyntaxCollection, SyntaxHashable {
686656
public static let syntaxKind = SyntaxKind.modifierList
687657
}
688658

689-
690659
/// ### Children
691660
///
692661
/// ``MultipleTrailingClosureElementSyntax``*
@@ -705,7 +674,6 @@ public struct MultipleTrailingClosureElementListSyntax: SyntaxCollection, Syntax
705674
public static let syntaxKind = SyntaxKind.multipleTrailingClosureElementList
706675
}
707676

708-
709677
/// ### Children
710678
///
711679
/// ``ObjCSelectorPieceSyntax``*
@@ -724,7 +692,6 @@ public struct ObjCSelectorSyntax: SyntaxCollection, SyntaxHashable {
724692
public static let syntaxKind = SyntaxKind.objCSelector
725693
}
726694

727-
728695
/// ### Children
729696
///
730697
/// ``PatternBindingSyntax``*
@@ -743,7 +710,6 @@ public struct PatternBindingListSyntax: SyntaxCollection, SyntaxHashable {
743710
public static let syntaxKind = SyntaxKind.patternBindingList
744711
}
745712

746-
747713
/// ### Children
748714
///
749715
/// (``PrecedenceGroupRelationSyntax`` | ``PrecedenceGroupAssignmentSyntax`` | ``PrecedenceGroupAssociativitySyntax``) `*`
@@ -816,7 +782,6 @@ public struct PrecedenceGroupAttributeListSyntax: SyntaxCollection, SyntaxHashab
816782
public static let syntaxKind = SyntaxKind.precedenceGroupAttributeList
817783
}
818784

819-
820785
/// ### Children
821786
///
822787
/// ``PrecedenceGroupNameElementSyntax``*
@@ -835,7 +800,6 @@ public struct PrecedenceGroupNameListSyntax: SyntaxCollection, SyntaxHashable {
835800
public static let syntaxKind = SyntaxKind.precedenceGroupNameList
836801
}
837802

838-
839803
/// ### Children
840804
///
841805
/// ``PrimaryAssociatedTypeSyntax``*
@@ -941,7 +905,6 @@ public struct SpecializeAttributeSpecListSyntax: SyntaxCollection, SyntaxHashabl
941905
public static let syntaxKind = SyntaxKind.specializeAttributeSpecList
942906
}
943907

944-
945908
/// ### Children
946909
///
947910
/// (``StringSegmentSyntax`` | ``ExpressionSegmentSyntax``) `*`
@@ -1002,7 +965,6 @@ public struct StringLiteralSegmentsSyntax: SyntaxCollection, SyntaxHashable {
1002965
public static let syntaxKind = SyntaxKind.stringLiteralSegments
1003966
}
1004967

1005-
1006968
/// ### Children
1007969
///
1008970
/// (``SwitchCaseSyntax`` | ``IfConfigDeclSyntax``) `*`
@@ -1063,7 +1025,6 @@ public struct SwitchCaseListSyntax: SyntaxCollection, SyntaxHashable {
10631025
public static let syntaxKind = SyntaxKind.switchCaseList
10641026
}
10651027

1066-
10671028
/// ### Children
10681029
///
10691030
/// ``TupleExprElementSyntax``*
@@ -1082,7 +1043,6 @@ public struct TupleExprElementListSyntax: SyntaxCollection, SyntaxHashable {
10821043
public static let syntaxKind = SyntaxKind.tupleExprElementList
10831044
}
10841045

1085-
10861046
/// ### Children
10871047
///
10881048
/// ``TuplePatternElementSyntax``*
@@ -1101,7 +1061,6 @@ public struct TuplePatternElementListSyntax: SyntaxCollection, SyntaxHashable {
11011061
public static let syntaxKind = SyntaxKind.tuplePatternElementList
11021062
}
11031063

1104-
11051064
/// ### Children
11061065
///
11071066
/// ``TupleTypeElementSyntax``*
@@ -1140,7 +1099,6 @@ public struct UnexpectedNodesSyntax: SyntaxCollection, SyntaxHashable {
11401099
public static let syntaxKind = SyntaxKind.unexpectedNodes
11411100
}
11421101

1143-
11441102
/// ### Children
11451103
///
11461104
/// ``VersionComponentSyntax``*
@@ -1159,7 +1117,6 @@ public struct VersionComponentListSyntax: SyntaxCollection, SyntaxHashable {
11591117
public static let syntaxKind = SyntaxKind.versionComponentList
11601118
}
11611119

1162-
11631120
/// ### Children
11641121
///
11651122
/// ``YieldExprListElementSyntax``*

0 commit comments

Comments
 (0)