mirror of
https://github.com/PaperMC/Paper.git
synced 2024-09-07 04:18:09 +02:00
Upstream has released updates that appears to apply and compile correctly. This update has not been tested by PaperMC and as with ANY update, please do your own testing Please note that this build includes changes to meet upstreams requirements for nullability annotations. While we aim for a level of accuracy, these might not be 100% correct, if there are any issues, please speak to us on discord, or open an issue on the tracker to discuss. Bukkit Changes: 9a6a1de3 Remove nullability annotations from enum constructors 3f0591ea SPIGOT-2540: Add nullability annotations to entire Bukkit API CraftBukkit Changes:8d8475fc
SPIGOT-4666: Force parameter in HumanEntity#sleep8b1588e2
Fix ExplosionPrimeEvent#setFire not working with EnderCrystals39a287b7
Don't ignore newlines in PlayerListHeader/Footer Spigot Changes: cf694d87 Add nullability annotations
387 lines
18 KiB
Diff
387 lines
18 KiB
Diff
From 0073358c87abe5e1b89363c51a06ff694a01f965 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 ffebffd8b..f5e3929aa 100644
|
|
--- a/src/main/java/org/bukkit/NamespacedKey.java
|
|
+++ b/src/main/java/org/bukkit/NamespacedKey.java
|
|
@@ -39,8 +39,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 846b0619a..84abeb216 100644
|
|
--- a/src/main/java/org/bukkit/World.java
|
|
+++ b/src/main/java/org/bukkit/World.java
|
|
@@ -1666,6 +1666,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(@NotNull Particle particle, @NotNull Location location, int count, @Nullable T data);
|
|
|
|
@@ -1681,6 +1682,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(@NotNull Particle particle, double x, double y, double z, int count, @Nullable T data);
|
|
|
|
@@ -1730,6 +1732,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(@NotNull Particle particle, @NotNull Location location, int count, double offsetX, double offsetY, double offsetZ, @Nullable T data);
|
|
|
|
@@ -1749,6 +1752,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(@NotNull Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, @Nullable T data);
|
|
|
|
@@ -1804,6 +1808,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(@NotNull Particle particle, @NotNull Location location, int count, double offsetX, double offsetY, double offsetZ, double extra, @Nullable T data);
|
|
|
|
@@ -1825,6 +1830,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(@NotNull Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, double extra, @Nullable T data);
|
|
|
|
@@ -1847,6 +1853,7 @@ public interface World extends PluginMessageRecipient, Metadatable {
|
|
* @param force whether to send the particle to players within an extended
|
|
* range and encourage their client to render it regardless of
|
|
* settings
|
|
+ * @param <T> Particle data type
|
|
*/
|
|
public <T> void spawnParticle(@NotNull Particle particle, @NotNull Location location, int count, double offsetX, double offsetY, double offsetZ, double extra, @Nullable T data, boolean force);
|
|
|
|
@@ -1871,6 +1878,7 @@ public interface World extends PluginMessageRecipient, Metadatable {
|
|
* @param force whether to send the particle to players within an extended
|
|
* range and encourage their client to render it regardless of
|
|
* settings
|
|
+ * @param <T> Particle data type
|
|
*/
|
|
public <T> void spawnParticle(@NotNull Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, double extra, @Nullable T data, boolean force);
|
|
|
|
diff --git a/src/main/java/org/bukkit/entity/AbstractHorse.java b/src/main/java/org/bukkit/entity/AbstractHorse.java
|
|
index 2f1956724..234aa9dd2 100644
|
|
--- a/src/main/java/org/bukkit/entity/AbstractHorse.java
|
|
+++ b/src/main/java/org/bukkit/entity/AbstractHorse.java
|
|
@@ -25,7 +25,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/AreaEffectCloud.java b/src/main/java/org/bukkit/entity/AreaEffectCloud.java
|
|
index d258e734e..123d87954 100644
|
|
--- a/src/main/java/org/bukkit/entity/AreaEffectCloud.java
|
|
+++ b/src/main/java/org/bukkit/entity/AreaEffectCloud.java
|
|
@@ -141,6 +141,7 @@ public interface AreaEffectCloud extends Entity {
|
|
* @param particle the new particle type
|
|
* @param data the data to use for the particle or null,
|
|
* the type of this depends on {@link Particle#getDataType()}
|
|
+ * @param <T> the particle data type // Paper
|
|
*/
|
|
<T> void setParticle(@NotNull Particle particle, @Nullable T data);
|
|
|
|
diff --git a/src/main/java/org/bukkit/entity/Guardian.java b/src/main/java/org/bukkit/entity/Guardian.java
|
|
index 98af0563c..ec6890ae6 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 734f5ac7b..5efa4e606 100644
|
|
--- a/src/main/java/org/bukkit/entity/Horse.java
|
|
+++ b/src/main/java/org/bukkit/entity/Horse.java
|
|
@@ -154,7 +154,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 219556ed5..c21785d58 100644
|
|
--- a/src/main/java/org/bukkit/entity/Player.java
|
|
+++ b/src/main/java/org/bukkit/entity/Player.java
|
|
@@ -438,7 +438,7 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
|
|
*
|
|
* 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, @NotNull String message);
|
|
@@ -505,6 +505,7 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
|
|
/**
|
|
* Update the subtitle of titles displayed to the player
|
|
*
|
|
+ * @param subtitle Subtitle to set
|
|
* @deprecated Use {@link #updateTitle(Title)}
|
|
*/
|
|
@Deprecated
|
|
@@ -513,6 +514,7 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
|
|
/**
|
|
* Update the subtitle of titles displayed to the player
|
|
*
|
|
+ * @param subtitle Subtitle to set
|
|
* @deprecated Use {@link #updateTitle(Title)}
|
|
*/
|
|
@Deprecated
|
|
@@ -521,6 +523,7 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
|
|
/**
|
|
* 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
|
|
@@ -529,6 +532,7 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
|
|
/**
|
|
* 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
|
|
@@ -1428,6 +1432,7 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
|
|
* @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(@NotNull Particle particle, @NotNull Location location, int count, @Nullable T data);
|
|
|
|
@@ -1443,6 +1448,7 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
|
|
* @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(@NotNull Particle particle, double x, double y, double z, int count, @Nullable T data);
|
|
|
|
@@ -1492,6 +1498,7 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
|
|
* @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(@NotNull Particle particle, @NotNull Location location, int count, double offsetX, double offsetY, double offsetZ, @Nullable T data);
|
|
|
|
@@ -1511,6 +1518,7 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
|
|
* @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(@NotNull Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, @Nullable T data);
|
|
|
|
@@ -1566,6 +1574,7 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
|
|
* 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(@NotNull Particle particle, @NotNull Location location, int count, double offsetX, double offsetY, double offsetZ, double extra, @Nullable T data);
|
|
|
|
@@ -1587,6 +1596,7 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
|
|
* 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(@NotNull Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, double extra, @Nullable T data);
|
|
|
|
diff --git a/src/main/java/org/bukkit/entity/Skeleton.java b/src/main/java/org/bukkit/entity/Skeleton.java
|
|
index 2a0b01097..2ac30c0f6 100644
|
|
--- a/src/main/java/org/bukkit/entity/Skeleton.java
|
|
+++ b/src/main/java/org/bukkit/entity/Skeleton.java
|
|
@@ -19,6 +19,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 756f285eb..ee2e70c67 100644
|
|
--- a/src/main/java/org/bukkit/entity/Zombie.java
|
|
+++ b/src/main/java/org/bukkit/entity/Zombie.java
|
|
@@ -32,7 +32,7 @@ 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
|
|
@@ -40,7 +40,7 @@ public interface Zombie extends Monster {
|
|
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 8d4c70031..b493173e2 100644
|
|
--- a/src/main/java/org/bukkit/event/player/PlayerLoginEvent.java
|
|
+++ b/src/main/java/org/bukkit/event/player/PlayerLoginEvent.java
|
|
@@ -29,6 +29,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(@NotNull final Player player, @NotNull final String hostname, @NotNull final InetAddress address, final @NotNull InetAddress realAddress) { // Spigot
|
|
super(player);
|
|
@@ -52,6 +53,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(@NotNull final Player player, @NotNull String hostname, @NotNull final InetAddress address, @NotNull final Result result, @NotNull final String message, @NotNull final InetAddress realAddress) { // Spigot
|
|
this(player, hostname, address, realAddress); // Spigot
|
|
diff --git a/src/main/java/org/bukkit/inventory/ItemFactory.java b/src/main/java/org/bukkit/inventory/ItemFactory.java
|
|
index 07d2b4cfe..cbcbe8c8a 100644
|
|
--- a/src/main/java/org/bukkit/inventory/ItemFactory.java
|
|
+++ b/src/main/java/org/bukkit/inventory/ItemFactory.java
|
|
@@ -132,10 +132,10 @@ public interface ItemFactory {
|
|
* Apply a material change for an item meta. Do not use under any
|
|
* circumstances.
|
|
*
|
|
- * @param meta
|
|
- * @param material
|
|
+ * @param meta meta
|
|
+ * @param material material
|
|
* @return updated material
|
|
- * @throws IllegalArgumentException
|
|
+ * @throws IllegalArgumentException exception
|
|
* @deprecated for internal use only
|
|
*/
|
|
@Deprecated
|
|
diff --git a/src/main/java/org/bukkit/inventory/Merchant.java b/src/main/java/org/bukkit/inventory/Merchant.java
|
|
index 668e91958..5ff1f93d1 100644
|
|
--- a/src/main/java/org/bukkit/inventory/Merchant.java
|
|
+++ b/src/main/java/org/bukkit/inventory/Merchant.java
|
|
@@ -35,7 +35,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
|
|
*/
|
|
@NotNull
|
|
MerchantRecipe getRecipe(int i) throws IndexOutOfBoundsException;
|
|
@@ -45,7 +45,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, @NotNull 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 63b7c70ce..a57f70ec6 100644
|
|
--- a/src/main/java/org/bukkit/potion/Potion.java
|
|
+++ b/src/main/java/org/bukkit/potion/Potion.java
|
|
@@ -79,6 +79,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 9f913e1ee..254bd6f3e 100644
|
|
--- a/src/main/java/org/bukkit/potion/PotionBrewer.java
|
|
+++ b/src/main/java/org/bukkit/potion/PotionBrewer.java
|
|
@@ -38,6 +38,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
|
|
*/
|
|
@NotNull
|
|
diff --git a/src/main/java/org/bukkit/potion/PotionType.java b/src/main/java/org/bukkit/potion/PotionType.java
|
|
index 9b0fcf2da..e83e4b4fd 100644
|
|
--- a/src/main/java/org/bukkit/potion/PotionType.java
|
|
+++ b/src/main/java/org/bukkit/potion/PotionType.java
|
|
@@ -72,6 +72,7 @@ public enum PotionType {
|
|
}
|
|
|
|
/**
|
|
+ * @return Damage value associated with this PotionType, broken
|
|
* @deprecated Non-functional
|
|
*/
|
|
@Deprecated
|
|
@@ -84,6 +85,8 @@ public enum PotionType {
|
|
}
|
|
|
|
/**
|
|
+ * @param damage Damage value associated with a PotionType
|
|
+ * @return PotionType for given damage value, broken
|
|
* @deprecated Non-functional
|
|
*/
|
|
@Deprecated
|
|
@@ -94,6 +97,8 @@ public enum PotionType {
|
|
}
|
|
|
|
/**
|
|
+ * @param effectType EffectType
|
|
+ * @return Associated PotionType
|
|
* @deprecated Misleading
|
|
*/
|
|
@Deprecated
|
|
--
|
|
2.21.0
|
|
|