Skip to content

Commit 18bd544

Browse files
authored
Merge pull request #1599 from andrewjl/ajlb/enum-decl-node-description
SyntaxSupport Node Documentation: EnumDecl
2 parents 00b0ce7 + f251631 commit 18bd544

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

CodeGeneration/Sources/SyntaxSupport/DeclNodes.swift

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -666,33 +666,33 @@ public let DECL_NODES: [Node] = [
666666
Child(
667667
name: "Identifier",
668668
kind: .token(choices: [.token(tokenKind: "IdentifierToken")]),
669-
description: "The name of this enum."
669+
description: "Declares the name of this enum. If the name matches a reserved keyword use backticks to escape it."
670670
),
671671
Child(
672672
name: "GenericParameters",
673673
kind: .node(kind: "GenericParameterClause"),
674674
nameForDiagnostics: "generic parameter clause",
675-
description: "The generic parameters, if any, for this enum.",
675+
description: "The generic parameters, if any, for this enum declaration.",
676676
isOptional: true
677677
),
678678
Child(
679679
name: "InheritanceClause",
680680
kind: .node(kind: "TypeInheritanceClause"),
681681
nameForDiagnostics: "inheritance clause",
682-
description: "The inheritance clause describing conformances or raw values for this enum.",
682+
description: "The inheritance clause describing conformances or raw values for this enum declaration.",
683683
isOptional: true
684684
),
685685
Child(
686686
name: "GenericWhereClause",
687687
kind: .node(kind: "GenericWhereClause"),
688688
nameForDiagnostics: "generic where clause",
689-
description: "The `where` clause that applies to the generic parameters of this enum.",
689+
description: "The `where` clause that applies to the generic parameters of this enum declaration.",
690690
isOptional: true
691691
),
692692
Child(
693693
name: "MemberBlock",
694694
kind: .node(kind: "MemberDeclBlock"),
695-
description: "The cases and other members of this enum."
695+
description: "The cases and other members associated with this enum declaration. Because enum extension declarations may declare additional members the contents of this member block isn't guaranteed to be a complete list of members for this type."
696696
),
697697
]
698698
),

Sources/SwiftSyntax/generated/syntaxNodes/SyntaxDeclNodes.swift

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1868,7 +1868,7 @@ public struct EnumDeclSyntax: DeclSyntaxProtocol, SyntaxHashable {
18681868
}
18691869
}
18701870

1871-
/// The name of this enum.
1871+
/// Declares the name of this enum. If the name matches a reserved keyword use backticks to escape it.
18721872
public var identifier: TokenSyntax {
18731873
get {
18741874
return TokenSyntax(data.child(at: 7, parent: Syntax(self))!)
@@ -1887,7 +1887,7 @@ public struct EnumDeclSyntax: DeclSyntaxProtocol, SyntaxHashable {
18871887
}
18881888
}
18891889

1890-
/// The generic parameters, if any, for this enum.
1890+
/// The generic parameters, if any, for this enum declaration.
18911891
public var genericParameters: GenericParameterClauseSyntax? {
18921892
get {
18931893
return data.child(at: 9, parent: Syntax(self)).map(GenericParameterClauseSyntax.init)
@@ -1906,7 +1906,7 @@ public struct EnumDeclSyntax: DeclSyntaxProtocol, SyntaxHashable {
19061906
}
19071907
}
19081908

1909-
/// The inheritance clause describing conformances or raw values for this enum.
1909+
/// The inheritance clause describing conformances or raw values for this enum declaration.
19101910
public var inheritanceClause: TypeInheritanceClauseSyntax? {
19111911
get {
19121912
return data.child(at: 11, parent: Syntax(self)).map(TypeInheritanceClauseSyntax.init)
@@ -1925,7 +1925,7 @@ public struct EnumDeclSyntax: DeclSyntaxProtocol, SyntaxHashable {
19251925
}
19261926
}
19271927

1928-
/// The `where` clause that applies to the generic parameters of this enum.
1928+
/// The `where` clause that applies to the generic parameters of this enum declaration.
19291929
public var genericWhereClause: GenericWhereClauseSyntax? {
19301930
get {
19311931
return data.child(at: 13, parent: Syntax(self)).map(GenericWhereClauseSyntax.init)
@@ -1944,7 +1944,7 @@ public struct EnumDeclSyntax: DeclSyntaxProtocol, SyntaxHashable {
19441944
}
19451945
}
19461946

1947-
/// The cases and other members of this enum.
1947+
/// The cases and other members associated with this enum declaration. Because enum extension declarations may declare additional members the contents of this member block isn't guaranteed to be a complete list of members for this type.
19481948
public var memberBlock: MemberDeclBlockSyntax {
19491949
get {
19501950
return MemberDeclBlockSyntax(data.child(at: 15, parent: Syntax(self))!)

0 commit comments

Comments
 (0)