Cleanup javadoc warnings for 1.13

This commit is contained in:
Shane Freeder 2018-08-17 05:29:16 +01:00
parent 039d6f2f75
commit 98d4ba9dce
No known key found for this signature in database
GPG key ID: A3F61EA5A085289C
4 changed files with 52 additions and 18 deletions

View file

@ -1,4 +1,4 @@
From 3b79b7a3816fa3f16c83f2eff8e1c4ae0bf7250e Mon Sep 17 00:00:00 2001 From 0cb60a4b2ab885ff8d88c19d7e0d3ce6200d51d3 Mon Sep 17 00:00:00 2001
From: Zach Brown <zach.brown@destroystokyo.com> From: Zach Brown <zach.brown@destroystokyo.com>
Date: Sat, 10 Jun 2017 16:59:40 -0500 Date: Sat, 10 Jun 2017 16:59:40 -0500
Subject: [PATCH] Fix upstream javadoc warnings and errors Subject: [PATCH] Fix upstream javadoc warnings and errors
@ -85,6 +85,18 @@ index 107574546..6d5410eab 100644
* @deprecated you are required to spawn a different entity * @deprecated you are required to spawn a different entity
*/ */
@Deprecated @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
@@ -138,6 +138,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(Particle particle, T data);
diff --git a/src/main/java/org/bukkit/entity/Guardian.java b/src/main/java/org/bukkit/entity/Guardian.java diff --git a/src/main/java/org/bukkit/entity/Guardian.java b/src/main/java/org/bukkit/entity/Guardian.java
index 98af0563c..ec6890ae6 100644 index 98af0563c..ec6890ae6 100644
--- a/src/main/java/org/bukkit/entity/Guardian.java --- a/src/main/java/org/bukkit/entity/Guardian.java
@ -112,7 +124,7 @@ index cfce8fa57..8660070bb 100644
*/ */
@Deprecated @Deprecated
diff --git a/src/main/java/org/bukkit/entity/Player.java b/src/main/java/org/bukkit/entity/Player.java 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 --- a/src/main/java/org/bukkit/entity/Player.java
+++ b/src/main/java/org/bukkit/entity/Player.java +++ b/src/main/java/org/bukkit/entity/Player.java
@@ -456,7 +456,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline @@ -456,7 +456,7 @@ 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 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 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
@@ -126,10 +126,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 diff --git a/src/main/java/org/bukkit/inventory/Merchant.java b/src/main/java/org/bukkit/inventory/Merchant.java
index c8e68570f..45431b360 100644 index c8e68570f..45431b360 100644
--- a/src/main/java/org/bukkit/inventory/Merchant.java --- a/src/main/java/org/bukkit/inventory/Merchant.java

View file

@ -1,4 +1,4 @@
From f43d349299401f7db1e573918c8d2ca82d4ac422 Mon Sep 17 00:00:00 2001 From 26ef852d4a6f4ec05a5795b377f92196e8097267 Mon Sep 17 00:00:00 2001
From: BillyGalbreath <Blake.Galbreath@GMail.com> From: BillyGalbreath <Blake.Galbreath@GMail.com>
Date: Sat, 21 Jul 2018 01:51:05 -0500 Date: Sat, 21 Jul 2018 01:51:05 -0500
Subject: [PATCH] EnderDragon Events Subject: [PATCH] EnderDragon Events
@ -6,10 +6,10 @@ 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 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 new file mode 100644
index 00000000..2ac57af3 index 000000000..ef2a8dab9
--- /dev/null --- /dev/null
+++ b/src/main/java/com/destroystokyo/paper/event/entity/EnderDragonFireballHitEvent.java +++ b/src/main/java/com/destroystokyo/paper/event/entity/EnderDragonFireballHitEvent.java
@@ -0,0 +1,70 @@ @@ -0,0 +1,72 @@
+package com.destroystokyo.paper.event.entity; +package com.destroystokyo.paper.event.entity;
+ +
+import org.bukkit.entity.AreaEffectCloud; +import org.bukkit.entity.AreaEffectCloud;
@ -44,15 +44,17 @@ index 00000000..2ac57af3
+ +
+ /** + /**
+ * The living entities hit by fireball + * The living entities hit by fireball
+ * <p></p> + *
+ * May be null if no entities were hit + * May be null if no entities were hit
+ *
+ * @return the targets
+ */ + */
+ public Collection<LivingEntity> getTargets() { + public Collection<LivingEntity> getTargets() {
+ return targets; + return targets;
+ } + }
+ +
+ /** + /**
+ * The area effect cloud spawned in this collision + * @return The area effect cloud spawned in this collision
+ */ + */
+ public AreaEffectCloud getAreaEffectCloud() { + public AreaEffectCloud getAreaEffectCloud() {
+ return areaEffectCloud; + 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 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 new file mode 100644
index 00000000..59f87633 index 000000000..d8c3ab330
--- /dev/null --- /dev/null
+++ b/src/main/java/com/destroystokyo/paper/event/entity/EnderDragonFlameEvent.java +++ b/src/main/java/com/destroystokyo/paper/event/entity/EnderDragonFlameEvent.java
@@ -0,0 +1,56 @@ @@ -0,0 +1,56 @@
@ -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() { + public AreaEffectCloud getAreaEffectCloud() {
+ return areaEffectCloud; + 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 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 new file mode 100644
index 00000000..296ae244 index 000000000..aa70dda10
--- /dev/null --- /dev/null
+++ b/src/main/java/com/destroystokyo/paper/event/entity/EnderDragonShootFireballEvent.java +++ b/src/main/java/com/destroystokyo/paper/event/entity/EnderDragonShootFireballEvent.java
@@ -0,0 +1,56 @@ @@ -0,0 +1,56 @@
@ -176,7 +178,7 @@ index 00000000..296ae244
+ } + }
+ +
+ /** + /**
+ * The fireball being shot + * @return The fireball being shot
+ */ + */
+ public DragonFireball getFireball() { + public DragonFireball getFireball() {
+ return fireball; + return fireball;
@ -205,5 +207,5 @@ index 00000000..296ae244
+ } + }
+} +}
-- --
2.11.0 2.18.0

