Avoid different wording from inherited and common docs

- AbstractMutableCollection.addAll
- kotlin.native.concurrent annotations
- kotlin.test annotations
This commit is contained in:
Ilya Gorbunov
2019-01-14 20:07:17 +03:00
committed by Pavel Punegov
parent af915726c3
commit 22f77134b0
3 changed files with 10 additions and 7 deletions
@@ -14,7 +14,7 @@ public actual abstract class AbstractMutableCollection<E> protected actual const
// Bulk Modification Operations // Bulk Modification Operations
/** /**
* Adds all of the elements in the specified collection to this collection. * Adds all of the elements of the specified collection to this collection.
* *
* @return `true` if any of the specified elements was added to the collection, `false` if the collection was not modified. * @return `true` if any of the specified elements was added to the collection, `false` if the collection was not modified.
*/ */
@@ -6,9 +6,10 @@
package kotlin.native.concurrent package kotlin.native.concurrent
/** /**
* Top level variable or object is thread local, and so could be mutable. * Marks a top level variable with a backing field or an object as thread local.
* One may use this annotation as the stopgap measure for singleton * The object remains mutable and it is possible to change its state,
* object immutability. * but every thread will have a distinct copy of this object,
* so changes in one thread are not reflected in another.
* *
* PLEASE NOTE THAT THIS ANNOTATION MAY GO AWAY IN UPCOMING RELEASES. * PLEASE NOTE THAT THIS ANNOTATION MAY GO AWAY IN UPCOMING RELEASES.
*/ */
@@ -17,7 +18,9 @@ package kotlin.native.concurrent
public actual annotation class ThreadLocal public actual annotation class ThreadLocal
/** /**
* Top level variable is immutable and so could be shared. * Marks a top level variable with a backing field or an object as immutable.
* It is possible to share such object 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.
* *
* PLEASE NOTE THAT THIS ANNOTATION MAY GO AWAY IN UPCOMING RELEASES. * PLEASE NOTE THAT THIS ANNOTATION MAY GO AWAY IN UPCOMING RELEASES.
*/ */
@@ -24,13 +24,13 @@ public annotation class BeforeClass
public annotation class AfterClass public annotation class AfterClass
/** /**
* Marks a function to be executed before a test. * Marks a function to be invoked before each test.
*/ */
@Target(AnnotationTarget.FUNCTION) @Target(AnnotationTarget.FUNCTION)
public actual annotation class BeforeTest public actual annotation class BeforeTest
/** /**
* Marks a function to be executed after a test. * Marks a function to be invoked after each test.
*/ */
@Target(AnnotationTarget.FUNCTION) @Target(AnnotationTarget.FUNCTION)
public actual annotation class AfterTest public actual annotation class AfterTest