MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-09-27 10:03:11 +07:00
Code Issues Packages Projects Releases Wiki Activity

ApiStatus: clarify Javadoc on how Experimental and Internal annotations are propagated to members.

Browse Source 
GitOrigin-RevId: c1598acaf95b1f92c1da564cc6b941d37b5fdfcc
This commit is contained in:
Sergey Patrikeev
2019-10-02 14:03:13 +00:00
committed by intellij-monorepo-bot
parent 13d9be710f
commit b92cbd4bad
1 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
platform/util/src/org/jetbrains/annotations/ApiStatus.java
+14
View File
@@ -14,6 +14,13 @@ public final class ApiStatus {
*
* <p>It's safe to use an element marked with this annotation if the usage is located in the same sources codebase as the declaration. However,
* if the declaration belongs to an external library such usages may lead to problems when the library will be updated to another version.</p>
*
* <p>If a package is marked with this annotation, all its containing classes are considered experimental.
* Subpackages of this package are not affected and should be marked independently.</p>
*
* <p>If a type is marked with this annotation, all its members are considered experimental, but its inheritors are not.</p>
*
* <p>If a method is marked with this annotation, overriding methods are not considered experimental.</p>
*/
@Documented
@Retention(RetentionPolicy.CLASS)
@@ -26,6 +33,13 @@ public final class ApiStatus {
* Indicates that the annotated element (class, method, field, etc) must not be considered as a public API. It's made visible to allow
* usages in other packages of the declaring module, but it must not be used outside of that module. Such elements
* may be renamed, changed or removed in future versions.
*
* <p>If a package is marked with this annotation, all its containing classes are considered internal.
* Subpackages of this package are not affected and should be marked independently.</p>
*
* <p>If a type is marked with this annotation, all its members are considered internal, but its inheritors are not.</p>
*
* <p>If a method is marked with this annotation, overriding methods are not considered internal.</p>
*/
@Documented
@Retention(RetentionPolicy.CLASS)