Rename UseExperimental->OptIn, Experimental->RequiresOptIn in stdlib kdocs

This commit is contained in:
Alexander Udalov
2019-12-27 16:35:13 +01:00
parent 7742a3b697
commit 8f94a2bb75
7 changed files with 14 additions and 14 deletions
@@ -167,8 +167,8 @@ public annotation class JsQualifier(val value: String)
* Note that behaviour of these annotations will likely be changed in the future.
*
* Usages of such annotations will be reported as warnings unless an explicit opt-in with
* the [UseExperimental] annotation, e.g. `@UseExperimental(ExperimentalJsExport::class)`,
* or with the `-Xuse-experimental=kotlin.js.ExperimentalJsExport` compiler option is given.
* the [OptIn] annotation, e.g. `@OptIn(ExperimentalJsExport::class)`,
* or with the `-Xopt-in=kotlin.js.ExperimentalJsExport` compiler option is given.
*/
@Experimental(level = Experimental.Level.WARNING)
@RequiresOptIn(level = RequiresOptIn.Level.WARNING)
@@ -11,8 +11,8 @@ import kotlin.annotation.AnnotationTarget.*
* with the future versions of the standard library.
*
* Any usage of a declaration annotated with `@ExperimentalStdlibApi` must be accepted either by
* annotating that usage with the [UseExperimental] annotation, e.g. `@UseExperimental(ExperimentalStdlibApi::class)`,
* or by using the compiler argument `-Xuse-experimental=kotlin.ExperimentalStdlibApi`.
* annotating that usage with the [OptIn] annotation, e.g. `@OptIn(ExperimentalStdlibApi::class)`,
* or by using the compiler argument `-Xopt-in=kotlin.ExperimentalStdlibApi`.
*/
@Experimental(level = Experimental.Level.ERROR)
@RequiresOptIn(level = RequiresOptIn.Level.ERROR)
@@ -13,8 +13,8 @@ import kotlin.internal.RequireKotlinVersionKind
* The experimental multiplatform support API marker.
*
* Any usage of a declaration annotated with `@ExperimentalMultiplatform` must be accepted either by
* annotating that usage with the [UseExperimental] annotation, e.g. `@UseExperimental(ExperimentalMultiplatform::class)`,
* or by using the compiler argument `-Xuse-experimental=kotlin.ExperimentalMultiplatform`.
* annotating that usage with the [OptIn] annotation, e.g. `@OptIn(ExperimentalMultiplatform::class)`,
* or by using the compiler argument `-Xopt-in=kotlin.ExperimentalMultiplatform`.
*/
@Experimental
@RequiresOptIn
@@ -13,8 +13,8 @@ import kotlin.internal.InlineOnly
* when declaring contracts of user functions.
*
* Any usage of a declaration annotated with `@ExperimentalContracts` must be accepted either by
* annotating that usage with the [UseExperimental] annotation, e.g. `@UseExperimental(ExperimentalContracts::class)`,
* or by using the compiler argument `-Xuse-experimental=kotlin.contracts.ExperimentalContracts`.
* annotating that usage with the [OptIn] annotation, e.g. `@OptIn(ExperimentalContracts::class)`,
* or by using the compiler argument `-Xopt-in=kotlin.contracts.ExperimentalContracts`.
*/
@Retention(AnnotationRetention.BINARY)
@SinceKotlin("1.3")
@@ -9,8 +9,8 @@ package kotlin.experimental
* The experimental marker for type inference augmenting annotations.
*
* Any usage of a declaration annotated with `@ExperimentalTypeInference` must be accepted either by
* annotating that usage with the [UseExperimental] annotation, e.g. `@UseExperimental(ExperimentalTypeInference::class)`,
* or by using the compiler argument `-Xuse-experimental=kotlin.experimental.ExperimentalTypeInference`.
* annotating that usage with the [OptIn] annotation, e.g. `@OptIn(ExperimentalTypeInference::class)`,
* or by using the compiler argument `-Xopt-in=kotlin.experimental.ExperimentalTypeInference`.
*/
@Experimental(level = Experimental.Level.ERROR)
@RequiresOptIn(level = RequiresOptIn.Level.ERROR)
@@ -15,8 +15,8 @@ import kotlin.annotation.AnnotationTarget.*
* with the future versions of the standard library.
*
* Any usage of a declaration annotated with `@ExperimentalTime` must be accepted either by
* annotating that usage with the [UseExperimental] annotation, e.g. `@UseExperimental(ExperimentalTime::class)`,
* or by using the compiler argument `-Xuse-experimental=kotlin.time.ExperimentalTime`.
* annotating that usage with the [OptIn] annotation, e.g. `@OptIn(ExperimentalTime::class)`,
* or by using the compiler argument `-Xopt-in=kotlin.time.ExperimentalTime`.
*/
@Experimental(level = Experimental.Level.ERROR)
@RequiresOptIn(level = RequiresOptIn.Level.ERROR)
@@ -14,8 +14,8 @@ import kotlin.internal.RequireKotlinVersionKind
* Marks the API that is dependent on the experimental unsigned types, including those types themselves.
*
* Usages of such API will be reported as warnings unless an explicit opt-in with
* the [UseExperimental] annotation, e.g. `@UseExperimental(ExperimentalUnsignedTypes::class)`,
* or with the `-Xuse-experimental=kotlin.ExperimentalUnsignedTypes` compiler option is given.
* the [OptIn] annotation, e.g. `@OptIn(ExperimentalUnsignedTypes::class)`,
* or with the `-Xopt-in=kotlin.ExperimentalUnsignedTypes` compiler option is given.
*
* It's recommended to propagate the experimental status to the API that depends on unsigned types by annotating it with this annotation.
*/