From 75e2dfda19d234cfc2acb67160aab78aae9b1985 Mon Sep 17 00:00:00 2001 From: Roman Elizarov Date: Tue, 4 Dec 2018 09:46:32 +0300 Subject: [PATCH] Added COROUTINE_SUSPENDED docs Fixes KT-28488 --- .../stdlib/src/kotlin/coroutines/intrinsics/Intrinsics.kt | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/libraries/stdlib/src/kotlin/coroutines/intrinsics/Intrinsics.kt b/libraries/stdlib/src/kotlin/coroutines/intrinsics/Intrinsics.kt index fedbd913ac5..c5193b10a2a 100644 --- a/libraries/stdlib/src/kotlin/coroutines/intrinsics/Intrinsics.kt +++ b/libraries/stdlib/src/kotlin/coroutines/intrinsics/Intrinsics.kt @@ -43,6 +43,11 @@ public suspend inline fun suspendCoroutineUninterceptedOrReturn(crossinline /** * This value is used as a return value of [suspendCoroutineUninterceptedOrReturn] `block` argument to state that * the execution was suspended and will not return any result immediately. + * + * **Note: this value should not be used in general code.** Using it outside of the context of + * `suspendCoroutineUninterceptedOrReturn` function return value (including, but not limited to, + * storing this value in other properties, returning it from other functions, etc) + * can lead to unspecified behavior of the code. */ // It is implemented as property with getter to avoid ProGuard problem with multifile IntrinsicsKt class @SinceKotlin("1.3")