-
Notifications
You must be signed in to change notification settings - Fork 0
Deprecation rules
§ Deprecation rules in the Avoid Framework
Here are the rules:
-
Stable elements should use the annotation
@NeverRemoval.
Type presence doesn't always indicate all-member presence. -
Incubating elements should use the annotation
@Discouraged.
This means they're not yet fully established; incompatible changes may emerge. -
Alpha elements should use the annotation
@ApiStatus.Experimental.
This means they will probably stay, but they're still in development. -
Deprecated elements should use the annotation
@Deprecated.
This means they shouldn't be used anymore. -
Internal elements should use the annotation
@ApiStatus.Internal.
This means there's a high chance they might stop being available or get completely refactored, at any time.
Unfortunately however I don't always keep the promise. I do my best to not disappoint you, but sometimes that stupid @NeverRemoval element preventing further progress just has to be wiped out of existence.
Unannotated elements are a middle-ground between @Discouraged and @ApiStatus.Experimental.
Don't hesitate to use cool-looking APIs, though.
If an API looks good and you don't see any implementation/concept errors, then you're most likely fine.
©️ Copyright 2026 Olafcio (on behalf of the AvoidLib org)
📝 All Rights Reserved
Avoid Framework
🏚️ 1. Home
📽️ 2. Creating your mod
🌄 3. Adding assets to your mod
🧊 4. Creating a block
💧 5. Creating a fluid
✏️ 6. Creating an item
🎯 7. Creating an entity selector
🤖 8. Creating a command
⌨️ 9. Creating a keybind
🐺 10. Creating an entity
🌫️ 11. Creating a fog
🔩 12. Creating an item component
🔮 13. Creating an effect
📚 14. Language support & adding libraries
🚩 15. Deprecation rules
⏳ 16. Loading philosophy
Migrations