Skip to content

Commit fc7a9a2

Browse files
committed
Suppress deprecated and internal APIs from docs
1 parent f024608 commit fc7a9a2

File tree

6 files changed

+10
-8
lines changed

6 files changed

+10
-8
lines changed

kotlinx-coroutines-core/src/main/kotlin/kotlinx/coroutines/experimental/CoroutineContext.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ public object Unconfined : CoroutineDispatcher() {
4646
}
4747

4848
/**
49-
* **Deprecated**: `Here` was renamed to `Unconfined`.
49+
* @suppress **Deprecated**: `Here` was renamed to `Unconfined`.
5050
*/
5151
@Deprecated(message = "`Here` was renamed to `Unconfined`",
5252
replaceWith = ReplaceWith(expression = "Unconfined"))

kotlinx-coroutines-core/src/main/kotlin/kotlinx/coroutines/experimental/CoroutineDispatcher.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ public abstract class CoroutineDispatcher :
8181
DispatchedContinuation(this, continuation)
8282

8383
/**
84-
* **Error**: Operator '+' on two CoroutineDispatcher objects is meaningless.
84+
* @suppress **Error**: Operator '+' on two CoroutineDispatcher objects is meaningless.
8585
* CoroutineDispatcher is a coroutine context element and `+` is a set-sum operator for coroutine contexts.
8686
* The dispatcher to the right of `+` just replaces the dispatcher the left of `+`.
8787
*/

kotlinx-coroutines-core/src/main/kotlin/kotlinx/coroutines/experimental/Deferred.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ public interface Deferred<out T> : Job {
7575
public fun getCompleted(): T
7676

7777
/**
78-
* **Deprecated**: Use `isActive`.
78+
* @suppress **Deprecated**: Use `isActive`.
7979
*/
8080
@Deprecated(message = "Use `isActive`", replaceWith = ReplaceWith("isActive"))
8181
public val isComputing: Boolean get() = isActive
@@ -108,7 +108,7 @@ public fun <T> async(context: CoroutineContext, start: Boolean = true, block: su
108108
}
109109

110110
/**
111-
* **Deprecated**: `defer` was renamed to `async`.
111+
* @suppress **Deprecated**: `defer` was renamed to `async`.
112112
*/
113113
@Deprecated(message = "`defer` was renamed to `async`", level = DeprecationLevel.WARNING,
114114
replaceWith = ReplaceWith("async(context, block = block)"))

kotlinx-coroutines-core/src/main/kotlin/kotlinx/coroutines/experimental/Job.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ public interface Job : CoroutineContext.Element {
129129
public fun cancel(cause: Throwable? = null): Boolean
130130

131131
/**
132-
* **Error**: Operator '+' on two Job objects is meaningless.
132+
* @suppress **Error**: Operator '+' on two Job objects is meaningless.
133133
* Job is a coroutine context element and `+` is a set-sum operator for coroutine contexts.
134134
* The job to the right of `+` just replaces the job the left of `+`.
135135
*/
@@ -192,7 +192,7 @@ public fun Job.removeOnCompletion(node: LockFreeLinkedListNode): Job.Registratio
192192
onCompletion(RemoveOnCompletion(this, node))
193193

194194
/**
195-
* **Deprecated**: `join` is now a member function of `Job`.
195+
* @suppress **Deprecated**: `join` is now a member function of `Job`.
196196
*/
197197
@Suppress("EXTENSION_SHADOWED_BY_MEMBER", "DeprecatedCallableAddReplaceWith")
198198
@Deprecated(message = "`join` is now a member function of `Job`")

kotlinx-coroutines-core/src/main/kotlin/kotlinx/coroutines/experimental/LazyDeferred.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ package kotlinx.coroutines.experimental
1919
import kotlin.coroutines.experimental.CoroutineContext
2020

2121
/**
22-
* **Deprecated**: `Deferred` incorporates functionality of `LazyDeferred`. See [Deferred].
22+
* @suppress **Deprecated**: `Deferred` incorporates functionality of `LazyDeferred`. See [Deferred].
2323
*/
2424
@Deprecated(message = "`Deferred` incorporates functionality of `LazyDeferred`", level = DeprecationLevel.WARNING,
2525
replaceWith = ReplaceWith("Deferred"))
2626
typealias LazyDeferred<T> = Deferred<T>
2727

2828
/**
29-
* **Deprecated**: Replace with `async(context, start = false) { ... }`. See [async].
29+
* @suppress **Deprecated**: Replace with `async(context, start = false) { ... }`. See [async].
3030
*/
3131
@Deprecated(message = "This functionality is incorporated into `async", level = DeprecationLevel.WARNING,
3232
replaceWith = ReplaceWith("async(context, start = false, block = block)"))

kotlinx-coroutines-core/src/main/kotlin/kotlinx/coroutines/experimental/intrinsics/Intrinsics.kt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ import kotlin.coroutines.experimental.intrinsics.COROUTINE_SUSPENDED
2424
* This function creates and start a new, fresh instance of suspendable computation every time it is invoked.
2525
* If the coroutine never suspends, then its result is returned directly,
2626
* otherwise it returns [COROUTINE_SUSPENDED] and the [completion] continuation is invoked when coroutine completes.
27+
*
28+
* @suppress **This is unstable API and it is subject to change.**
2729
*/
2830
@Suppress("PLATFORM_CLASS_MAPPED_TO_KOTLIN", "UNCHECKED_CAST")
2931
public fun <T> (suspend () -> T).startCoroutineOrReturn(completion: Continuation<T>): Any? =

0 commit comments

Comments
 (0)