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

Jump to bottom

Add annotations for API visibility/stability #33

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

Add annotations for API visibility/stability #33

wants to merge 1 commit into from

Commits on Oct 27, 2018

  1. Add annotations for API visibility/stability 

    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.
    @magicDGS
    magicDGS committed Oct 27, 2018
    Configuration menu
    Copy the full SHA
    525b06a View commit details
    Browse the repository at this point in the history