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

Correct docs of ThreadLocal and SharedImmutable annotations

Browse Source 
- clarify that they have effect only in K/N
- correct possible application targets of SharedImmutable

KT-36245
This commit is contained in:
Ilya Gorbunov
2020-05-23 22:28:46 +03:00
parent dae7a23998
commit 22c4d30a89
1 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libraries/stdlib/common/src/kotlin/NativeAnnotationsH.kt
+7 -3
View File
@@ -6,11 +6,13 @@
package kotlin.native.concurrent package kotlin.native.concurrent
/** /**
* Marks a top level variable with a backing field or an object as thread local. * Marks a top level property with a backing field or an object as thread local.
* The object remains mutable and it is possible to change its state, * The object remains mutable and it is possible to change its state,
* but every thread will have a distinct copy of this object, * but every thread will have a distinct copy of this object,
* so changes in one thread are not reflected in another. * so changes in one thread are not reflected in another.
* *
* The annotation has effect only in Kotlin/Native platform.
*
* PLEASE NOTE THAT THIS ANNOTATION MAY GO AWAY IN UPCOMING RELEASES. * PLEASE NOTE THAT THIS ANNOTATION MAY GO AWAY IN UPCOMING RELEASES.
*/ */
@Target(AnnotationTarget.PROPERTY, AnnotationTarget.CLASS) @Target(AnnotationTarget.PROPERTY, AnnotationTarget.CLASS)
@@ -19,10 +21,12 @@ package kotlin.native.concurrent
public expect annotation class ThreadLocal() public expect annotation class ThreadLocal()
/** /**
* Marks a top level variable with a backing field or an object as immutable. * Marks a top level property with a backing field as immutable.
* It is possible to share such object between multiple threads, but it becomes deeply frozen, * It is possible to share the value of such property between multiple threads, but it becomes deeply frozen,
* so no changes can be made to its state or the state of objects it refers to. * so no changes can be made to its state or the state of objects it refers to.
* *
* The annotation has effect only in Kotlin/Native platform.
*
* PLEASE NOTE THAT THIS ANNOTATION MAY GO AWAY IN UPCOMING RELEASES. * PLEASE NOTE THAT THIS ANNOTATION MAY GO AWAY IN UPCOMING RELEASES.
*/ */
@Target(AnnotationTarget.PROPERTY) @Target(AnnotationTarget.PROPERTY)