View file

@ -1,4 +1,4 @@
From 252df7b3e431a46b2c623727bb2b2e74671a7a07 Mon Sep 17 00:00:00 2001 From bd1bf2ef9b17f194f63a15d670410bdf8aa508e6 Mon Sep 17 00:00:00 2001
From: willies952002 <admin@domnian.com> From: willies952002 <admin@domnian.com>
Date: Thu, 26 Jul 2018 02:22:44 -0400 Date: Thu, 26 Jul 2018 02:22:44 -0400
Subject: [PATCH] Expand ArmorStand API Subject: [PATCH] Expand ArmorStand API
@ -8,7 +8,7 @@ Add the following:
- Enable/Disable slot interactions - Enable/Disable slot interactions
diff --git a/src/main/java/org/bukkit/entity/ArmorStand.java b/src/main/java/org/bukkit/entity/ArmorStand.java 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 --- a/src/main/java/org/bukkit/entity/ArmorStand.java
+++ b/src/main/java/org/bukkit/entity/ArmorStand.java +++ b/src/main/java/org/bukkit/entity/ArmorStand.java
@@ -1,5 +1,6 @@ @@ -1,5 +1,6 @@
@ -44,7 +44,7 @@ index 859f166fb..4285f67fe 100644
void setItemInHand(ItemStack item); void setItemInHand(ItemStack item);
/** /**
@@ -291,5 +302,67 @@ public interface ArmorStand extends LivingEntity { @@ -291,5 +302,69 @@ public interface ArmorStand extends LivingEntity {
* @param tick {@code true} if this armour stand can tick, {@code false} otherwise * @param tick {@code true} if this armour stand can tick, {@code false} otherwise
*/ */
void setCanTick(final boolean tick); void setCanTick(final boolean tick);
@ -54,6 +54,7 @@ index 859f166fb..4285f67fe 100644
+ * equip in the given equipment slot + * equip in the given equipment slot
+ * + *
+ * @param slot the equipment slot to get + * @param slot the equipment slot to get
+ * @return the ItemStack in the equipment slot
+ */ + */
+ ItemStack getItem(final org.bukkit.inventory.EquipmentSlot slot); + ItemStack getItem(final org.bukkit.inventory.EquipmentSlot slot);
+ +
@ -107,6 +108,7 @@ index 859f166fb..4285f67fe 100644
+ /** + /**
+ * Check if a specific slot is disabled + * Check if a specific slot is disabled
+ * + *
+ * @param slot The slot to check
+ * @return {@code true} if the slot is disabled, else {@code false}. + * @return {@code true} if the slot is disabled, else {@code false}.
+ */ + */
+ boolean isSlotDisabled(org.bukkit.inventory.EquipmentSlot slot); + boolean isSlotDisabled(org.bukkit.inventory.EquipmentSlot slot);

View file

@ -1,4 +1,4 @@
From 1b88f97354ecb14699543f01215e47280d963f32 Mon Sep 17 00:00:00 2001 From 537ed31f439bcf3c179c8b9ee8478e395a931af0 Mon Sep 17 00:00:00 2001
From: Mark Vainomaa <mikroskeem@mikroskeem.eu> From: Mark Vainomaa <mikroskeem@mikroskeem.eu>
Date: Sun, 15 Jul 2018 22:17:55 +0300 Date: Sun, 15 Jul 2018 22:17:55 +0300
Subject: [PATCH] Add TNTPrimeEvent Subject: [PATCH] Add TNTPrimeEvent
@ -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 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 new file mode 100644
index 000000000..4f8d5d2db index 000000000..2ae8826bb
--- /dev/null --- /dev/null
+++ b/src/main/java/com/destroystokyo/paper/event/block/TNTPrimeEvent.java +++ b/src/main/java/com/destroystokyo/paper/event/block/TNTPrimeEvent.java
@@ -0,0 +1,108 @@ @@ -0,0 +1,108 @@
@ -102,7 +102,7 @@ index 000000000..4f8d5d2db
+ +
+ /** + /**
+ * When {@link org.bukkit.entity.Player} used {@link org.bukkit.Material#FLINT_AND_STEEL} or + * 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, + ITEM,
+ +