Upstream/Paper
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-01-03 23:07:40 +01:00
Code Issues Projects Releases Wiki Activity

Add specific notes about what is not API

Browse Source 
By: md_5 <git@md-5.net>
This commit is contained in:
Bukkit/Spigot 2020-04-05 16:16:35 +10:00
parent ef82c63b5f
commit 2272d756ab
1 changed files with 20 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
paper-api/src/main/java/org/bukkit/package-info.java
View File

@ -1,5 +1,23 @@
/**
* More generalized classes in the API.
* The root package of the Bukkit API, contains generalized API classes.
*
* Note: While the Bukkit API makes every effort to ensure stability, this is
* not guaranteed, especially across major versions. In particular the following
* is a (incomplete) list of things that are <b>not</b> API.
* <ul>
* <li>Implementing interfaces. The Bukkit API is designed to only be
* implemented by server software. Unless a class/interface is obviously
* designed for extension (eg {@link org.bukkit.scheduler.BukkitRunnable}), or
* explicitly marked as such, it should not be implemented by plugins. Although
* this can sometimes work, it is not guaranteed to do so and resulting bugs
* will be disregarded.</li>
* <li>Constructing inbuilt events. Although backwards compatibility is
* attempted where possible, it is sometimes not possible to add new fields to
* events without breaking existing constructors. To ensure that the API
* continues to evolve, event constructors are therefore not plugin API.</li>
* <li>Implementation classes. Concrete implementation classes packaged with
* Bukkit (eg those beginning with Simple) are not API. You should access them
* via their interfaces instead.</li>
* </ul>
*/
package org.bukkit;