Skip to content

Commit 59ab6e8

Browse files
authored
Tidy up @InternalCoroutinesApi documentation (#4086)
* @suppresses where necessary until Kotlin/dokka#1861 is fixed * Add @MustBeDocumented in case if it's leaked into public documentation
1 parent 2bf5930 commit 59ab6e8

File tree

4 files changed

+8
-0
lines changed

4 files changed

+8
-0
lines changed

kotlinx-coroutines-core/common/src/Annotations.kt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ public annotation class ObsoleteCoroutinesApi
8080
* `kotlinx.coroutines`, because their signatures and semantics will change between future releases without any
8181
* warnings and without providing any migration aids.
8282
*/
83+
@MustBeDocumented
8384
@Retention(value = AnnotationRetention.BINARY)
8485
@Target(AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.TYPEALIAS, AnnotationTarget.PROPERTY)
8586
@RequiresOptIn(

kotlinx-coroutines-core/common/src/CoroutineExceptionHandler.kt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ import kotlin.coroutines.*
1111
* If there is [CoroutineExceptionHandler] in the context, then it is used. If it throws an exception during handling
1212
* or is absent, all instances of [CoroutineExceptionHandler] found via [ServiceLoader] and
1313
* [Thread.uncaughtExceptionHandler] are invoked.
14+
*
15+
* @suppress **This is internal API and it is subject to change.**
1416
*/
1517
@InternalCoroutinesApi
1618
public fun handleCoroutineException(context: CoroutineContext, exception: Throwable) {

kotlinx-coroutines-core/common/src/channels/Channel.kt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -475,6 +475,9 @@ public value class ChannelResult<out T>
475475
override fun toString(): String = "Closed($cause)"
476476
}
477477

478+
/**
479+
* @suppress **This is internal API and it is subject to change.**
480+
*/
478481
@InternalCoroutinesApi
479482
public companion object {
480483
private val failed = Failed()

kotlinx-coroutines-core/common/src/intrinsics/Cancellable.kt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ import kotlin.coroutines.intrinsics.*
88
/**
99
* Use this function to start coroutine in a cancellable way, so that it can be cancelled
1010
* while waiting to be dispatched.
11+
*
12+
* @suppress **This is internal API and it is subject to change.**
1113
*/
1214
@InternalCoroutinesApi
1315
public fun <T> (suspend () -> T).startCoroutineCancellable(completion: Continuation<T>): Unit = runSafely(completion) {

0 commit comments

Comments
 (0)