From 26b15531e058e6f53cd42d0d3a663b53e5bfca0f Mon Sep 17 00:00:00 2001 From: Shane Freeder Date: Fri, 17 Aug 2018 05:29:16 +0100 Subject: [PATCH] Cleanup javadoc warnings for 1.13 --- Spigot-API-Patches/Add-TNTPrimeEvent.patch | 4 +-- Spigot-API-Patches/EnderDragon-Events.patch | 16 ++++++---- .../Expand-ArmorStand-API.patch | 4 ++- ...upstream-javadoc-warnings-and-errors.patch | 32 ++++++++++++++++++- 4 files changed, 45 insertions(+), 11 deletions(-) diff --git a/Spigot-API-Patches/Add-TNTPrimeEvent.patch b/Spigot-API-Patches/Add-TNTPrimeEvent.patch index 4dfcac576d..e77176f7ed 100644 --- a/Spigot-API-Patches/Add-TNTPrimeEvent.patch +++ b/Spigot-API-Patches/Add-TNTPrimeEvent.patch @@ -6,7 +6,7 @@ Subject: [PATCH] Add TNTPrimeEvent diff --git a/src/main/java/com/destroystokyo/paper/event/block/TNTPrimeEvent.java b/src/main/java/com/destroystokyo/paper/event/block/TNTPrimeEvent.java new file mode 100644 -index 000000000..4f8d5d2db +index 000000000..2ae8826bb --- /dev/null +++ b/src/main/java/com/destroystokyo/paper/event/block/TNTPrimeEvent.java @@ -0,0 +0,0 @@ @@ -102,7 +102,7 @@ index 000000000..4f8d5d2db + + /** + * When {@link org.bukkit.entity.Player} used {@link org.bukkit.Material#FLINT_AND_STEEL} or -+ * {@link org.bukkit.Material#FIREBALL} on given TNT block ++ * {@link org.bukkit.Material#FIRE_CHARGE} on given TNT block + */ + ITEM, + diff --git a/Spigot-API-Patches/EnderDragon-Events.patch b/Spigot-API-Patches/EnderDragon-Events.patch index b515af425b..891cdfd29a 100644 --- a/Spigot-API-Patches/EnderDragon-Events.patch +++ b/Spigot-API-Patches/EnderDragon-Events.patch @@ -6,7 +6,7 @@ Subject: [PATCH] EnderDragon Events diff --git a/src/main/java/com/destroystokyo/paper/event/entity/EnderDragonFireballHitEvent.java b/src/main/java/com/destroystokyo/paper/event/entity/EnderDragonFireballHitEvent.java new file mode 100644 -index 00000000..2ac57af3 +index 000000000..ef2a8dab9 --- /dev/null +++ b/src/main/java/com/destroystokyo/paper/event/entity/EnderDragonFireballHitEvent.java @@ -0,0 +0,0 @@ @@ -44,15 +44,17 @@ index 00000000..2ac57af3 + + /** + * The living entities hit by fireball -+ *

++ * + * May be null if no entities were hit ++ * ++ * @return the targets + */ + public Collection getTargets() { + return targets; + } + + /** -+ * The area effect cloud spawned in this collision ++ * @return The area effect cloud spawned in this collision + */ + public AreaEffectCloud getAreaEffectCloud() { + return areaEffectCloud; @@ -82,7 +84,7 @@ index 00000000..2ac57af3 +} diff --git a/src/main/java/com/destroystokyo/paper/event/entity/EnderDragonFlameEvent.java b/src/main/java/com/destroystokyo/paper/event/entity/EnderDragonFlameEvent.java new file mode 100644 -index 00000000..59f87633 +index 000000000..d8c3ab330 --- /dev/null +++ b/src/main/java/com/destroystokyo/paper/event/entity/EnderDragonFlameEvent.java @@ -0,0 +0,0 @@ @@ -114,7 +116,7 @@ index 00000000..59f87633 + } + + /** -+ * The area effect cloud spawned in this collision ++ * @return The area effect cloud spawned in this collision + */ + public AreaEffectCloud getAreaEffectCloud() { + return areaEffectCloud; @@ -144,7 +146,7 @@ index 00000000..59f87633 +} diff --git a/src/main/java/com/destroystokyo/paper/event/entity/EnderDragonShootFireballEvent.java b/src/main/java/com/destroystokyo/paper/event/entity/EnderDragonShootFireballEvent.java new file mode 100644 -index 00000000..296ae244 +index 000000000..aa70dda10 --- /dev/null +++ b/src/main/java/com/destroystokyo/paper/event/entity/EnderDragonShootFireballEvent.java @@ -0,0 +0,0 @@ @@ -176,7 +178,7 @@ index 00000000..296ae244 + } + + /** -+ * The fireball being shot ++ * @return The fireball being shot + */ + public DragonFireball getFireball() { + return fireball; diff --git a/Spigot-API-Patches/Expand-ArmorStand-API.patch b/Spigot-API-Patches/Expand-ArmorStand-API.patch index 8b5ccf6220..de79323a33 100644 --- a/Spigot-API-Patches/Expand-ArmorStand-API.patch +++ b/Spigot-API-Patches/Expand-ArmorStand-API.patch @@ -8,7 +8,7 @@ Add the following: - Enable/Disable slot interactions diff --git a/src/main/java/org/bukkit/entity/ArmorStand.java b/src/main/java/org/bukkit/entity/ArmorStand.java -index 859f166fb..4285f67fe 100644 +index 859f166fb..eda4873d5 100644 --- a/src/main/java/org/bukkit/entity/ArmorStand.java +++ b/src/main/java/org/bukkit/entity/ArmorStand.java @@ -0,0 +0,0 @@ @@ -54,6 +54,7 @@ index 859f166fb..4285f67fe 100644 + * equip in the given equipment slot + * + * @param slot the equipment slot to get ++ * @return the ItemStack in the equipment slot + */ + ItemStack getItem(final org.bukkit.inventory.EquipmentSlot slot); + @@ -107,6 +108,7 @@ index 859f166fb..4285f67fe 100644 + /** + * Check if a specific slot is disabled + * ++ * @param slot The slot to check + * @return {@code true} if the slot is disabled, else {@code false}. + */ + boolean isSlotDisabled(org.bukkit.inventory.EquipmentSlot slot); diff --git a/Spigot-API-Patches/Fix-upstream-javadoc-warnings-and-errors.patch b/Spigot-API-Patches/Fix-upstream-javadoc-warnings-and-errors.patch index 0efc068165..e22ab40ec4 100644 --- a/Spigot-API-Patches/Fix-upstream-javadoc-warnings-and-errors.patch +++ b/Spigot-API-Patches/Fix-upstream-javadoc-warnings-and-errors.patch @@ -85,6 +85,18 @@ index 107574546..6d5410eab 100644 * @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 9a569d3a3..8c5efd17e 100644 +--- a/src/main/java/org/bukkit/entity/AreaEffectCloud.java ++++ b/src/main/java/org/bukkit/entity/AreaEffectCloud.java +@@ -0,0 +0,0 @@ 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 the particle data type // Paper + */ + void setParticle(Particle particle, 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 @@ -112,7 +124,7 @@ index cfce8fa57..8660070bb 100644 */ @Deprecated diff --git a/src/main/java/org/bukkit/entity/Player.java b/src/main/java/org/bukkit/entity/Player.java -index 98c6039b9..7c008237a 100644 +index f2a148b2c..b63e3352f 100644 --- a/src/main/java/org/bukkit/entity/Player.java +++ b/src/main/java/org/bukkit/entity/Player.java @@ -0,0 +0,0 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline @@ -257,6 +269,24 @@ index de4fb37f3..f1de2af6e 100644 */ 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/ItemFactory.java b/src/main/java/org/bukkit/inventory/ItemFactory.java +index 762c43d69..ec2b8b8ed 100644 +--- a/src/main/java/org/bukkit/inventory/ItemFactory.java ++++ b/src/main/java/org/bukkit/inventory/ItemFactory.java +@@ -0,0 +0,0 @@ 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 c8e68570f..45431b360 100644 --- a/src/main/java/org/bukkit/inventory/Merchant.java