Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow different API status on members (#24) #26

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Allow different API status on members (#24) #26

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions src/main/java/org/apiguardian/api/API.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,17 @@
*
* <p>If {@code @API} is present on a type, it is considered to hold for all
* public members of the type as well. However, a member of such an annotated
* type is allowed to declare a {@link Status} of lower stability. For example,
* type is allowed to declare a {@link Status} of different stability. For example,
* a class annotated with {@code @API(status = STABLE)} may declare a constructor
* for internal usage that is annotated with {@code @API(status = INTERNAL)}.
* for internal usage that is annotated with {@code @API(status = INTERNAL)}. On
* the other hand, a class that implements a step in the middle of a fluent API
* call chain may be annotated with {@code @API(status = INTERNAL)} ("don't rely
* on the name of this class"), but its methods may be annotated with
* {@code @API(status = STABLE)} ("you can rely on this method being available
* here").
*
* <p>If {@code @API} is present on a package, it is considered to hold for all
* public types in its package. The same rules for lowered stability apply as
* public types in its package. The same rules for different stability apply as
* if they were specified on a type.
*
* @since 1.0
Expand Down