diff --git a/paper-api/pom.xml b/paper-api/pom.xml index 924ca29fd..efa009a0b 100644 --- a/paper-api/pom.xml +++ b/paper-api/pom.xml @@ -136,7 +136,7 @@ org.eclipse.jdt ecj - 3.24.0 + 3.26.0 @@ -158,7 +158,7 @@ org.apache.maven.plugins maven-shade-plugin - 3.2.3 + 3.2.4 package @@ -183,12 +183,12 @@ org.apache.maven.plugins maven-javadoc-plugin - 3.2.0 + 3.3.0 https://guava.dev/releases/21.0/api/docs/ - https://javadoc.io/doc/org.yaml/snakeyaml/1.27/ - https://javadoc.io/doc/org.jetbrains/annotations-java5/20.1.0/ + https://javadoc.io/doc/org.yaml/snakeyaml/1.28/ + https://javadoc.io/doc/org.jetbrains/annotations-java5/21.0.1/ @@ -206,7 +206,7 @@ org.apache.maven.plugins maven-checkstyle-plugin - 3.1.1 + 3.1.2 process-classes @@ -223,14 +223,14 @@ com.puppycrawl.tools checkstyle - 8.39 + 8.44 org.codehaus.mojo animal-sniffer-maven-plugin - 1.19 + 1.20 process-classes diff --git a/paper-api/src/main/java/org/bukkit/Bukkit.java b/paper-api/src/main/java/org/bukkit/Bukkit.java index d491f0ed3..9a8eabc45 100644 --- a/paper-api/src/main/java/org/bukkit/Bukkit.java +++ b/paper-api/src/main/java/org/bukkit/Bukkit.java @@ -883,11 +883,11 @@ public final class Bukkit { * This will return an object even if the player does not exist. To this * method, all players will exist. * - * @deprecated Persistent storage of users should be by UUID as names are no longer - * unique past a single session. * @param name the name the player to retrieve * @return an offline player * @see #getOfflinePlayer(java.util.UUID) + * @deprecated Persistent storage of users should be by UUID as names are no longer + * unique past a single session. */ @Deprecated @NotNull @@ -1278,11 +1278,11 @@ public final class Bukkit { * guaranteed to throw an implementation-defined {@link Exception}. * * @param file the file to load the from + * @return a cached server-icon that can be used for a {@link + * ServerListPingEvent#setServerIcon(CachedServerIcon)} * @throws IllegalArgumentException if image is null * @throws Exception if the image does not meet current server server-icon * specifications - * @return a cached server-icon that can be used for a {@link - * ServerListPingEvent#setServerIcon(CachedServerIcon)} */ @NotNull public static CachedServerIcon loadServerIcon(@NotNull File file) throws IllegalArgumentException, Exception { @@ -1296,11 +1296,11 @@ public final class Bukkit { * guaranteed to throw an implementation-defined {@link Exception}. * * @param image the image to use + * @return a cached server-icon that can be used for a {@link + * ServerListPingEvent#setServerIcon(CachedServerIcon)} * @throws IllegalArgumentException if image is null * @throws Exception if the image does not meet current server * server-icon specifications - * @return a cached server-icon that can be used for a {@link - * ServerListPingEvent#setServerIcon(CachedServerIcon)} */ @NotNull public static CachedServerIcon loadServerIcon(@NotNull BufferedImage image) throws IllegalArgumentException, Exception { @@ -1599,8 +1599,8 @@ public final class Bukkit { } /** - * @see UnsafeValues * @return the unsafe values instance + * @see UnsafeValues */ @Deprecated @NotNull diff --git a/paper-api/src/main/java/org/bukkit/FireworkEffect.java b/paper-api/src/main/java/org/bukkit/FireworkEffect.java index 0ae437c0c..4a97e73ce 100644 --- a/paper-api/src/main/java/org/bukkit/FireworkEffect.java +++ b/paper-api/src/main/java/org/bukkit/FireworkEffect.java @@ -365,9 +365,9 @@ public final class FireworkEffect implements ConfigurationSerializable { } /** - * @see ConfigurationSerializable * @param map the map to deserialize * @return the resulting serializable + * @see ConfigurationSerializable */ @NotNull public static ConfigurationSerializable deserialize(@NotNull Map map) { diff --git a/paper-api/src/main/java/org/bukkit/Location.java b/paper-api/src/main/java/org/bukkit/Location.java index 0939a8070..7c4db0514 100644 --- a/paper-api/src/main/java/org/bukkit/Location.java +++ b/paper-api/src/main/java/org/bukkit/Location.java @@ -339,10 +339,10 @@ public class Location implements Cloneable, ConfigurationSerializable { /** * Adds the location by another. * - * @see Vector * @param vec The other location * @return the same location * @throws IllegalArgumentException for differing worlds + * @see Vector */ @NotNull public Location add(@NotNull Location vec) { @@ -359,9 +359,9 @@ public class Location implements Cloneable, ConfigurationSerializable { /** * Adds the location by a vector. * - * @see Vector * @param vec Vector to use * @return the same location + * @see Vector */ @NotNull public Location add(@NotNull Vector vec) { @@ -374,11 +374,11 @@ public class Location implements Cloneable, ConfigurationSerializable { /** * Adds the location by another. Not world-aware. * - * @see Vector * @param x X coordinate * @param y Y coordinate * @param z Z coordinate * @return the same location + * @see Vector */ @NotNull public Location add(double x, double y, double z) { @@ -391,10 +391,10 @@ public class Location implements Cloneable, ConfigurationSerializable { /** * Subtracts the location by another. * - * @see Vector * @param vec The other location * @return the same location * @throws IllegalArgumentException for differing worlds + * @see Vector */ @NotNull public Location subtract(@NotNull Location vec) { @@ -411,9 +411,9 @@ public class Location implements Cloneable, ConfigurationSerializable { /** * Subtracts the location by a vector. * - * @see Vector * @param vec The vector to use * @return the same location + * @see Vector */ @NotNull public Location subtract(@NotNull Vector vec) { @@ -427,11 +427,11 @@ public class Location implements Cloneable, ConfigurationSerializable { * Subtracts the location by another. Not world-aware and * orientation independent. * - * @see Vector * @param x X coordinate * @param y Y coordinate * @param z Z coordinate * @return the same location + * @see Vector */ @NotNull public Location subtract(double x, double y, double z) { diff --git a/paper-api/src/main/java/org/bukkit/Server.java b/paper-api/src/main/java/org/bukkit/Server.java index 1b4dd8853..40e4036af 100644 --- a/paper-api/src/main/java/org/bukkit/Server.java +++ b/paper-api/src/main/java/org/bukkit/Server.java @@ -736,11 +736,11 @@ public interface Server extends PluginMessageRecipient { * This will return an object even if the player does not exist. To this * method, all players will exist. * - * @deprecated Persistent storage of users should be by UUID as names are no longer - * unique past a single session. * @param name the name the player to retrieve * @return an offline player * @see #getOfflinePlayer(java.util.UUID) + * @deprecated Persistent storage of users should be by UUID as names are no longer + * unique past a single session. */ @Deprecated @NotNull @@ -1067,11 +1067,11 @@ public interface Server extends PluginMessageRecipient { * guaranteed to throw an implementation-defined {@link Exception}. * * @param file the file to load the from + * @return a cached server-icon that can be used for a {@link + * ServerListPingEvent#setServerIcon(CachedServerIcon)} * @throws IllegalArgumentException if image is null * @throws Exception if the image does not meet current server server-icon * specifications - * @return a cached server-icon that can be used for a {@link - * ServerListPingEvent#setServerIcon(CachedServerIcon)} */ @NotNull CachedServerIcon loadServerIcon(@NotNull File file) throws IllegalArgumentException, Exception; @@ -1083,11 +1083,11 @@ public interface Server extends PluginMessageRecipient { * guaranteed to throw an implementation-defined {@link Exception}. * * @param image the image to use + * @return a cached server-icon that can be used for a {@link + * ServerListPingEvent#setServerIcon(CachedServerIcon)} * @throws IllegalArgumentException if image is null * @throws Exception if the image does not meet current server * server-icon specifications - * @return a cached server-icon that can be used for a {@link - * ServerListPingEvent#setServerIcon(CachedServerIcon)} */ @NotNull CachedServerIcon loadServerIcon(@NotNull BufferedImage image) throws IllegalArgumentException, Exception; @@ -1349,8 +1349,8 @@ public interface Server extends PluginMessageRecipient { List selectEntities(@NotNull CommandSender sender, @NotNull String selector) throws IllegalArgumentException; /** - * @see UnsafeValues * @return the unsafe values instance + * @see UnsafeValues */ @Deprecated @NotNull diff --git a/paper-api/src/main/java/org/bukkit/WorldCreator.java b/paper-api/src/main/java/org/bukkit/WorldCreator.java index 6e6945dd4..6774c8176 100644 --- a/paper-api/src/main/java/org/bukkit/WorldCreator.java +++ b/paper-api/src/main/java/org/bukkit/WorldCreator.java @@ -238,12 +238,12 @@ public class WorldCreator { * is as follows: * {"structures": {"structures": {"village": {"salt": 8015723, "spacing": 32, "separation": 8}}}, "layers": [{"block": "stone", "height": 1}, {"block": "grass", "height": 1}], "biome":"plains"} * - * @see Custom - * dimension (scroll to "When the generator ID type is - * minecraft:flat)" * @param generatorSettings The settings that should be used by the * generator * @return This object, for chaining + * @see Custom + * dimension (scroll to "When the generator ID type is + * minecraft:flat)" */ @NotNull public WorldCreator generatorSettings(@NotNull String generatorSettings) { diff --git a/paper-api/src/main/java/org/bukkit/block/Lectern.java b/paper-api/src/main/java/org/bukkit/block/Lectern.java index 78107207b..f835ddf0a 100644 --- a/paper-api/src/main/java/org/bukkit/block/Lectern.java +++ b/paper-api/src/main/java/org/bukkit/block/Lectern.java @@ -27,18 +27,16 @@ public interface Lectern extends TileState, BlockInventoryHolder { void setPage(int page); /** - * @see Container#getInventory() - * * @return inventory + * @see Container#getInventory() */ @NotNull @Override Inventory getInventory(); /** - * @see Container#getSnapshotInventory() - * * @return snapshot inventory + * @see Container#getSnapshotInventory() */ @NotNull Inventory getSnapshotInventory(); diff --git a/paper-api/src/main/java/org/bukkit/block/Sign.java b/paper-api/src/main/java/org/bukkit/block/Sign.java index a52dff9ef..ab6b0ec32 100644 --- a/paper-api/src/main/java/org/bukkit/block/Sign.java +++ b/paper-api/src/main/java/org/bukkit/block/Sign.java @@ -22,8 +22,8 @@ public interface Sign extends TileState, Colorable { * For example, getLine(0) will return the first line of text. * * @param index Line number to get the text from, starting at 0 - * @throws IndexOutOfBoundsException Thrown when the line does not exist * @return Text on the given line + * @throws IndexOutOfBoundsException Thrown when the line does not exist */ @NotNull public String getLine(int index) throws IndexOutOfBoundsException; diff --git a/paper-api/src/main/java/org/bukkit/entity/ArmorStand.java b/paper-api/src/main/java/org/bukkit/entity/ArmorStand.java index 26223028f..dc604d6ab 100644 --- a/paper-api/src/main/java/org/bukkit/entity/ArmorStand.java +++ b/paper-api/src/main/java/org/bukkit/entity/ArmorStand.java @@ -13,8 +13,8 @@ public interface ArmorStand extends LivingEntity { * Returns the item the armor stand is currently holding. * * @return the held item - * @deprecated prefer {@link EntityEquipment#getItemInHand()} * @see #getEquipment() + * @deprecated prefer {@link EntityEquipment#getItemInHand()} */ @NotNull @Deprecated @@ -24,9 +24,9 @@ public interface ArmorStand extends LivingEntity { * Sets the item the armor stand is currently holding. * * @param item the item to hold + * @see #getEquipment() * @deprecated prefer * {@link EntityEquipment#setItemInHand(org.bukkit.inventory.ItemStack)} - * @see #getEquipment() */ @Deprecated void setItemInHand(@Nullable ItemStack item); @@ -35,8 +35,8 @@ public interface ArmorStand extends LivingEntity { * Returns the item currently being worn by the armor stand on its feet. * * @return the worn item - * @deprecated prefer {@link EntityEquipment#getBoots()} * @see #getEquipment() + * @deprecated prefer {@link EntityEquipment#getBoots()} */ @NotNull @Deprecated @@ -46,9 +46,9 @@ public interface ArmorStand extends LivingEntity { * Sets the item currently being worn by the armor stand on its feet. * * @param item the item to wear + * @see #getEquipment() * @deprecated prefer * {@link EntityEquipment#setBoots(org.bukkit.inventory.ItemStack)} - * @see #getEquipment() */ @Deprecated void setBoots(@Nullable ItemStack item); @@ -57,8 +57,8 @@ public interface ArmorStand extends LivingEntity { * Returns the item currently being worn by the armor stand on its legs. * * @return the worn item - * @deprecated prefer {@link EntityEquipment#getLeggings()} * @see #getEquipment() + * @deprecated prefer {@link EntityEquipment#getLeggings()} */ @NotNull @Deprecated @@ -68,9 +68,9 @@ public interface ArmorStand extends LivingEntity { * Sets the item currently being worn by the armor stand on its legs. * * @param item the item to wear + * @see #getEquipment() * @deprecated prefer * {@link EntityEquipment#setLeggings(org.bukkit.inventory.ItemStack)} - * @see #getEquipment() */ @Deprecated void setLeggings(@Nullable ItemStack item); @@ -79,8 +79,8 @@ public interface ArmorStand extends LivingEntity { * Returns the item currently being worn by the armor stand on its chest. * * @return the worn item - * @deprecated prefer {@link EntityEquipment#getChestplate()} * @see #getEquipment() + * @deprecated prefer {@link EntityEquipment#getChestplate()} */ @NotNull @Deprecated @@ -90,9 +90,9 @@ public interface ArmorStand extends LivingEntity { * Sets the item currently being worn by the armor stand on its chest. * * @param item the item to wear + * @see #getEquipment() * @deprecated prefer * {@link EntityEquipment#setChestplate(org.bukkit.inventory.ItemStack)} - * @see #getEquipment() */ @Deprecated void setChestplate(@Nullable ItemStack item); @@ -101,8 +101,8 @@ public interface ArmorStand extends LivingEntity { * Returns the item currently being worn by the armor stand on its head. * * @return the worn item - * @deprecated prefer {@link EntityEquipment#getHelmet()} * @see #getEquipment() + * @deprecated prefer {@link EntityEquipment#getHelmet()} */ @NotNull @Deprecated @@ -112,9 +112,9 @@ public interface ArmorStand extends LivingEntity { * Sets the item currently being worn by the armor stand on its head. * * @param item the item to wear + * @see #getEquipment() * @deprecated prefer * {@link EntityEquipment#setHelmet(org.bukkit.inventory.ItemStack)} - * @see #getEquipment() */ @Deprecated void setHelmet(@Nullable ItemStack item); diff --git a/paper-api/src/main/java/org/bukkit/event/block/CauldronLevelChangeEvent.java b/paper-api/src/main/java/org/bukkit/event/block/CauldronLevelChangeEvent.java index 2519e3eb9..668cc4b7d 100644 --- a/paper-api/src/main/java/org/bukkit/event/block/CauldronLevelChangeEvent.java +++ b/paper-api/src/main/java/org/bukkit/event/block/CauldronLevelChangeEvent.java @@ -57,8 +57,8 @@ public class CauldronLevelChangeEvent extends BlockEvent implements Cancellable * Gets the old level of the cauldron. * * @return old level - * @deprecated not all cauldron contents are Levelled * @see #getBlock() + * @deprecated not all cauldron contents are Levelled */ @Deprecated public int getOldLevel() { @@ -70,8 +70,8 @@ public class CauldronLevelChangeEvent extends BlockEvent implements Cancellable * Gets the new level of the cauldron. * * @return new level - * @deprecated not all cauldron contents are Levelled * @see #getNewState() + * @deprecated not all cauldron contents are Levelled */ @Deprecated public int getNewLevel() { @@ -83,8 +83,8 @@ public class CauldronLevelChangeEvent extends BlockEvent implements Cancellable * Sets the new level of the cauldron. * * @param newLevel new level - * @deprecated not all cauldron contents are Levelled * @see #getNewState() + * @deprecated not all cauldron contents are Levelled */ @Deprecated public void setNewLevel(int newLevel) { diff --git a/paper-api/src/main/java/org/bukkit/event/inventory/InventoryClickEvent.java b/paper-api/src/main/java/org/bukkit/event/inventory/InventoryClickEvent.java index d28bf1fc0..79797a2be 100644 --- a/paper-api/src/main/java/org/bukkit/event/inventory/InventoryClickEvent.java +++ b/paper-api/src/main/java/org/bukkit/event/inventory/InventoryClickEvent.java @@ -165,8 +165,8 @@ public class InventoryClickEvent extends InventoryInteractEvent { /** * Gets the inventory corresponding to the clicked slot. * - * @see InventoryView#getInventory(int) * @return inventory, or null if clicked outside + * @see InventoryView#getInventory(int) */ @Nullable public Inventory getClickedInventory() { diff --git a/paper-api/src/main/java/org/bukkit/event/player/AsyncPlayerPreLoginEvent.java b/paper-api/src/main/java/org/bukkit/event/player/AsyncPlayerPreLoginEvent.java index c8384da69..9866c07c9 100644 --- a/paper-api/src/main/java/org/bukkit/event/player/AsyncPlayerPreLoginEvent.java +++ b/paper-api/src/main/java/org/bukkit/event/player/AsyncPlayerPreLoginEvent.java @@ -47,9 +47,9 @@ public class AsyncPlayerPreLoginEvent extends Event { * Gets the current result of the login, as an enum * * @return Current Result of the login + * @see #getLoginResult() * @deprecated This method uses a deprecated enum from {@link * PlayerPreLoginEvent} - * @see #getLoginResult() */ @Deprecated @NotNull @@ -70,9 +70,9 @@ public class AsyncPlayerPreLoginEvent extends Event { * Sets the new result of the login, as an enum * * @param result New result to set + * @see #setLoginResult(Result) * @deprecated This method uses a deprecated enum from {@link * PlayerPreLoginEvent} - * @see #setLoginResult(Result) */ @Deprecated public void setResult(@NotNull final PlayerPreLoginEvent.Result result) { @@ -123,9 +123,9 @@ public class AsyncPlayerPreLoginEvent extends Event { * * @param result New result for disallowing the player * @param message Kick message to display to the user + * @see #disallow(Result, String) * @deprecated This method uses a deprecated enum from {@link * PlayerPreLoginEvent} - * @see #disallow(Result, String) */ @Deprecated public void disallow(@NotNull final PlayerPreLoginEvent.Result result, @NotNull final String message) { diff --git a/paper-api/src/main/java/org/bukkit/event/player/PlayerCommandPreprocessEvent.java b/paper-api/src/main/java/org/bukkit/event/player/PlayerCommandPreprocessEvent.java index a6dae9107..35614db42 100644 --- a/paper-api/src/main/java/org/bukkit/event/player/PlayerCommandPreprocessEvent.java +++ b/paper-api/src/main/java/org/bukkit/event/player/PlayerCommandPreprocessEvent.java @@ -122,9 +122,9 @@ public class PlayerCommandPreprocessEvent extends PlayerEvent implements Cancell * UnsupportedOperationException} if the event caller provides an * unmodifiable set. * + * @return All Players who will see this chat message * @deprecated This method is provided for backward compatibility with no * guarantee to the effect of viewing or modifying the set. - * @return All Players who will see this chat message */ @NotNull @Deprecated diff --git a/paper-api/src/main/java/org/bukkit/event/player/PlayerLocaleChangeEvent.java b/paper-api/src/main/java/org/bukkit/event/player/PlayerLocaleChangeEvent.java index 1db386bb7..36b436e14 100644 --- a/paper-api/src/main/java/org/bukkit/event/player/PlayerLocaleChangeEvent.java +++ b/paper-api/src/main/java/org/bukkit/event/player/PlayerLocaleChangeEvent.java @@ -19,9 +19,8 @@ public class PlayerLocaleChangeEvent extends PlayerEvent { } /** - * @see Player#getLocale() - * * @return the player's new locale + * @see Player#getLocale() */ @NotNull public String getLocale() { diff --git a/paper-api/src/main/java/org/bukkit/help/HelpTopicComparator.java b/paper-api/src/main/java/org/bukkit/help/HelpTopicComparator.java index 75bb69283..e1f4930f4 100644 --- a/paper-api/src/main/java/org/bukkit/help/HelpTopicComparator.java +++ b/paper-api/src/main/java/org/bukkit/help/HelpTopicComparator.java @@ -32,7 +32,7 @@ public final class HelpTopicComparator implements Comparator { } public static final class TopicNameComparator implements Comparator { - private TopicNameComparator(){} + private TopicNameComparator() {} @Override public int compare(@NotNull String lhs, @NotNull String rhs) { diff --git a/paper-api/src/main/java/org/bukkit/inventory/EntityEquipment.java b/paper-api/src/main/java/org/bukkit/inventory/EntityEquipment.java index e85c4208f..d5b50a4a9 100644 --- a/paper-api/src/main/java/org/bukkit/inventory/EntityEquipment.java +++ b/paper-api/src/main/java/org/bukkit/inventory/EntityEquipment.java @@ -87,11 +87,11 @@ public interface EntityEquipment { /** * Gets a copy of the item the entity is currently holding * - * @deprecated entities can duel wield now use the methods for the - * specific hand instead + * @return the currently held item * @see #getItemInMainHand() * @see #getItemInOffHand() - * @return the currently held item + * @deprecated entities can duel wield now use the methods for the + * specific hand instead */ @Deprecated @NotNull @@ -100,11 +100,11 @@ public interface EntityEquipment { /** * Sets the item the entity is holding * - * @deprecated entities can duel wield now use the methods for the - * specific hand instead + * @param stack The item to put into the entities hand * @see #setItemInMainHand(ItemStack) * @see #setItemInOffHand(ItemStack) - * @param stack The item to put into the entities hand + * @deprecated entities can duel wield now use the methods for the + * specific hand instead */ @Deprecated void setItemInHand(@Nullable ItemStack stack); @@ -222,21 +222,21 @@ public interface EntityEquipment { void clear(); /** - * @deprecated entities can duel wield now use the methods for the specific - * hand instead + * @return drop chance * @see #getItemInMainHandDropChance() * @see #getItemInOffHandDropChance() - * @return drop chance + * @deprecated entities can duel wield now use the methods for the specific + * hand instead */ @Deprecated float getItemInHandDropChance(); /** - * @deprecated entities can duel wield now use the methods for the specific - * hand instead + * @param chance drop chance * @see #setItemInMainHandDropChance(float) * @see #setItemInOffHandDropChance(float) - * @param chance drop chance + * @deprecated entities can duel wield now use the methods for the specific + * hand instead */ @Deprecated void setItemInHandDropChance(float chance); diff --git a/paper-api/src/main/java/org/bukkit/inventory/PlayerInventory.java b/paper-api/src/main/java/org/bukkit/inventory/PlayerInventory.java index 91afd844d..99d900b23 100644 --- a/paper-api/src/main/java/org/bukkit/inventory/PlayerInventory.java +++ b/paper-api/src/main/java/org/bukkit/inventory/PlayerInventory.java @@ -192,11 +192,11 @@ public interface PlayerInventory extends Inventory { /** * Gets a copy of the item the player is currently holding * - * @deprecated players can duel wield now use the methods for the - * specific hand instead + * @return the currently held item * @see #getItemInMainHand() * @see #getItemInOffHand() - * @return the currently held item + * @deprecated players can duel wield now use the methods for the + * specific hand instead */ @Deprecated @NotNull @@ -205,11 +205,11 @@ public interface PlayerInventory extends Inventory { /** * Sets the item the player is holding * - * @deprecated players can duel wield now use the methods for the - * specific hand instead + * @param stack The item to put into the player's hand * @see #setItemInMainHand(ItemStack) * @see #setItemInOffHand(ItemStack) - * @param stack The item to put into the player's hand + * @deprecated players can duel wield now use the methods for the + * specific hand instead */ @Deprecated public void setItemInHand(@Nullable ItemStack stack); diff --git a/paper-api/src/main/java/org/bukkit/inventory/meta/MapMeta.java b/paper-api/src/main/java/org/bukkit/inventory/meta/MapMeta.java index 8fca3ba23..347ec4230 100644 --- a/paper-api/src/main/java/org/bukkit/inventory/meta/MapMeta.java +++ b/paper-api/src/main/java/org/bukkit/inventory/meta/MapMeta.java @@ -15,12 +15,12 @@ public interface MapMeta extends ItemMeta { * Checks for existence of a map ID number. * * @return true if this has a map ID number. + * @see #hasMapView() * @deprecated These methods are poor API: They rely on the caller to pass * in an only an integer property, and have poorly defined implementation * behavior if that integer is not a valid map (the current implementation * for example will generate a new map with a different ID). The xxxMapView * family of methods should be used instead. - * @see #hasMapView() */ @Deprecated boolean hasMapId(); @@ -33,12 +33,12 @@ public interface MapMeta extends ItemMeta { * calling this method. * * @return the map ID that is set + * @see #getMapView() * @deprecated These methods are poor API: They rely on the caller to pass * in an only an integer property, and have poorly defined implementation * behavior if that integer is not a valid map (the current implementation * for example will generate a new map with a different ID). The xxxMapView * family of methods should be used instead. - * @see #getMapView() */ @Deprecated int getMapId(); @@ -47,12 +47,12 @@ public interface MapMeta extends ItemMeta { * Sets the map ID. This is used to determine what map is displayed. * * @param id the map id to set + * @see #setMapView(org.bukkit.map.MapView) * @deprecated These methods are poor API: They rely on the caller to pass * in an only an integer property, and have poorly defined implementation * behavior if that integer is not a valid map (the current implementation * for example will generate a new map with a different ID). The xxxMapView * family of methods should be used instead. - * @see #setMapView(org.bukkit.map.MapView) */ @Deprecated void setMapId(int id); diff --git a/paper-api/src/main/java/org/bukkit/potion/Potion.java b/paper-api/src/main/java/org/bukkit/potion/Potion.java index b9dbbfd07..2184c8620 100644 --- a/paper-api/src/main/java/org/bukkit/potion/Potion.java +++ b/paper-api/src/main/java/org/bukkit/potion/Potion.java @@ -141,9 +141,9 @@ public class Potion { * Returns a collection of {@link PotionEffect}s that this {@link Potion} * would confer upon a {@link LivingEntity}. * + * @return The effects that this potion applies * @see PotionBrewer#getEffectsFromDamage(int) * @see Potion#toDamageValue() - * @return The effects that this potion applies */ @NotNull public Collection getEffects() { diff --git a/paper-api/src/main/java/org/bukkit/potion/PotionEffectType.java b/paper-api/src/main/java/org/bukkit/potion/PotionEffectType.java index b5790aaac..3c005c505 100644 --- a/paper-api/src/main/java/org/bukkit/potion/PotionEffectType.java +++ b/paper-api/src/main/java/org/bukkit/potion/PotionEffectType.java @@ -184,10 +184,10 @@ public abstract class PotionEffectType { * Creates a PotionEffect from this PotionEffectType, applying duration * modifiers and checks. * - * @see PotionBrewer#createEffect(PotionEffectType, int, int) * @param duration time in ticks * @param amplifier the effect's amplifier * @return a resulting potion effect + * @see PotionBrewer#createEffect(PotionEffectType, int, int) */ @NotNull public PotionEffect createEffect(int duration, int amplifier) { diff --git a/paper-api/src/main/java/org/bukkit/scheduler/BukkitScheduler.java b/paper-api/src/main/java/org/bukkit/scheduler/BukkitScheduler.java index ac140fc2c..c239c4de6 100644 --- a/paper-api/src/main/java/org/bukkit/scheduler/BukkitScheduler.java +++ b/paper-api/src/main/java/org/bukkit/scheduler/BukkitScheduler.java @@ -22,11 +22,11 @@ public interface BukkitScheduler { public int scheduleSyncDelayedTask(@NotNull Plugin plugin, @NotNull Runnable task, long delay); /** - * @deprecated Use {@link BukkitRunnable#runTaskLater(Plugin, long)} * @param plugin Plugin that owns the task * @param task Task to be executed * @param delay Delay in server ticks before executing task * @return Task id number (-1 if scheduling failed) + * @deprecated Use {@link BukkitRunnable#runTaskLater(Plugin, long)} */ @Deprecated public int scheduleSyncDelayedTask(@NotNull Plugin plugin, @NotNull BukkitRunnable task, long delay); @@ -43,10 +43,10 @@ public interface BukkitScheduler { public int scheduleSyncDelayedTask(@NotNull Plugin plugin, @NotNull Runnable task); /** - * @deprecated Use {@link BukkitRunnable#runTask(Plugin)} * @param plugin Plugin that owns the task * @param task Task to be executed * @return Task id number (-1 if scheduling failed) + * @deprecated Use {@link BukkitRunnable#runTask(Plugin)} */ @Deprecated public int scheduleSyncDelayedTask(@NotNull Plugin plugin, @NotNull BukkitRunnable task); @@ -65,12 +65,12 @@ public interface BukkitScheduler { public int scheduleSyncRepeatingTask(@NotNull Plugin plugin, @NotNull Runnable task, long delay, long period); /** - * @deprecated Use {@link BukkitRunnable#runTaskTimer(Plugin, long, long)} * @param plugin Plugin that owns the task * @param task Task to be executed * @param delay Delay in server ticks before executing first repeat * @param period Period in server ticks of the task * @return Task id number (-1 if scheduling failed) + * @deprecated Use {@link BukkitRunnable#runTaskTimer(Plugin, long, long)} */ @Deprecated public int scheduleSyncRepeatingTask(@NotNull Plugin plugin, @NotNull BukkitRunnable task, long delay, long period); @@ -230,13 +230,12 @@ public interface BukkitScheduler { public void runTask(@NotNull Plugin plugin, @NotNull Consumer task) throws IllegalArgumentException; /** - * @deprecated Use {@link BukkitRunnable#runTask(Plugin)} - * * @param plugin the reference to the plugin scheduling task * @param task the task to be run * @return a BukkitTask that contains the id number * @throws IllegalArgumentException if plugin is null * @throws IllegalArgumentException if task is null + * @deprecated Use {@link BukkitRunnable#runTask(Plugin)} */ @Deprecated @NotNull @@ -271,12 +270,12 @@ public interface BukkitScheduler { public void runTaskAsynchronously(@NotNull Plugin plugin, @NotNull Consumer task) throws IllegalArgumentException; /** - * @deprecated Use {@link BukkitRunnable#runTaskAsynchronously(Plugin)} * @param plugin the reference to the plugin scheduling task * @param task the task to be run * @return a BukkitTask that contains the id number * @throws IllegalArgumentException if plugin is null * @throws IllegalArgumentException if task is null + * @deprecated Use {@link BukkitRunnable#runTaskAsynchronously(Plugin)} */ @Deprecated @NotNull @@ -309,13 +308,13 @@ public interface BukkitScheduler { public void runTaskLater(@NotNull Plugin plugin, @NotNull Consumer task, long delay) throws IllegalArgumentException; /** - * @deprecated Use {@link BukkitRunnable#runTaskLater(Plugin, long)} * @param plugin the reference to the plugin scheduling task * @param task the task to be run * @param delay the ticks to wait before running the task * @return a BukkitTask that contains the id number * @throws IllegalArgumentException if plugin is null * @throws IllegalArgumentException if task is null + * @deprecated Use {@link BukkitRunnable#runTaskLater(Plugin, long)} */ @Deprecated @NotNull @@ -354,13 +353,13 @@ public interface BukkitScheduler { public void runTaskLaterAsynchronously(@NotNull Plugin plugin, @NotNull Consumer task, long delay) throws IllegalArgumentException; /** - * @deprecated Use {@link BukkitRunnable#runTaskLaterAsynchronously(Plugin, long)} * @param plugin the reference to the plugin scheduling task * @param task the task to be run * @param delay the ticks to wait before running the task * @return a BukkitTask that contains the id number * @throws IllegalArgumentException if plugin is null * @throws IllegalArgumentException if task is null + * @deprecated Use {@link BukkitRunnable#runTaskLaterAsynchronously(Plugin, long)} */ @Deprecated @NotNull @@ -395,7 +394,6 @@ public interface BukkitScheduler { public void runTaskTimer(@NotNull Plugin plugin, @NotNull Consumer task, long delay, long period) throws IllegalArgumentException; /** - * @deprecated Use {@link BukkitRunnable#runTaskTimer(Plugin, long, long)} * @param plugin the reference to the plugin scheduling task * @param task the task to be run * @param delay the ticks to wait before running the task @@ -403,6 +401,7 @@ public interface BukkitScheduler { * @return a BukkitTask that contains the id number * @throws IllegalArgumentException if plugin is null * @throws IllegalArgumentException if task is null + * @deprecated Use {@link BukkitRunnable#runTaskTimer(Plugin, long, long)} */ @Deprecated @NotNull @@ -445,7 +444,6 @@ public interface BukkitScheduler { public void runTaskTimerAsynchronously(@NotNull Plugin plugin, @NotNull Consumer task, long delay, long period) throws IllegalArgumentException; /** - * @deprecated Use {@link BukkitRunnable#runTaskTimerAsynchronously(Plugin, long, long)} * @param plugin the reference to the plugin scheduling task * @param task the task to be run * @param delay the ticks to wait before running the task for the first @@ -454,6 +452,7 @@ public interface BukkitScheduler { * @return a BukkitTask that contains the id number * @throws IllegalArgumentException if plugin is null * @throws IllegalArgumentException if task is null + * @deprecated Use {@link BukkitRunnable#runTaskTimerAsynchronously(Plugin, long, long)} */ @Deprecated @NotNull diff --git a/paper-api/src/main/java/org/bukkit/scoreboard/Objective.java b/paper-api/src/main/java/org/bukkit/scoreboard/Objective.java index f5cbf6df3..7277f62d7 100644 --- a/paper-api/src/main/java/org/bukkit/scoreboard/Objective.java +++ b/paper-api/src/main/java/org/bukkit/scoreboard/Objective.java @@ -116,8 +116,8 @@ public interface Objective { * @return Score tracking the Objective and player specified * @throws IllegalArgumentException if player is null * @throws IllegalStateException if this objective has been unregistered - * @deprecated Scoreboards can contain entries that aren't players * @see #getScore(String) + * @deprecated Scoreboards can contain entries that aren't players */ @Deprecated @NotNull diff --git a/paper-api/src/main/java/org/bukkit/scoreboard/Score.java b/paper-api/src/main/java/org/bukkit/scoreboard/Score.java index f4e626f92..d25b4d049 100644 --- a/paper-api/src/main/java/org/bukkit/scoreboard/Score.java +++ b/paper-api/src/main/java/org/bukkit/scoreboard/Score.java @@ -15,8 +15,8 @@ public interface Score { * Gets the OfflinePlayer being tracked by this Score * * @return this Score's tracked player - * @deprecated Scoreboards can contain entries that aren't players * @see #getEntry() + * @deprecated Scoreboards can contain entries that aren't players */ @Deprecated @NotNull diff --git a/paper-api/src/main/java/org/bukkit/scoreboard/Scoreboard.java b/paper-api/src/main/java/org/bukkit/scoreboard/Scoreboard.java index 4bfaaea78..d283f6947 100644 --- a/paper-api/src/main/java/org/bukkit/scoreboard/Scoreboard.java +++ b/paper-api/src/main/java/org/bukkit/scoreboard/Scoreboard.java @@ -116,8 +116,8 @@ public interface Scoreboard { * @param player the player whose scores are being retrieved * @return immutable set of all scores tracked for the player * @throws IllegalArgumentException if player is null - * @deprecated Scoreboards can contain entries that aren't players * @see #getScores(String) + * @deprecated Scoreboards can contain entries that aren't players */ @Deprecated @NotNull @@ -138,8 +138,8 @@ public interface Scoreboard { * * @param player the player to drop all current scores for * @throws IllegalArgumentException if player is null - * @deprecated Scoreboards can contain entries that aren't players * @see #resetScores(String) + * @deprecated Scoreboards can contain entries that aren't players */ @Deprecated void resetScores(@NotNull OfflinePlayer player) throws IllegalArgumentException; @@ -158,8 +158,8 @@ public interface Scoreboard { * @param player the player to search for * @return the player's Team or null if the player is not on a team * @throws IllegalArgumentException if player is null - * @deprecated Scoreboards can contain entries that aren't players * @see #getEntryTeam(String) + * @deprecated Scoreboards can contain entries that aren't players */ @Deprecated @Nullable @@ -208,8 +208,8 @@ public interface Scoreboard { * Gets all players tracked by this Scoreboard * * @return immutable set of all tracked players - * @deprecated Scoreboards can contain entries that aren't players * @see #getEntries() + * @deprecated Scoreboards can contain entries that aren't players */ @Deprecated @NotNull diff --git a/paper-api/src/main/java/org/bukkit/scoreboard/Team.java b/paper-api/src/main/java/org/bukkit/scoreboard/Team.java index da01d2926..0db7fe1b9 100644 --- a/paper-api/src/main/java/org/bukkit/scoreboard/Team.java +++ b/paper-api/src/main/java/org/bukkit/scoreboard/Team.java @@ -165,9 +165,9 @@ public interface Team { * Gets the Set of players on the team * * @return players on the team - * @throws IllegalStateException if this team has been unregistered\ - * @deprecated Teams can contain entries that aren't players + * @throws IllegalStateException if this team has been unregistered * @see #getEntries() + * @deprecated Teams can contain entries that aren't players */ @Deprecated @NotNull @@ -207,8 +207,8 @@ public interface Team { * @param player the player to add * @throws IllegalArgumentException if player is null * @throws IllegalStateException if this team has been unregistered - * @deprecated Teams can contain entries that aren't players * @see #addEntry(String) + * @deprecated Teams can contain entries that aren't players */ @Deprecated void addPlayer(@NotNull OfflinePlayer player) throws IllegalStateException, IllegalArgumentException; @@ -231,8 +231,8 @@ public interface Team { * @return if the player was on this team * @throws IllegalArgumentException if player is null * @throws IllegalStateException if this team has been unregistered - * @deprecated Teams can contain entries that aren't players * @see #removeEntry(String) + * @deprecated Teams can contain entries that aren't players */ @Deprecated boolean removePlayer(@NotNull OfflinePlayer player) throws IllegalStateException, IllegalArgumentException; @@ -261,8 +261,8 @@ public interface Team { * @return true if the player is a member of this team * @throws IllegalArgumentException if player is null * @throws IllegalStateException if this team has been unregistered - * @deprecated Teams can contain entries that aren't players * @see #hasEntry(String) + * @deprecated Teams can contain entries that aren't players */ @Deprecated boolean hasPlayer(@NotNull OfflinePlayer player) throws IllegalArgumentException, IllegalStateException;