From 036d0b41ddc8cfbfe791f6a4766c25afcfd3b431 Mon Sep 17 00:00:00 2001
From: Bukkit/Spigot
Date: Mon, 1 Jun 2020 19:23:49 +1000
Subject: [PATCH] Move API notes to more obvious location
By: md_5
---
.../main/java/org/bukkit/package-info.java | 19 ------------------
paper-api/src/main/javadoc/overview.html | 20 ++++++++++++++++++-
2 files changed, 19 insertions(+), 20 deletions(-)
diff --git a/paper-api/src/main/java/org/bukkit/package-info.java b/paper-api/src/main/java/org/bukkit/package-info.java
index f4f8efcd03..d09f36f666 100644
--- a/paper-api/src/main/java/org/bukkit/package-info.java
+++ b/paper-api/src/main/java/org/bukkit/package-info.java
@@ -1,23 +1,4 @@
/**
* 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 not API.
- *
- * - 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.
- * - 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.
- * - Implementation classes. Concrete implementation classes packaged with
- * Bukkit (eg those beginning with Simple) are not API. You should access them
- * via their interfaces instead.
- *
*/
package org.bukkit;
diff --git a/paper-api/src/main/javadoc/overview.html b/paper-api/src/main/javadoc/overview.html
index e96bf35ebe..b477a2259b 100644
--- a/paper-api/src/main/javadoc/overview.html
+++ b/paper-api/src/main/javadoc/overview.html
@@ -13,5 +13,23 @@
For handling events and triggered code, see the {@link org.bukkit.event
event package}.
-
+
+ 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 not API.
+
+ - 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.
+ - 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.
+ - Implementation classes. Concrete implementation classes packaged with
+ Bukkit (eg those beginning with Simple) are not API. You should access them
+ via their interfaces instead.
+