azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix typos in coroutine docs as in the main kotlin repo (#2937)

Browse Source
This commit is contained in:
ilya-g
2019-05-02 11:21:11 +03:00
committed by Nikolay Igotti
parent 6eabe618da
commit 8e05ee478c
2 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
runtime/src/main/kotlin/kotlin/coroutines/experimental/Intrinsics.kt
+4 -4
View File
@@ -40,8 +40,8 @@ public actual fun <R, T> (suspend R.() -> T).createCoroutineUnchecked(
/** /**
* Starts unintercepted coroutine without receiver and with result type [T] and executes it until its first suspension. * Starts unintercepted coroutine without receiver and with result type [T] and executes it until its first suspension.
* Returns the result of the coroutine or throws its exception if it does not suspend or [COROUTINE_SUSPENDED] if it suspends. * Returns the result of the coroutine or throws its exception if it does not suspend or [COROUTINE_SUSPENDED] if it suspends.
* In the later case, the [completion] continuation is invoked when coroutine completes with result or exception. * In the latter case, the [completion] continuation is invoked when coroutine completes with result or exception.
* This function is designed to be used from inside of [suspendCoroutineOrReturn] to resume the execution of suspended * This function is designed to be used from inside of [suspendCoroutineOrReturn] to resume the execution of a suspended
* coroutine using a reference to the suspending function. * coroutine using a reference to the suspending function.
*/ */
@Suppress("UNCHECKED_CAST") @Suppress("UNCHECKED_CAST")
@@ -53,8 +53,8 @@ public actual inline fun <T> (suspend () -> T).startCoroutineUninterceptedOrRetu
/** /**
* Starts unintercepted coroutine with receiver type [R] and result type [T] and executes it until its first suspension. * Starts unintercepted coroutine with receiver type [R] and result type [T] and executes it until its first suspension.
* Returns the result of the coroutine or throws its exception if it does not suspend or [COROUTINE_SUSPENDED] if it suspends. * Returns the result of the coroutine or throws its exception if it does not suspend or [COROUTINE_SUSPENDED] if it suspends.
* In the later case, the [completion] continuation is invoked when coroutine completes with result or exception. * In the latter case, the [completion] continuation is invoked when coroutine completes with result or exception.
* This function is designed to be used from inside of [suspendCoroutineOrReturn] to resume the execution of suspended * This function is designed to be used from inside of [suspendCoroutineOrReturn] to resume the execution of a suspended
* coroutine using a reference to the suspending function. * coroutine using a reference to the suspending function.
*/ */
@Suppress("UNCHECKED_CAST") @Suppress("UNCHECKED_CAST")
runtime/src/main/kotlin/kotlin/coroutines/intrinsics/IntrinsicsNative.kt
+11 -11
View File
@@ -10,15 +10,15 @@ import kotlin.coroutines.native.internal.*
import kotlin.native.internal.* import kotlin.native.internal.*
/** /**
* Starts unintercepted coroutine without receiver and with result type [T] and executes it until its first suspension. * Starts an unintercepted coroutine without a receiver and with result type [T] and executes it until its first suspension.
* Returns the result of the coroutine or throws its exception if it does not suspend or [COROUTINE_SUSPENDED] if it suspends. * Returns the result of the coroutine or throws its exception if it does not suspend or [COROUTINE_SUSPENDED] if it suspends.
* In the later case, the [completion] continuation is invoked when coroutine completes with result or exception. * In the latter case, the [completion] continuation is invoked when the coroutine completes with a result or an exception.
* *
* The coroutine is started directly in the invoker's thread without going through the [ContinuationInterceptor] that might * The coroutine is started directly in the invoker's thread without going through the [ContinuationInterceptor] that might
* be present in the completion's [CoroutineContext]. It is invoker's responsibility to ensure that the proper invocation * be present in the completion's [CoroutineContext]. It is the invoker's responsibility to ensure that a proper invocation
* context is established. * context is established.
* *
* This function is designed to be used from inside of [suspendCoroutineUninterceptedOrReturn] to resume the execution of suspended * This function is designed to be used from inside of [suspendCoroutineUninterceptedOrReturn] to resume the execution of the suspended
* coroutine using a reference to the suspending function. * coroutine using a reference to the suspending function.
*/ */
@Suppress("UNCHECKED_CAST") @Suppress("UNCHECKED_CAST")
@@ -28,15 +28,15 @@ public actual inline fun <T> (suspend () -> T).startCoroutineUninterceptedOrRetu
): Any? = (this as Function1<Continuation<T>, Any?>).invoke(completion) ): Any? = (this as Function1<Continuation<T>, Any?>).invoke(completion)
/** /**
* Starts unintercepted coroutine with receiver type [R] and result type [T] and executes it until its first suspension. * Starts an unintercepted coroutine with receiver type [R] and result type [T] and executes it until its first suspension.
* Returns the result of the coroutine or throws its exception if it does not suspend or [COROUTINE_SUSPENDED] if it suspends. * Returns the result of the coroutine or throws its exception if it does not suspend or [COROUTINE_SUSPENDED] if it suspends.
* In the later case, the [completion] continuation is invoked when coroutine completes with result or exception. * In the latter case, the [completion] continuation is invoked when the coroutine completes with a result or an exception.
* *
* The coroutine is started directly in the invoker's thread without going through the [ContinuationInterceptor] that might * The coroutine is started directly in the invoker's thread without going through the [ContinuationInterceptor] that might
* be present in the completion's [CoroutineContext]. It is invoker's responsibility to ensure that the proper invocation * be present in the completion's [CoroutineContext]. It is the invoker's responsibility to ensure that a proper invocation
* context is established. * context is established.
* *
* This function is designed to be used from inside of [suspendCoroutineUninterceptedOrReturn] to resume the execution of suspended * This function is designed to be used from inside of [suspendCoroutineUninterceptedOrReturn] to resume the execution of the suspended
* coroutine using a reference to the suspending function. * coroutine using a reference to the suspending function.
*/ */
@Suppress("UNCHECKED_CAST") @Suppress("UNCHECKED_CAST")
@@ -59,7 +59,7 @@ private object CoroutineSuspendedMarker
* This function returns unintercepted continuation. * This function returns unintercepted continuation.
* Invocation of `resume(Unit)` starts coroutine immediately in the invoker's call stack without going through the * Invocation of `resume(Unit)` starts coroutine immediately in the invoker's call stack without going through the
* [ContinuationInterceptor] that might be present in the completion's [CoroutineContext]. * [ContinuationInterceptor] that might be present in the completion's [CoroutineContext].
* It is invoker's responsibility to ensure that the proper invocation context is established. * It is the invoker's responsibility to ensure that a proper invocation context is established.
* Note that [completion] of this function may get invoked in an arbitrary context. * Note that [completion] of this function may get invoked in an arbitrary context.
* *
* [Continuation.intercepted] can be used to acquire the intercepted continuation. * [Continuation.intercepted] can be used to acquire the intercepted continuation.
@@ -94,7 +94,7 @@ public actual fun <T> (suspend () -> T).createCoroutineUnintercepted(
* This function returns unintercepted continuation. * This function returns unintercepted continuation.
* Invocation of `resume(Unit)` starts coroutine immediately in the invoker's call stack without going through the * Invocation of `resume(Unit)` starts coroutine immediately in the invoker's call stack without going through the
* [ContinuationInterceptor] that might be present in the completion's [CoroutineContext]. * [ContinuationInterceptor] that might be present in the completion's [CoroutineContext].
* It is invoker's responsibility to ensure that the proper invocation context is established. * It is the invoker's responsibility to ensure that a proper invocation context is established.
* Note that [completion] of this function may get invoked in an arbitrary context. * Note that [completion] of this function may get invoked in an arbitrary context.
* *
* [Continuation.intercepted] can be used to acquire the intercepted continuation. * [Continuation.intercepted] can be used to acquire the intercepted continuation.
@@ -126,7 +126,7 @@ public actual fun <R, T> (suspend R.() -> T).createCoroutineUnintercepted(
* *
* This function shall be used on the immediate result of [createCoroutineUnintercepted] or [suspendCoroutineUninterceptedOrReturn], * This function shall be used on the immediate result of [createCoroutineUnintercepted] or [suspendCoroutineUninterceptedOrReturn],
* in which case it checks for [ContinuationInterceptor] in the continuation's [context][Continuation.context], * in which case it checks for [ContinuationInterceptor] in the continuation's [context][Continuation.context],
* invokes [ContinuationInterceptor.interceptContinuation], caches and returns result. * invokes [ContinuationInterceptor.interceptContinuation], caches and returns the result.
* *
* If this function is invoked on other [Continuation] instances it returns `this` continuation unchanged. * If this function is invoked on other [Continuation] instances it returns `this` continuation unchanged.
*/ */