mirror of
https://github.com/PaperMC/Paper.git
synced 2024-10-26 19:07:13 +02:00
a8c28e1920
This branch/commit is only useful to those who purely use a clean Bukkit/Spigot/Paper API and does not use NMS/OBC references. This will let you start updating your plugin to the latest 1.13 builds of Bukkit Preview (4 as of now) Note that this release is not final!!! API breakages may occur! It is up to you if you find use out of this work.
352 lines
16 KiB
Diff
352 lines
16 KiB
Diff
From 569e6283060854cef2140d7a3ad0b2690911215b Mon Sep 17 00:00:00 2001
|
|
From: Zach Brown <zach.brown@destroystokyo.com>
|
|
Date: Sat, 10 Jun 2017 16:59:40 -0500
|
|
Subject: [PATCH] Fix upstream javadoc warnings and errors
|
|
|
|
Upstream still refuses to use Java 8 with the API so they are likely unaware these are even issues.
|
|
|
|
diff --git a/src/main/java/org/bukkit/NamespacedKey.java b/src/main/java/org/bukkit/NamespacedKey.java
|
|
index 19632d17..de1b1112 100644
|
|
--- a/src/main/java/org/bukkit/NamespacedKey.java
|
|
+++ b/src/main/java/org/bukkit/NamespacedKey.java
|
|
@@ -27,8 +27,8 @@ public final class NamespacedKey {
|
|
/**
|
|
* Create a key in a specific namespace.
|
|
*
|
|
- * @param namespace
|
|
- * @param key
|
|
+ * @param namespace String representing a grouping of keys
|
|
+ * @param key Name for this specific key
|
|
* @deprecated should never be used by plugins, for internal use only!!
|
|
*/
|
|
@Deprecated
|
|
diff --git a/src/main/java/org/bukkit/World.java b/src/main/java/org/bukkit/World.java
|
|
index 65156e80..6417cefa 100644
|
|
--- a/src/main/java/org/bukkit/World.java
|
|
+++ b/src/main/java/org/bukkit/World.java
|
|
@@ -1365,6 +1365,7 @@ public interface World extends PluginMessageRecipient, Metadatable {
|
|
* @param count the number of particles
|
|
* @param data the data to use for the particle or null,
|
|
* the type of this depends on {@link Particle#getDataType()}
|
|
+ * @param <T> Type
|
|
*/
|
|
public <T> void spawnParticle(Particle particle, Location location, int count, T data);
|
|
|
|
@@ -1380,6 +1381,7 @@ public interface World extends PluginMessageRecipient, Metadatable {
|
|
* @param count the number of particles
|
|
* @param data the data to use for the particle or null,
|
|
* the type of this depends on {@link Particle#getDataType()}
|
|
+ * @param <T> Type
|
|
*/
|
|
public <T> void spawnParticle(Particle particle, double x, double y, double z, int count, T data);
|
|
|
|
@@ -1429,6 +1431,7 @@ public interface World extends PluginMessageRecipient, Metadatable {
|
|
* @param offsetZ the maximum random offset on the Z axis
|
|
* @param data the data to use for the particle or null,
|
|
* the type of this depends on {@link Particle#getDataType()}
|
|
+ * @param <T> Type
|
|
*/
|
|
public <T> void spawnParticle(Particle particle, Location location, int count, double offsetX, double offsetY, double offsetZ, T data);
|
|
|
|
@@ -1448,6 +1451,7 @@ public interface World extends PluginMessageRecipient, Metadatable {
|
|
* @param offsetZ the maximum random offset on the Z axis
|
|
* @param data the data to use for the particle or null,
|
|
* the type of this depends on {@link Particle#getDataType()}
|
|
+ * @param <T> Type
|
|
*/
|
|
public <T> void spawnParticle(Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, T data);
|
|
|
|
@@ -1503,6 +1507,7 @@ public interface World extends PluginMessageRecipient, Metadatable {
|
|
* particle used (normally speed)
|
|
* @param data the data to use for the particle or null,
|
|
* the type of this depends on {@link Particle#getDataType()}
|
|
+ * @param <T> Type
|
|
*/
|
|
public <T> void spawnParticle(Particle particle, Location location, int count, double offsetX, double offsetY, double offsetZ, double extra, T data);
|
|
|
|
@@ -1524,6 +1529,7 @@ public interface World extends PluginMessageRecipient, Metadatable {
|
|
* particle used (normally speed)
|
|
* @param data the data to use for the particle or null,
|
|
* the type of this depends on {@link Particle#getDataType()}
|
|
+ * @param <T> Type
|
|
*/
|
|
public <T> void spawnParticle(Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, double extra, T data);
|
|
|
|
diff --git a/src/main/java/org/bukkit/entity/AbstractHorse.java b/src/main/java/org/bukkit/entity/AbstractHorse.java
|
|
index 10757454..6d5410ea 100644
|
|
--- a/src/main/java/org/bukkit/entity/AbstractHorse.java
|
|
+++ b/src/main/java/org/bukkit/entity/AbstractHorse.java
|
|
@@ -22,7 +22,7 @@ public interface AbstractHorse extends Animals, Vehicle, InventoryHolder, Tameab
|
|
public Horse.Variant getVariant();
|
|
|
|
/**
|
|
- * @param variant
|
|
+ * @param variant Variant to set
|
|
* @deprecated you are required to spawn a different entity
|
|
*/
|
|
@Deprecated
|
|
diff --git a/src/main/java/org/bukkit/entity/Guardian.java b/src/main/java/org/bukkit/entity/Guardian.java
|
|
index 98af0563..ec6890ae 100644
|
|
--- a/src/main/java/org/bukkit/entity/Guardian.java
|
|
+++ b/src/main/java/org/bukkit/entity/Guardian.java
|
|
@@ -12,7 +12,7 @@ public interface Guardian extends Monster {
|
|
public boolean isElder();
|
|
|
|
/**
|
|
- * @param shouldBeElder
|
|
+ * @param shouldBeElder Sets whether the Guardian is an Elder
|
|
* @deprecated Must spawn a new {@link ElderGuardian}.
|
|
*/
|
|
@Deprecated
|
|
diff --git a/src/main/java/org/bukkit/entity/Horse.java b/src/main/java/org/bukkit/entity/Horse.java
|
|
index cfce8fa5..8660070b 100644
|
|
--- a/src/main/java/org/bukkit/entity/Horse.java
|
|
+++ b/src/main/java/org/bukkit/entity/Horse.java
|
|
@@ -151,7 +151,7 @@ public interface Horse extends AbstractHorse {
|
|
public boolean isCarryingChest();
|
|
|
|
/**
|
|
- * @param chest
|
|
+ * @param chest Sets whether the Horse is carrying a chest
|
|
* @deprecated see {@link ChestedHorse}
|
|
*/
|
|
@Deprecated
|
|
diff --git a/src/main/java/org/bukkit/entity/Player.java b/src/main/java/org/bukkit/entity/Player.java
|
|
index d06f26b9..5c29c11e 100644
|
|
--- a/src/main/java/org/bukkit/entity/Player.java
|
|
+++ b/src/main/java/org/bukkit/entity/Player.java
|
|
@@ -409,7 +409,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
|
|
*
|
|
* Use supplied alternative character to the section symbol to represent legacy color codes.
|
|
*
|
|
- * @param alternateChar Alternate symbol such as '&'
|
|
+ * @param alternateChar Alternate symbol such as '&'
|
|
* @param message The message to send
|
|
*/
|
|
public void sendActionBar(char alternateChar, String message);
|
|
@@ -476,6 +476,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
|
|
/**
|
|
* Update the subtitle of titles displayed to the player
|
|
*
|
|
+ * @param subtitle Subtitle to set
|
|
* @deprecated Use {@link #updateTitle(Title)}
|
|
*/
|
|
@Deprecated
|
|
@@ -484,6 +485,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
|
|
/**
|
|
* Update the subtitle of titles displayed to the player
|
|
*
|
|
+ * @param subtitle Subtitle to set
|
|
* @deprecated Use {@link #updateTitle(Title)}
|
|
*/
|
|
@Deprecated
|
|
@@ -492,6 +494,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
|
|
/**
|
|
* Show the given title to the player, along with the last subtitle set, using the last set times
|
|
*
|
|
+ * @param title Title to set
|
|
* @deprecated Use {@link #sendTitle(Title)} or {@link #updateTitle(Title)}
|
|
*/
|
|
@Deprecated
|
|
@@ -500,6 +503,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
|
|
/**
|
|
* Show the given title to the player, along with the last subtitle set, using the last set times
|
|
*
|
|
+ * @param title Title to set
|
|
* @deprecated Use {@link #sendTitle(Title)} or {@link #updateTitle(Title)}
|
|
*/
|
|
@Deprecated
|
|
@@ -1420,6 +1424,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
|
|
* @param count the number of particles
|
|
* @param data the data to use for the particle or null,
|
|
* the type of this depends on {@link Particle#getDataType()}
|
|
+ * @param <T> Type
|
|
*/
|
|
public <T> void spawnParticle(Particle particle, Location location, int count, T data);
|
|
|
|
@@ -1435,6 +1440,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
|
|
* @param count the number of particles
|
|
* @param data the data to use for the particle or null,
|
|
* the type of this depends on {@link Particle#getDataType()}
|
|
+ * @param <T> Type
|
|
*/
|
|
public <T> void spawnParticle(Particle particle, double x, double y, double z, int count, T data);
|
|
|
|
@@ -1484,6 +1490,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
|
|
* @param offsetZ the maximum random offset on the Z axis
|
|
* @param data the data to use for the particle or null,
|
|
* the type of this depends on {@link Particle#getDataType()}
|
|
+ * @param <T> Type
|
|
*/
|
|
public <T> void spawnParticle(Particle particle, Location location, int count, double offsetX, double offsetY, double offsetZ, T data);
|
|
|
|
@@ -1503,6 +1510,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
|
|
* @param offsetZ the maximum random offset on the Z axis
|
|
* @param data the data to use for the particle or null,
|
|
* the type of this depends on {@link Particle#getDataType()}
|
|
+ * @param <T> Type
|
|
*/
|
|
public <T> void spawnParticle(Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, T data);
|
|
|
|
@@ -1558,6 +1566,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
|
|
* particle used (normally speed)
|
|
* @param data the data to use for the particle or null,
|
|
* the type of this depends on {@link Particle#getDataType()}
|
|
+ * @param <T> Type
|
|
*/
|
|
public <T> void spawnParticle(Particle particle, Location location, int count, double offsetX, double offsetY, double offsetZ, double extra, T data);
|
|
|
|
@@ -1579,6 +1588,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
|
|
* particle used (normally speed)
|
|
* @param data the data to use for the particle or null,
|
|
* the type of this depends on {@link Particle#getDataType()}
|
|
+ * @param <T> Type
|
|
*/
|
|
public <T> void spawnParticle(Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, double extra, T data);
|
|
|
|
diff --git a/src/main/java/org/bukkit/entity/Skeleton.java b/src/main/java/org/bukkit/entity/Skeleton.java
|
|
index 2a02ab85..e33d00b3 100644
|
|
--- a/src/main/java/org/bukkit/entity/Skeleton.java
|
|
+++ b/src/main/java/org/bukkit/entity/Skeleton.java
|
|
@@ -15,6 +15,7 @@ public interface Skeleton extends Monster {
|
|
public SkeletonType getSkeletonType();
|
|
|
|
/**
|
|
+ * @param type Type to set
|
|
* @deprecated Must spawn a new subtype variant
|
|
*/
|
|
@Deprecated
|
|
diff --git a/src/main/java/org/bukkit/entity/Zombie.java b/src/main/java/org/bukkit/entity/Zombie.java
|
|
index cf53ea22..62923379 100644
|
|
--- a/src/main/java/org/bukkit/entity/Zombie.java
|
|
+++ b/src/main/java/org/bukkit/entity/Zombie.java
|
|
@@ -29,14 +29,14 @@ public interface Zombie extends Monster {
|
|
public boolean isVillager();
|
|
|
|
/**
|
|
- * @param flag
|
|
+ * @param flag Sets whether the Zombie is a villager
|
|
* @deprecated must spawn {@link ZombieVillager}.
|
|
*/
|
|
@Deprecated
|
|
public void setVillager(boolean flag);
|
|
|
|
/**
|
|
- * @param profession
|
|
+ * @param profession Sets the ZombieVillager's profession
|
|
* @see ZombieVillager#getVillagerProfession()
|
|
*/
|
|
@Deprecated
|
|
diff --git a/src/main/java/org/bukkit/event/player/PlayerLoginEvent.java b/src/main/java/org/bukkit/event/player/PlayerLoginEvent.java
|
|
index de4fb37f..f1de2af6 100644
|
|
--- a/src/main/java/org/bukkit/event/player/PlayerLoginEvent.java
|
|
+++ b/src/main/java/org/bukkit/event/player/PlayerLoginEvent.java
|
|
@@ -24,6 +24,7 @@ public class PlayerLoginEvent extends PlayerEvent {
|
|
* @param hostname The hostname that was used to connect to the server
|
|
* @param address The address the player used to connect, provided for
|
|
* timing issues
|
|
+ * @param realAddress The unspoofed, actual address, that the player used to connect
|
|
*/
|
|
public PlayerLoginEvent(final Player player, final String hostname, final InetAddress address, final InetAddress realAddress) { // Spigot
|
|
super(player);
|
|
@@ -47,6 +48,7 @@ public class PlayerLoginEvent extends PlayerEvent {
|
|
* timing issues
|
|
* @param result The result status for this event
|
|
* @param message The message to be displayed if result denies login
|
|
+ * @param realAddress The unspoofed, actual address, that the player used to connect
|
|
*/
|
|
public PlayerLoginEvent(final Player player, String hostname, final InetAddress address, final Result result, final String message, final InetAddress realAddress) { // Spigot
|
|
this(player, hostname, address, realAddress); // Spigot
|
|
diff --git a/src/main/java/org/bukkit/inventory/Merchant.java b/src/main/java/org/bukkit/inventory/Merchant.java
|
|
index c8e68570..45431b36 100644
|
|
--- a/src/main/java/org/bukkit/inventory/Merchant.java
|
|
+++ b/src/main/java/org/bukkit/inventory/Merchant.java
|
|
@@ -32,7 +32,7 @@ public interface Merchant {
|
|
*
|
|
* @param i the index
|
|
* @return the recipe
|
|
- * @throws IndexOutOfBoundsException
|
|
+ * @throws IndexOutOfBoundsException Throws when specified index is larger than Merchant's inventory
|
|
*/
|
|
MerchantRecipe getRecipe(int i) throws IndexOutOfBoundsException;
|
|
|
|
@@ -41,7 +41,7 @@ public interface Merchant {
|
|
*
|
|
* @param i the index
|
|
* @param recipe the recipe
|
|
- * @throws IndexOutOfBoundsException
|
|
+ * @throws IndexOutOfBoundsException Throws when specified index is larger than Merchant's inventory
|
|
*/
|
|
void setRecipe(int i, MerchantRecipe recipe) throws IndexOutOfBoundsException;
|
|
|
|
diff --git a/src/main/java/org/bukkit/potion/Potion.java b/src/main/java/org/bukkit/potion/Potion.java
|
|
index 1413b361..b4a8051c 100644
|
|
--- a/src/main/java/org/bukkit/potion/Potion.java
|
|
+++ b/src/main/java/org/bukkit/potion/Potion.java
|
|
@@ -78,6 +78,7 @@ public class Potion {
|
|
}
|
|
|
|
/**
|
|
+ * @param name Unused, always uses {@link PotionType#WATER}
|
|
* @deprecated
|
|
*/
|
|
@Deprecated
|
|
diff --git a/src/main/java/org/bukkit/potion/PotionBrewer.java b/src/main/java/org/bukkit/potion/PotionBrewer.java
|
|
index 40f8d12b..33d19228 100644
|
|
--- a/src/main/java/org/bukkit/potion/PotionBrewer.java
|
|
+++ b/src/main/java/org/bukkit/potion/PotionBrewer.java
|
|
@@ -34,6 +34,8 @@ public interface PotionBrewer {
|
|
* a potion with the given type.
|
|
*
|
|
* @param type The type of the potion
|
|
+ * @param upgraded Whether the potion is upgraded
|
|
+ * @param extended Whether the potion is extended
|
|
* @return The list of effects
|
|
*/
|
|
public Collection<PotionEffect> getEffects(PotionType type, boolean upgraded, boolean extended);
|
|
diff --git a/src/main/java/org/bukkit/potion/PotionType.java b/src/main/java/org/bukkit/potion/PotionType.java
|
|
index 034421a7..f1a54c23 100644
|
|
--- a/src/main/java/org/bukkit/potion/PotionType.java
|
|
+++ b/src/main/java/org/bukkit/potion/PotionType.java
|
|
@@ -68,6 +68,7 @@ public enum PotionType {
|
|
}
|
|
|
|
/**
|
|
+ * @return Damage value associated with this PotionType, broken
|
|
* @deprecated Non-functional
|
|
*/
|
|
@Deprecated
|
|
@@ -80,6 +81,8 @@ public enum PotionType {
|
|
}
|
|
|
|
/**
|
|
+ * @param damage Damage value associated with a PotionType
|
|
+ * @return PotionType for given damage value, broken
|
|
* @deprecated Non-functional
|
|
*/
|
|
@Deprecated
|
|
@@ -88,6 +91,8 @@ public enum PotionType {
|
|
}
|
|
|
|
/**
|
|
+ * @param effectType EffectType
|
|
+ * @return Associated PotionType
|
|
* @deprecated Misleading
|
|
*/
|
|
@Deprecated
|
|
diff --git a/src/main/java/org/bukkit/scoreboard/Team.java b/src/main/java/org/bukkit/scoreboard/Team.java
|
|
index 92174e81..ac5cc32c 100644
|
|
--- a/src/main/java/org/bukkit/scoreboard/Team.java
|
|
+++ b/src/main/java/org/bukkit/scoreboard/Team.java
|
|
@@ -84,7 +84,7 @@ public interface Team {
|
|
* names are handled by prefixes / suffixes.
|
|
*
|
|
* @return team color, defaults to {@link ChatColor#RESET}
|
|
- * @throws IllegalStateException
|
|
+ * @throws IllegalStateException if this team has been unregistered
|
|
*/
|
|
ChatColor getColor() throws IllegalStateException;
|
|
|
|
--
|
|
2.18.0
|
|
|