Add annotations for API visibility/stability #33
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
API visibility: - Private: only for internal usage - VisibleForTesting: only for testing purposes - Advanced: for usafe code to use by advance client-code API stability: - Experimental: might be changed/removed in future releases. - Beta: might be changed in future releases, but not removed. In addition, it relocates the ParamUtils class to an internal package, to mark the code as htjdk-only usage. The information on how to use the annotations (mostly on the javadoc) and how to name internal/private packages should be defined in developer guidelines checked in the repository, but are out of the scope of this commit.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
API visibility:
API stability:
In addition, it relocates the ParamUtils class to an internal
package, to mark the code as htjdk-only usage.
The information on how to use the annotations (mostly on the
javadoc) and how to name internal/private packages should be
defined in developer guidelines checked in the repository,
but are out of the scope of this commit.
Closes #11