Skip to content

Commit 3be98d7

Browse files
authored
Merge pull request #20012 from gottesmm/pr-889af4d7ba27131cd9a3db17af6506915e103bfa
[sil] Improve comments on macro definitions in SILNodes.def.
2 parents 1d551cb + f41f75c commit 3be98d7

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

include/swift/SIL/SILNodes.def

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@
7575
#define NODE(ID, PARENT)
7676
#endif
7777

78-
/// SINGLE_VALUE_INST(Id, Parent, TextualName, MemBehavior, MayRelease)
78+
/// SINGLE_VALUE_INST(ID, TEXTUALNAME, PARENT, MEMBEHAVIOR, MAYRELEASE)
7979
///
8080
/// A concrete subclass of SingleValueInstruction, which inherits from
8181
/// both ValueBase and SILInstruction. ID is a member of both ValueKind
@@ -90,6 +90,11 @@
9090
#endif
9191
#endif
9292

93+
/// APPLYSITE_SINGLE_VALUE_INST(ID, TEXTUALNAME, PARENT, MEMBEHAVIOR,
94+
/// MAYRELEASE)
95+
///
96+
/// A SINGLE_VALUE_INST that is a partial or full apply site. ID is a member
97+
/// of ApplySiteKind.
9398
#ifndef APPLYSITE_SINGLE_VALUE_INST
9499
#ifdef APPLYSITE_INST
95100
#define APPLYSITE_SINGLE_VALUE_INST(ID, NAME, PARENT, MEMBEHAVIOR, MAYRELEASE) \
@@ -100,6 +105,11 @@
100105
#endif
101106
#endif
102107

108+
/// FULLAPPLYSITE_SINGLE_VALUE_INST(ID, TEXTUALNAME, PARENT, MEMBEHAVIOR,
109+
/// MAYRELEASE)
110+
///
111+
/// A SINGLE_VALUE_INST that is a full apply site. ID is a member of
112+
/// FullApplySiteKind and ApplySiteKind.
103113
#ifndef FULLAPPLYSITE_SINGLE_VALUE_INST
104114
#ifdef FULLAPPLYSITE_INST
105115
#define FULLAPPLYSITE_SINGLE_VALUE_INST(ID, NAME, PARENT, MEMBEHAVIOR, MAYRELEASE) \
@@ -120,6 +130,11 @@
120130
FULL_INST(ID, NAME, PARENT, MEMBEHAVIOR, MAYRELEASE)
121131
#endif
122132

133+
/// APPLYSITE_MULTIPLE_VALUE_INST(ID, TEXTUALNAME, PARENT, MEMBEHAVIOR,
134+
/// MAYRELEASE)
135+
///
136+
/// A MULTIPLE_VALUE_INST that is additionally either a partial or full apply
137+
/// site. ID is a member of ApplySiteKind.
123138
#ifndef APPLYSITE_MULTIPLE_VALUE_INST
124139
#ifdef APPLYSITE_INST
125140
#define APPLYSITE_MULTIPLE_VALUE_INST(ID, NAME, PARENT, MEMBEHAVIOR, MAYRELEASE) \
@@ -130,6 +145,11 @@
130145
#endif
131146
#endif
132147

148+
/// FULLAPPLYSITE_MULTIPLE_VALUE_INST(ID, TEXTUALNAME, PARENT, MEMBEHAVIOR,
149+
/// MAYRELEASE)
150+
///
151+
/// A MULTIPLE_VALUE_INST that is additionally a full apply site. ID is a
152+
/// member of FullApplySiteKind and ApplySiteKind.
133153
#ifndef FULLAPPLYSITE_MULTIPLE_VALUE_INST
134154
#ifdef FULLAPPLYSITE_INST
135155
#define FULLAPPLYSITE_MULTIPLE_VALUE_INST(ID, NAME, PARENT, MEMBEHAVIOR, MAYRELEASE) \

0 commit comments

Comments
 (0)