[K/N] Update annotations documentation for the new MM

This commit is contained in:
Sergey Bogolepov
2022-08-25 16:42:55 +03:00
committed by Space
parent abed99bdb7
commit 2e22a5bd41
3 changed files with 12 additions and 14 deletions
@@ -1,5 +1,5 @@
/* /*
* Copyright 2010-2018 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license * Copyright 2010-2022 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license
* that can be found in the LICENSE file. * that can be found in the LICENSE file.
*/ */
@@ -10,14 +10,13 @@ import kotlin.experimental.ExperimentalObjCRefinement
import kotlin.reflect.KClass import kotlin.reflect.KClass
/** /**
* [SymbolName] annotation is deprecated and became internal. Please avoid using it. * [SymbolName] is a dangerous deprecated and internal annotation. Please avoid using it.
* It is dangerous when combined with the new experimental memory manager. *
* If you absolutely need to use the annotation, please comment at * If you absolutely need to use the annotation, please comment at
* [KT-46649](https://youtrack.jetbrains.com/issue/KT-46649). * [KT-46649](https://youtrack.jetbrains.com/issue/KT-46649).
*/ */
@RequiresOptIn( @RequiresOptIn(
message = "@SymbolName annotation is internal. " + message = "@SymbolName is dangerous deprecated and internal annotation. " +
"It is dangerous when combined with the new experimental memory manager. " +
"See https://youtrack.jetbrains.com/issue/KT-46649", "See https://youtrack.jetbrains.com/issue/KT-46649",
level = RequiresOptIn.Level.ERROR level = RequiresOptIn.Level.ERROR
) )
@@ -26,8 +25,8 @@ import kotlin.reflect.KClass
internal annotation class SymbolNameIsInternal internal annotation class SymbolNameIsInternal
/** /**
* This annotation is deprecated and became internal. Please avoid using it. * This is a dangerous deprecated and internal annotation. Please avoid using it.
* It is dangerous when combined with the new experimental memory manager. *
* If you absolutely need to use the annotation, please comment at * If you absolutely need to use the annotation, please comment at
* [KT-46649](https://youtrack.jetbrains.com/issue/KT-46649). * [KT-46649](https://youtrack.jetbrains.com/issue/KT-46649).
*/ */
@@ -1,5 +1,5 @@
/* /*
* Copyright 2010-2018 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license * Copyright 2010-2022 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license
* that can be found in the LICENSE file. * that can be found in the LICENSE file.
*/ */
@@ -20,17 +20,16 @@ package kotlin.native.concurrent
public actual annotation class ThreadLocal public actual annotation class ThreadLocal
/** /**
* Note: with the new MM this annotation has no effect. * Note: this annotation has effect only in Kotlin/Native with legacy memory manager.
* *
* Marks a top level property with a backing field as immutable. * Marks a top level property with a backing field as immutable.
* It is possible to share the value of such property 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.
* *
* Since 1.7.20 usage of this annotation is deprecated. See https://github.com/JetBrains/kotlin/blob/master/kotlin-native/NEW_MM.md#freezing-deprecation for details. * Since 1.7.20 usage of this annotation is deprecated.
* See https://github.com/JetBrains/kotlin/blob/master/kotlin-native/NEW_MM.md#freezing-deprecation for details.
*/ */
@Target(AnnotationTarget.PROPERTY) @Target(AnnotationTarget.PROPERTY)
@Retention(AnnotationRetention.BINARY) @Retention(AnnotationRetention.BINARY)
@@ -1,5 +1,5 @@
/* /*
* Copyright 2010-2018 JetBrains s.r.o. and Kotlin Programming Language contributors. * Copyright 2010-2022 JetBrains s.r.o. and Kotlin Programming Language contributors.
* Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file. * Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
*/ */
@@ -21,7 +21,7 @@ package kotlin.native.concurrent
public expect annotation class ThreadLocal() public expect annotation class ThreadLocal()
/** /**
* Note: with the new MM this annotation has no effect. * Note: this annotation has effect only in Kotlin/Native with legacy memory manager.
* *
* Marks a top level property with a backing field as immutable. * Marks a top level property with a backing field as immutable.
* It is possible to share the value of such property 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,