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

Improve @PublishedApi annotation docs #KT-19881

Browse Source
This commit is contained in:
Ilya Gorbunov
2017-09-06 19:52:51 +03:00
parent 78b1fb2e93
commit 980feffffa
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
core/builtins/src/kotlin/Annotations.kt
+9 -1
View File
@@ -130,7 +130,15 @@ public annotation class DslMarker
/** /**
* Specifies that this part of internal API is effectively public exposed by using in public inline function * When applied to a class or a member with internal visibility allows to use it from public inline functions and
* makes it effectively public.
*
* Public inline functions cannot use non-public API, since if they are inlined, those non-public API references
* would violate access restrictions at a call site (http://kotlinlang.org/docs/reference/inline-functions.html#public-inline-restrictions).
*
* To overcome this restriction an `internal` declaration can be annotated with the `@PublishedApi` annotation:
* - this allows to call that declaration from public inline functions;
* - the declaration becomes effectively public, and this should be considered with respect to binary compatibility maintaining.
*/ */
@Target(AnnotationTarget.CLASS, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY) @Target(AnnotationTarget.CLASS, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY)
@Retention(AnnotationRetention.BINARY) @Retention(AnnotationRetention.BINARY)