From a1979677d0a5562d3f7e45561636c28a70a0f16e Mon Sep 17 00:00:00 2001 From: Ilya Gorbunov Date: Fri, 14 Jun 2019 19:38:41 +0300 Subject: [PATCH] Docs: mark all experimental annotations as MustBeDocumented So that they are shown in the docs of annotated experimental API --- libraries/stdlib/src/kotlin/annotations/ExperimentalStdlibApi.kt | 1 + libraries/stdlib/src/kotlin/annotations/Multiplatform.kt | 1 + libraries/stdlib/src/kotlin/contracts/ContractBuilder.kt | 1 + libraries/stdlib/src/kotlin/experimental/inferenceMarker.kt | 1 + libraries/stdlib/unsigned/src/kotlin/annotations/Unsigned.kt | 1 + 5 files changed, 5 insertions(+) diff --git a/libraries/stdlib/src/kotlin/annotations/ExperimentalStdlibApi.kt b/libraries/stdlib/src/kotlin/annotations/ExperimentalStdlibApi.kt index 1bde5899db4..cd8994ec413 100644 --- a/libraries/stdlib/src/kotlin/annotations/ExperimentalStdlibApi.kt +++ b/libraries/stdlib/src/kotlin/annotations/ExperimentalStdlibApi.kt @@ -29,6 +29,7 @@ import kotlin.annotation.AnnotationTarget.* PROPERTY_SETTER, TYPEALIAS ) +@MustBeDocumented @ExperimentalStdlibApi @SinceKotlin("1.3") // TODO: Remove experimental status from itself and advance SinceKotlin to 1.4 public annotation class ExperimentalStdlibApi diff --git a/libraries/stdlib/src/kotlin/annotations/Multiplatform.kt b/libraries/stdlib/src/kotlin/annotations/Multiplatform.kt index 8d4735466a0..6eca1841ecb 100644 --- a/libraries/stdlib/src/kotlin/annotations/Multiplatform.kt +++ b/libraries/stdlib/src/kotlin/annotations/Multiplatform.kt @@ -17,6 +17,7 @@ import kotlin.internal.RequireKotlinVersionKind * or by using the compiler argument `-Xuse-experimental=kotlin.ExperimentalMultiplatform`. */ @Experimental +@MustBeDocumented @Target( CLASS, ANNOTATION_CLASS, diff --git a/libraries/stdlib/src/kotlin/contracts/ContractBuilder.kt b/libraries/stdlib/src/kotlin/contracts/ContractBuilder.kt index 6539e2f6c4f..4dfd339e449 100644 --- a/libraries/stdlib/src/kotlin/contracts/ContractBuilder.kt +++ b/libraries/stdlib/src/kotlin/contracts/ContractBuilder.kt @@ -19,6 +19,7 @@ import kotlin.internal.InlineOnly @Retention(AnnotationRetention.BINARY) @SinceKotlin("1.3") @Experimental +@MustBeDocumented public annotation class ExperimentalContracts /** diff --git a/libraries/stdlib/src/kotlin/experimental/inferenceMarker.kt b/libraries/stdlib/src/kotlin/experimental/inferenceMarker.kt index 32a8ebf7903..8e817fc601a 100644 --- a/libraries/stdlib/src/kotlin/experimental/inferenceMarker.kt +++ b/libraries/stdlib/src/kotlin/experimental/inferenceMarker.kt @@ -13,6 +13,7 @@ package kotlin.experimental * or by using the compiler argument `-Xuse-experimental=kotlin.experimental.ExperimentalTypeInference`. */ @Experimental(level = Experimental.Level.ERROR) +@MustBeDocumented @Retention(AnnotationRetention.BINARY) @Target(AnnotationTarget.ANNOTATION_CLASS) @SinceKotlin("1.3") diff --git a/libraries/stdlib/unsigned/src/kotlin/annotations/Unsigned.kt b/libraries/stdlib/unsigned/src/kotlin/annotations/Unsigned.kt index 871dc1d7de9..d73731f7298 100644 --- a/libraries/stdlib/unsigned/src/kotlin/annotations/Unsigned.kt +++ b/libraries/stdlib/unsigned/src/kotlin/annotations/Unsigned.kt @@ -20,6 +20,7 @@ import kotlin.internal.RequireKotlinVersionKind * It's recommended to propagate the experimental status to the API that depends on unsigned types by annotating it with this annotation. */ @Experimental(level = Experimental.Level.WARNING) +@MustBeDocumented @Target(CLASS, ANNOTATION_CLASS, PROPERTY, FIELD, LOCAL_VARIABLE, VALUE_PARAMETER, CONSTRUCTOR, FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER, TYPEALIAS) @Retention(AnnotationRetention.BINARY) @RequireKotlin("1.2.50", versionKind = RequireKotlinVersionKind.COMPILER_VERSION)