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

Docs: mark all experimental annotations as MustBeDocumented

Browse Source 
So that they are shown in the docs of annotated experimental API
This commit is contained in:
Ilya Gorbunov
2019-06-14 19:38:41 +03:00
parent a55563f5ec
commit a1979677d0
5 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libraries/stdlib/src/kotlin/annotations/ExperimentalStdlibApi.kt
+1
View File
@@ -29,6 +29,7 @@ import kotlin.annotation.AnnotationTarget.*
PROPERTY_SETTER, PROPERTY_SETTER,
TYPEALIAS TYPEALIAS
) )
@MustBeDocumented
@ExperimentalStdlibApi @ExperimentalStdlibApi
@SinceKotlin("1.3") // TODO: Remove experimental status from itself and advance SinceKotlin to 1.4 @SinceKotlin("1.3") // TODO: Remove experimental status from itself and advance SinceKotlin to 1.4
public annotation class ExperimentalStdlibApi public annotation class ExperimentalStdlibApi
libraries/stdlib/src/kotlin/annotations/Multiplatform.kt
+1
View File
@@ -17,6 +17,7 @@ import kotlin.internal.RequireKotlinVersionKind
* or by using the compiler argument `-Xuse-experimental=kotlin.ExperimentalMultiplatform`. * or by using the compiler argument `-Xuse-experimental=kotlin.ExperimentalMultiplatform`.
*/ */
@Experimental @Experimental
@MustBeDocumented
@Target( @Target(
CLASS, CLASS,
ANNOTATION_CLASS, ANNOTATION_CLASS,
libraries/stdlib/src/kotlin/contracts/ContractBuilder.kt
+1
View File
@@ -19,6 +19,7 @@ import kotlin.internal.InlineOnly
@Retention(AnnotationRetention.BINARY) @Retention(AnnotationRetention.BINARY)
@SinceKotlin("1.3") @SinceKotlin("1.3")
@Experimental @Experimental
@MustBeDocumented
public annotation class ExperimentalContracts public annotation class ExperimentalContracts
/** /**
libraries/stdlib/src/kotlin/experimental/inferenceMarker.kt
+1
View File
@@ -13,6 +13,7 @@ package kotlin.experimental
* or by using the compiler argument `-Xuse-experimental=kotlin.experimental.ExperimentalTypeInference`. * or by using the compiler argument `-Xuse-experimental=kotlin.experimental.ExperimentalTypeInference`.
*/ */
@Experimental(level = Experimental.Level.ERROR) @Experimental(level = Experimental.Level.ERROR)
@MustBeDocumented
@Retention(AnnotationRetention.BINARY) @Retention(AnnotationRetention.BINARY)
@Target(AnnotationTarget.ANNOTATION_CLASS) @Target(AnnotationTarget.ANNOTATION_CLASS)
@SinceKotlin("1.3") @SinceKotlin("1.3")
libraries/stdlib/unsigned/src/kotlin/annotations/Unsigned.kt
+1
View File
@@ -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. * 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) @Experimental(level = Experimental.Level.WARNING)
@MustBeDocumented
@Target(CLASS, ANNOTATION_CLASS, PROPERTY, FIELD, LOCAL_VARIABLE, VALUE_PARAMETER, CONSTRUCTOR, FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER, TYPEALIAS) @Target(CLASS, ANNOTATION_CLASS, PROPERTY, FIELD, LOCAL_VARIABLE, VALUE_PARAMETER, CONSTRUCTOR, FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER, TYPEALIAS)
@Retention(AnnotationRetention.BINARY) @Retention(AnnotationRetention.BINARY)
@RequireKotlin("1.2.50", versionKind = RequireKotlinVersionKind.COMPILER_VERSION) @RequireKotlin("1.2.50", versionKind = RequireKotlinVersionKind.COMPILER_VERSION)