From 7391c5bbbbfcae7c654522a87cc15707f0b02b17 Mon Sep 17 00:00:00 2001 From: Shane Freeder Date: Thu, 25 Oct 2018 14:38:19 +0100 Subject: [PATCH] Fix javadoc issues --- Spigot-API-Patches/Add-sun-related-API.patch | 4 +- ...Blocks-to-be-accessed-via-a-long-key.patch | 21 ++++---- Spigot-API-Patches/Async-Chunks-API.patch | 19 ++++---- ...upstream-javadoc-warnings-and-errors.patch | 48 ++++++++++++------- 4 files changed, 57 insertions(+), 35 deletions(-) diff --git a/Spigot-API-Patches/Add-sun-related-API.patch b/Spigot-API-Patches/Add-sun-related-API.patch index d1f293f045..4b329062ce 100644 --- a/Spigot-API-Patches/Add-sun-related-API.patch +++ b/Spigot-API-Patches/Add-sun-related-API.patch @@ -5,7 +5,7 @@ Subject: [PATCH] Add sun related API diff --git a/src/main/java/org/bukkit/World.java b/src/main/java/org/bukkit/World.java -index 7bfe0b68..12c4bdff 100644 +index 7ac07ac07ac0..7ac07ac07ac0 100644 --- a/src/main/java/org/bukkit/World.java +++ b/src/main/java/org/bukkit/World.java @@ -0,0 +0,0 @@ public interface World extends PluginMessageRecipient, Metadatable { @@ -26,7 +26,7 @@ index 7bfe0b68..12c4bdff 100644 * Returns whether the world has an ongoing storm. * diff --git a/src/main/java/org/bukkit/entity/Mob.java b/src/main/java/org/bukkit/entity/Mob.java -index 48eddcd3..1b108a4a 100644 +index 7ac07ac07ac0..7ac07ac07ac0 100644 --- a/src/main/java/org/bukkit/entity/Mob.java +++ b/src/main/java/org/bukkit/entity/Mob.java @@ -0,0 +0,0 @@ public interface Mob extends LivingEntity, Lootable { diff --git a/Spigot-API-Patches/Allow-Blocks-to-be-accessed-via-a-long-key.patch b/Spigot-API-Patches/Allow-Blocks-to-be-accessed-via-a-long-key.patch index 1457345ba7..fc2ae4c3ae 100644 --- a/Spigot-API-Patches/Allow-Blocks-to-be-accessed-via-a-long-key.patch +++ b/Spigot-API-Patches/Allow-Blocks-to-be-accessed-via-a-long-key.patch @@ -18,7 +18,7 @@ Y range: [0, 1023] X, Z range: [-67 108 864, 67 108 863] diff --git a/src/main/java/org/bukkit/Location.java b/src/main/java/org/bukkit/Location.java -index 8dcb15fb..7e1ee875 100644 +index 7ac07ac07ac0..7ac07ac07ac0 100644 --- a/src/main/java/org/bukkit/Location.java +++ b/src/main/java/org/bukkit/Location.java @@ -0,0 +0,0 @@ import org.bukkit.util.Vector; @@ -49,7 +49,7 @@ index 8dcb15fb..7e1ee875 100644 * @return A new location where X/Y/Z are the center of the block */ diff --git a/src/main/java/org/bukkit/World.java b/src/main/java/org/bukkit/World.java -index 724088ec..d4bfbad3 100644 +index 7ac07ac07ac0..7ac07ac07ac0 100644 --- a/src/main/java/org/bukkit/World.java +++ b/src/main/java/org/bukkit/World.java @@ -0,0 +0,0 @@ public interface World extends PluginMessageRecipient, Metadatable { @@ -91,7 +91,7 @@ index 724088ec..d4bfbad3 100644 * Gets the y coordinate of the lowest block at this position such that the * block and all blocks above it are transparent for lighting purposes. diff --git a/src/main/java/org/bukkit/block/Block.java b/src/main/java/org/bukkit/block/Block.java -index 238de6f0..d700df53 100644 +index 7ac07ac07ac0..7ac07ac07ac0 100644 --- a/src/main/java/org/bukkit/block/Block.java +++ b/src/main/java/org/bukkit/block/Block.java @@ -0,0 +0,0 @@ public interface Block extends Metadatable { @@ -102,18 +102,21 @@ index 238de6f0..d700df53 100644 + + /** + * Returns this block's coordinates packed into a long value -+ *

++ *

+ * The return value can be computed as follows: -+ *

++ *
+ * {@code long value = ((long)getX() & 0x7FFFFFF) | (((long)getZ() & 0x7FFFFFF) << 27) | ((long)getY() << 54);} -+ *

++ *

++ * ++ *

+ * And may be unpacked as follows: -+ *

++ *
+ * {@code int x = (int) ((packed << 37) >> 37);} -+ *

++ *
+ * {@code int y = (int) (packed >>> 54);} -+ *

++ *
+ * {@code int z = (int) ((packed << 10) >> 37);} ++ *

+ * + * @return This block's x, y, and z coordinates packed into a long value + */ diff --git a/Spigot-API-Patches/Async-Chunks-API.patch b/Spigot-API-Patches/Async-Chunks-API.patch index 31716ec834..c116cabce3 100644 --- a/Spigot-API-Patches/Async-Chunks-API.patch +++ b/Spigot-API-Patches/Async-Chunks-API.patch @@ -8,7 +8,7 @@ Adds API's to load or generate chunks asynchronously. Also adds utility methods to Entity to teleport asynchronously. diff --git a/src/main/java/org/bukkit/World.java b/src/main/java/org/bukkit/World.java -index e451ca611..bf5c21814 100644 +index 7ac07ac07ac0..7ac07ac07ac0 100644 --- a/src/main/java/org/bukkit/World.java +++ b/src/main/java/org/bukkit/World.java @@ -0,0 +0,0 @@ public interface World extends PluginMessageRecipient, Metadatable { @@ -122,7 +122,7 @@ index e451ca611..bf5c21814 100644 + * immediately, and you wish to let the server control the speed + * of chunk loads, keeping performance in mind. + * -+ * The {@link java.util.function.Consumer} will always be executed synchronously ++ * The {@link java.util.function.Consumer} will always be executed synchronously + * on the main Server Thread. + * + * @param x Chunk X-coordinate of the chunk - (world coordinate / 16) @@ -144,11 +144,12 @@ index e451ca611..bf5c21814 100644 + * immediately, and you wish to let the server control the speed + * of chunk loads, keeping performance in mind. + * -+ * The {@link java.util.function.Consumer} will always be executed synchronously ++ * The {@link java.util.function.Consumer} will always be executed synchronously + * on the main Server Thread. + * + * @param x Chunk X-coordinate of the chunk - (world coordinate / 16) + * @param z Chunk Z-coordinate of the chunk - (world coordinate / 16) ++ * @param gen Should we generate a chunk if it doesn't exists or not + * @param cb Callback to receive the chunk when it is loaded. + * will be executed synchronously + */ @@ -166,7 +167,7 @@ index e451ca611..bf5c21814 100644 + * immediately, and you wish to let the server control the speed + * of chunk loads, keeping performance in mind. + * -+ * The {@link java.util.function.Consumer} will always be executed synchronously ++ * The {@link java.util.function.Consumer} will always be executed synchronously + * on the main Server Thread. + * + * @param loc Location of the chunk @@ -187,10 +188,11 @@ index e451ca611..bf5c21814 100644 + * immediately, and you wish to let the server control the speed + * of chunk loads, keeping performance in mind. + * -+ * The {@link java.util.function.Consumer} will always be executed synchronously ++ * The {@link java.util.function.Consumer} will always be executed synchronously + * on the main Server Thread. + * + * @param loc Location of the chunk ++ * @param gen Should the chunk generate + * @param cb Callback to receive the chunk when it is loaded. + * will be executed synchronously + */ @@ -208,7 +210,7 @@ index e451ca611..bf5c21814 100644 + * immediately, and you wish to let the server control the speed + * of chunk loads, keeping performance in mind. + * -+ * The {@link java.util.function.Consumer} will always be executed synchronously ++ * The {@link java.util.function.Consumer} will always be executed synchronously + * on the main Server Thread. + * + * @param block Block to get the containing chunk from @@ -229,10 +231,11 @@ index e451ca611..bf5c21814 100644 + * immediately, and you wish to let the server control the speed + * of chunk loads, keeping performance in mind. + * -+ * The {@link java.util.function.Consumer} will always be executed synchronously ++ * The {@link java.util.function.Consumer} will always be executed synchronously + * on the main Server Thread. + * + * @param block Block to get the containing chunk from ++ * @param gen Should the chunk generate + * @param cb Callback to receive the chunk when it is loaded. + * will be executed synchronously + */ @@ -362,7 +365,7 @@ index e451ca611..bf5c21814 100644 /** diff --git a/src/main/java/org/bukkit/entity/Entity.java b/src/main/java/org/bukkit/entity/Entity.java -index 72ebe35fb..cd835edce 100644 +index 7ac07ac07ac0..7ac07ac07ac0 100644 --- a/src/main/java/org/bukkit/entity/Entity.java +++ b/src/main/java/org/bukkit/entity/Entity.java @@ -0,0 +0,0 @@ public interface Entity extends Metadatable, CommandSender, Nameable { 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 01f8d5c5cc..1c1019153e 100644 --- a/Spigot-API-Patches/Fix-upstream-javadoc-warnings-and-errors.patch +++ b/Spigot-API-Patches/Fix-upstream-javadoc-warnings-and-errors.patch @@ -6,7 +6,7 @@ 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 43239f844..fe8d34685 100644 +index 7ac07ac07ac0..7ac07ac07ac0 100644 --- a/src/main/java/org/bukkit/NamespacedKey.java +++ b/src/main/java/org/bukkit/NamespacedKey.java @@ -0,0 +0,0 @@ public final class NamespacedKey { @@ -21,7 +21,7 @@ index 43239f844..fe8d34685 100644 */ @Deprecated diff --git a/src/main/java/org/bukkit/World.java b/src/main/java/org/bukkit/World.java -index a51519dda..bf6f91917 100644 +index 7ac07ac07ac0..7ac07ac07ac0 100644 --- a/src/main/java/org/bukkit/World.java +++ b/src/main/java/org/bukkit/World.java @@ -0,0 +0,0 @@ public interface World extends PluginMessageRecipient, Metadatable { @@ -72,8 +72,24 @@ index a51519dda..bf6f91917 100644 */ public void spawnParticle(Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, double extra, T data); +@@ -0,0 +0,0 @@ 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 Particle data type + */ + public void spawnParticle(Particle particle, Location location, int count, double offsetX, double offsetY, double offsetZ, double extra, T data, boolean force); + +@@ -0,0 +0,0 @@ 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 Particle data type + */ + public void spawnParticle(Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, double extra, 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 107574546..6d5410eab 100644 +index 7ac07ac07ac0..7ac07ac07ac0 100644 --- a/src/main/java/org/bukkit/entity/AbstractHorse.java +++ b/src/main/java/org/bukkit/entity/AbstractHorse.java @@ -0,0 +0,0 @@ public interface AbstractHorse extends Animals, Vehicle, InventoryHolder, Tameab @@ -86,7 +102,7 @@ index 107574546..6d5410eab 100644 */ @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 +index 7ac07ac07ac0..7ac07ac07ac0 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 { @@ -98,7 +114,7 @@ index 9a569d3a3..8c5efd17e 100644 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 +index 7ac07ac07ac0..7ac07ac07ac0 100644 --- a/src/main/java/org/bukkit/entity/Guardian.java +++ b/src/main/java/org/bukkit/entity/Guardian.java @@ -0,0 +0,0 @@ public interface Guardian extends Monster { @@ -111,7 +127,7 @@ index 98af0563c..ec6890ae6 100644 */ @Deprecated diff --git a/src/main/java/org/bukkit/entity/Horse.java b/src/main/java/org/bukkit/entity/Horse.java -index cfce8fa57..8660070bb 100644 +index 7ac07ac07ac0..7ac07ac07ac0 100644 --- a/src/main/java/org/bukkit/entity/Horse.java +++ b/src/main/java/org/bukkit/entity/Horse.java @@ -0,0 +0,0 @@ public interface Horse extends AbstractHorse { @@ -124,7 +140,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 993537141..e848ab5b6 100644 +index 7ac07ac07ac0..7ac07ac07ac0 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 @@ -217,7 +233,7 @@ index 993537141..e848ab5b6 100644 public 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 2a02ab855..e33d00b30 100644 +index 7ac07ac07ac0..7ac07ac07ac0 100644 --- a/src/main/java/org/bukkit/entity/Skeleton.java +++ b/src/main/java/org/bukkit/entity/Skeleton.java @@ -0,0 +0,0 @@ public interface Skeleton extends Monster { @@ -229,7 +245,7 @@ index 2a02ab855..e33d00b30 100644 */ @Deprecated diff --git a/src/main/java/org/bukkit/entity/Zombie.java b/src/main/java/org/bukkit/entity/Zombie.java -index cf53ea22f..629233796 100644 +index 7ac07ac07ac0..7ac07ac07ac0 100644 --- a/src/main/java/org/bukkit/entity/Zombie.java +++ b/src/main/java/org/bukkit/entity/Zombie.java @@ -0,0 +0,0 @@ public interface Zombie extends Monster { @@ -250,7 +266,7 @@ index cf53ea22f..629233796 100644 */ @Deprecated diff --git a/src/main/java/org/bukkit/event/player/PlayerLoginEvent.java b/src/main/java/org/bukkit/event/player/PlayerLoginEvent.java -index de4fb37f3..f1de2af6e 100644 +index 7ac07ac07ac0..7ac07ac07ac0 100644 --- a/src/main/java/org/bukkit/event/player/PlayerLoginEvent.java +++ b/src/main/java/org/bukkit/event/player/PlayerLoginEvent.java @@ -0,0 +0,0 @@ public class PlayerLoginEvent extends PlayerEvent { @@ -270,7 +286,7 @@ 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 +index 7ac07ac07ac0..7ac07ac07ac0 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 { @@ -288,7 +304,7 @@ index 762c43d69..ec2b8b8ed 100644 */ @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 +index 7ac07ac07ac0..7ac07ac07ac0 100644 --- a/src/main/java/org/bukkit/inventory/Merchant.java +++ b/src/main/java/org/bukkit/inventory/Merchant.java @@ -0,0 +0,0 @@ public interface Merchant { @@ -310,7 +326,7 @@ index c8e68570f..45431b360 100644 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 1413b361b..b4a8051cc 100644 +index 7ac07ac07ac0..7ac07ac07ac0 100644 --- a/src/main/java/org/bukkit/potion/Potion.java +++ b/src/main/java/org/bukkit/potion/Potion.java @@ -0,0 +0,0 @@ public class Potion { @@ -322,7 +338,7 @@ index 1413b361b..b4a8051cc 100644 */ @Deprecated diff --git a/src/main/java/org/bukkit/potion/PotionBrewer.java b/src/main/java/org/bukkit/potion/PotionBrewer.java -index 40f8d12b9..33d192287 100644 +index 7ac07ac07ac0..7ac07ac07ac0 100644 --- a/src/main/java/org/bukkit/potion/PotionBrewer.java +++ b/src/main/java/org/bukkit/potion/PotionBrewer.java @@ -0,0 +0,0 @@ public interface PotionBrewer { @@ -335,7 +351,7 @@ index 40f8d12b9..33d192287 100644 */ public Collection 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 034421a76..f1a54c23c 100644 +index 7ac07ac07ac0..7ac07ac07ac0 100644 --- a/src/main/java/org/bukkit/potion/PotionType.java +++ b/src/main/java/org/bukkit/potion/PotionType.java @@ -0,0 +0,0 @@ public enum PotionType { @@ -365,7 +381,7 @@ index 034421a76..f1a54c23c 100644 */ @Deprecated diff --git a/src/main/java/org/bukkit/scoreboard/Team.java b/src/main/java/org/bukkit/scoreboard/Team.java -index ab71f3c31..358ea386b 100644 +index 7ac07ac07ac0..7ac07ac07ac0 100644 --- a/src/main/java/org/bukkit/scoreboard/Team.java +++ b/src/main/java/org/bukkit/scoreboard/Team.java @@ -0,0 +0,0 @@ public interface Team {