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

Standard annotations: must be documented

Browse Source
This commit is contained in:
Mikhail Glukhikh
2015-08-05 13:50:33 +03:00
parent 5b31560808
commit bd3b5690a2
8 changed files with 26 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libraries/stdlib/src/kotlin/jvm/JvmFlagAnnotations.kt
+5 -5
View File
@@ -23,14 +23,14 @@ import kotlin.annotation.AnnotationTarget.*
* are immediately made visible to other threads.
*/
target(PROPERTY, FIELD)
public annotation(retention = AnnotationRetention.SOURCE) class volatile
public annotation(retention = AnnotationRetention.SOURCE, mustBeDocumented = true) class volatile
/**
* Marks the JVM backing field of the annotated property as `transient`, meaning that it is not
* part of the default serialized form of the object.
*/
target(PROPERTY, FIELD)
public annotation(retention = AnnotationRetention.SOURCE) class transient
public annotation(retention = AnnotationRetention.SOURCE, mustBeDocumented = true) class transient
/**
* Marks the JVM method generated from the annotated function as `strictfp`, meaning that the precision
@@ -38,7 +38,7 @@ public annotation(retention = AnnotationRetention.SOURCE) class transient
* achieve better portability.
*/
target(FUNCTION, CONSTRUCTOR, PROPERTY, PROPERTY_GETTER, PROPERTY_SETTER, CLASSIFIER)
public annotation(retention = AnnotationRetention.SOURCE) class strictfp
public annotation(retention = AnnotationRetention.SOURCE, mustBeDocumented = true) class strictfp
/**
* Marks the JVM method generated from the annotated function as `synchronized`, meaning that the method
@@ -46,11 +46,11 @@ public annotation(retention = AnnotationRetention.SOURCE) class strictfp
* for static methods, the class) on which the method is defined.
*/
target(FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER)
public annotation(retention = AnnotationRetention.SOURCE) class synchronized
public annotation(retention = AnnotationRetention.SOURCE, mustBeDocumented = true) class synchronized
/**
* Marks the JVM method generated from the annotated function as `native`, meaning that it's not implemented
* in Java but rather in a different language (for example, in C/C++ using JNI).
*/
target(FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER)
public annotation(retention = AnnotationRetention.SOURCE) class native
public annotation(retention = AnnotationRetention.SOURCE, mustBeDocumented = true) class native
libraries/stdlib/src/kotlin/jvm/JvmPlatformAnnotations.kt
+2 -2
View File
@@ -23,10 +23,10 @@ package kotlin.jvm
* takes N-1 parameters (all but the last one that takes a default value), the second takes N-2 parameters, and so on.
*/
target(AnnotationTarget.FUNCTION, AnnotationTarget.CONSTRUCTOR)
public annotation(retention = AnnotationRetention.BINARY) class jvmOverloads
public annotation(retention = AnnotationRetention.BINARY, mustBeDocumented = true) class jvmOverloads
/**
* Instructs the Kotlin compiler to generate a public backing field for this property.
*/
target(AnnotationTarget.PROPERTY)
public annotation(retention = AnnotationRetention.SOURCE) class publicField
public annotation(retention = AnnotationRetention.SOURCE, mustBeDocumented = true) class publicField
libraries/stdlib/src/kotlin/platform/annotations.kt
+2 -2
View File
@@ -26,7 +26,7 @@ import kotlin.annotation.AnnotationTarget.*
* @property name the name of the element.
*/
target(FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER)
public annotation(retention = AnnotationRetention.RUNTIME) class platformName(public val name: String)
public annotation(retention = AnnotationRetention.RUNTIME, mustBeDocumented = true) class platformName(public val name: String)
/**
* Specifies that a static method or field needs to be generated from this element.
@@ -34,4 +34,4 @@ public annotation(retention = AnnotationRetention.RUNTIME) class platformName(pu
* for more information.
*/
target(FUNCTION, PROPERTY, FIELD, PROPERTY_GETTER, PROPERTY_SETTER)
public annotation(retention = AnnotationRetention.RUNTIME) class platformStatic
public annotation(retention = AnnotationRetention.RUNTIME, mustBeDocumented = true) class platformStatic