Skip to content

Commit d484a0d

Browse files
committed
Remove most of the occurrences of InternalCoroutinesApi from docs
1 parent f7d7034 commit d484a0d

File tree

1 file changed

+8
-0
lines changed
  • kotlinx-coroutines-core/common/src/selects

1 file changed

+8
-0
lines changed

kotlinx-coroutines-core/common/src/selects/Select.kt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,8 @@ public sealed interface SelectBuilder<in R> {
124124
* 4) the function that specifies how the internal result provided via
125125
* [SelectInstance.trySelect] or [SelectInstance.selectInRegistrationPhase]
126126
* should be processed in case of this `select` cancellation while dispatching.
127+
*
128+
* @suppress **This is unstable API, and it is subject to change.**
127129
*/
128130
@InternalCoroutinesApi
129131
public sealed interface SelectClause {
@@ -138,6 +140,8 @@ public sealed interface SelectClause {
138140
* the specified clause object. In case of channels, the registration logic
139141
* coincides with the plain `send/receive` operation with the only difference that
140142
* the `select` instance is stored as a waiter instead of continuation.
143+
*
144+
* @suppress **This is unstable API, and it is subject to change.**
141145
*/
142146
@InternalCoroutinesApi
143147
public typealias RegistrationFunction = (clauseObject: Any, select: SelectInstance<*>, param: Any?) -> Unit
@@ -147,6 +151,8 @@ public typealias RegistrationFunction = (clauseObject: Any, select: SelectInstan
147151
* or [SelectInstance.trySelect] should be processed. For example, both [ReceiveChannel.onReceive] and
148152
* [ReceiveChannel.onReceiveCatching] clauses perform exactly the same synchronization logic,
149153
* but differ when the channel has been discovered in the closed or cancelled state.
154+
*
155+
* @suppress **This is unstable API, and it is subject to change.**
150156
*/
151157
@InternalCoroutinesApi
152158
public typealias ProcessResultFunction = (clauseObject: Any, param: Any?, clauseResult: Any?) -> Any?
@@ -156,6 +162,8 @@ public typealias ProcessResultFunction = (clauseObject: Any, param: Any?, clause
156162
* or [SelectInstance.selectInRegistrationPhase], should be processed in case of this `select`
157163
* cancellation while dispatching. Unfortunately, we cannot pass this function only in [SelectInstance.trySelect],
158164
* as [SelectInstance.selectInRegistrationPhase] can be called when the coroutine is already cancelled.
165+
*
166+
* @suppress **This is unstable API, and it is subject to change.**
159167
*/
160168
@InternalCoroutinesApi
161169
public typealias OnCancellationConstructor = (select: SelectInstance<*>, param: Any?, internalResult: Any?) ->

0 commit comments

Comments
 (0)