Skip to content

Commit c1ddeb2

Browse files
committed
[gardening] Add some comments to SILIsolationInfo's header file.
1 parent bd4827f commit c1ddeb2

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

include/swift/SILOptimizer/Utils/SILIsolationInfo.h

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,15 +140,26 @@ class ActorInstance {
140140
/// matching.
141141
class SILIsolationInfo {
142142
public:
143-
/// The lattice is:
143+
/// This forms a lattice of semantics. The lattice progresses from left ->
144+
/// right below:
144145
///
145146
/// Unknown -> Disconnected -> TransferringParameter -> Task -> Actor.
146147
///
147-
/// Unknown means no information. We error when merging on it.
148148
enum Kind : uint8_t {
149+
/// Unknown means no information. We error when merging on it.
149150
Unknown,
151+
152+
/// An entity with disconnected isolation can be freely transferred into
153+
/// another isolation domain. These are associated with "use after transfer"
154+
/// diagnostics.
150155
Disconnected,
156+
157+
/// An entity that is in the same region as a task-isolated value. Cannot be
158+
/// sent into another isolation domain.
151159
Task,
160+
161+
/// An entity that is in the same region as an actor-isolated value. Cannot
162+
/// be sent into another isolation domain.
152163
Actor,
153164
};
154165

0 commit comments

Comments
 (0)