Declare main classes API status #204
Merged
Conversation
This file contains 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
MattSturgeon
added
documentation
MattSturgeon
force-pushed
the
api-status
branch
from
81dc003 to
5838e23
Compare
MattSturgeon
commented
Apr 29, 2024
Comment on lines
+323
to
324
| @ApiStatus.AvailableSince("0.2.2") | ||
| public static boolean isEnabled() { |
There was a problem hiding this comment.
This may be older. 0.2.2 is the oldest jar I can find.
hashalite
approved these changes
May 3, 2024
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.
Turns out mods integrating with or attempting to be compatible with Freecam may wish to compile against our classes and use our API.
e.g. FirstPersonModel compiles against Freecam v1.1.6 and uses the public API
Freecam.isEnabled()that has (luckily) remained ABI compatible since before our initial commit.It may be useful to explicitly state the API status of various public methods, even if for no reason other than to make us think twice before changing the public API.
I've only done this for the main classes,
FreecamandFreeCamerafor now. Ideally, we'd declare the API status of all public classes.One method I could only trace back to v0.2.2, which is the oldest release on GitHub and pre-dates the initial commit (AFAICT).