From 044a0c5c0dcb639e930a02b509d01644ec7c501f Mon Sep 17 00:00:00 2001 From: tastybento Date: Mon, 31 May 2021 16:01:21 -0700 Subject: [PATCH] Fix JavaDoc --- .../api/commands/ConfirmableCommand.java | 6 +++--- .../api/commands/DelayedTeleportCommand.java | 6 +++--- .../api/events/island/IslandEvent.java | 1 - .../api/panels/builders/PanelBuilder.java | 2 +- .../database/yaml/YamlDatabaseHandler.java | 2 -- .../PortalTeleportationListener.java | 19 +++++++++---------- .../util/teleport/SafeSpotTeleport.java | 2 +- 7 files changed, 17 insertions(+), 21 deletions(-) diff --git a/src/main/java/world/bentobox/bentobox/api/commands/ConfirmableCommand.java b/src/main/java/world/bentobox/bentobox/api/commands/ConfirmableCommand.java index 37ca93578..5b735b1ab 100644 --- a/src/main/java/world/bentobox/bentobox/api/commands/ConfirmableCommand.java +++ b/src/main/java/world/bentobox/bentobox/api/commands/ConfirmableCommand.java @@ -44,9 +44,9 @@ public abstract class ConfirmableCommand extends CompositeCommand { /** * - * @param parent - * @param label - * @param aliases + * @param parent - parent command + * @param label - command label + * @param aliases - command aliases */ protected ConfirmableCommand(CompositeCommand parent, String label, String... aliases) { super(parent, label, aliases); diff --git a/src/main/java/world/bentobox/bentobox/api/commands/DelayedTeleportCommand.java b/src/main/java/world/bentobox/bentobox/api/commands/DelayedTeleportCommand.java index 643e75637..490097099 100644 --- a/src/main/java/world/bentobox/bentobox/api/commands/DelayedTeleportCommand.java +++ b/src/main/java/world/bentobox/bentobox/api/commands/DelayedTeleportCommand.java @@ -78,9 +78,9 @@ public abstract class DelayedTeleportCommand extends CompositeCommand implements /** * - * @param parent - * @param label - * @param aliases + * @param parent - parent command + * @param label - command label + * @param aliases - command aliases */ protected DelayedTeleportCommand(CompositeCommand parent, String label, String... aliases) { super(parent, label, aliases); diff --git a/src/main/java/world/bentobox/bentobox/api/events/island/IslandEvent.java b/src/main/java/world/bentobox/bentobox/api/events/island/IslandEvent.java index 6e3de559c..b957b127f 100644 --- a/src/main/java/world/bentobox/bentobox/api/events/island/IslandEvent.java +++ b/src/main/java/world/bentobox/bentobox/api/events/island/IslandEvent.java @@ -358,7 +358,6 @@ public class IslandEvent extends IslandBaseEvent { * that the island blocks are going to be removed. * * @deprecated This event is moving to its own class. - * Use {@link world.bentobox.bentobox.api.events.island. * */ @Deprecated diff --git a/src/main/java/world/bentobox/bentobox/api/panels/builders/PanelBuilder.java b/src/main/java/world/bentobox/bentobox/api/panels/builders/PanelBuilder.java index 5b89ec22e..0aef22784 100644 --- a/src/main/java/world/bentobox/bentobox/api/panels/builders/PanelBuilder.java +++ b/src/main/java/world/bentobox/bentobox/api/panels/builders/PanelBuilder.java @@ -119,7 +119,7 @@ public class PanelBuilder { /** * Set the game world that applies this panel - * @param world + * @param world - world where this panel will be shown * @return PanelBuilder */ public PanelBuilder world(World world) { diff --git a/src/main/java/world/bentobox/bentobox/database/yaml/YamlDatabaseHandler.java b/src/main/java/world/bentobox/bentobox/database/yaml/YamlDatabaseHandler.java index a014b5ea9..6cad6bd8d 100644 --- a/src/main/java/world/bentobox/bentobox/database/yaml/YamlDatabaseHandler.java +++ b/src/main/java/world/bentobox/bentobox/database/yaml/YamlDatabaseHandler.java @@ -158,7 +158,6 @@ public class YamlDatabaseHandler extends AbstractDatabaseHandler { continue; } // Get the getter and setters for this field using the JavaBeans system - //noinspection RedundantCast PropertyDescriptor propertyDescriptor = new PropertyDescriptor(field.getName(), dataObject); // Get the write method Method method = propertyDescriptor.getWriteMethod(); @@ -367,7 +366,6 @@ public class YamlDatabaseHandler extends AbstractDatabaseHandler { continue; } // Get the property descriptor for this field - //noinspection RedundantCast PropertyDescriptor propertyDescriptor = new PropertyDescriptor(field.getName(), dataObject); // Get the read method Method method = propertyDescriptor.getReadMethod(); diff --git a/src/main/java/world/bentobox/bentobox/listeners/PortalTeleportationListener.java b/src/main/java/world/bentobox/bentobox/listeners/PortalTeleportationListener.java index 544fc740d..495d4e1ab 100644 --- a/src/main/java/world/bentobox/bentobox/listeners/PortalTeleportationListener.java +++ b/src/main/java/world/bentobox/bentobox/listeners/PortalTeleportationListener.java @@ -59,7 +59,7 @@ public class PortalTeleportationListener implements Listener { /** * Fires the event if nether or end is disabled at the system level - * @param e + * @param e - EntityPortalEnterEvent */ @EventHandler(priority = EventPriority.NORMAL, ignoreCancelled = true) public void onPlayerPortal(EntityPortalEnterEvent e) { @@ -302,7 +302,7 @@ public class PortalTeleportationListener implements Listener { /** * Check if nether or end are generated - * @param gm - game mode + * @param overWorld - game world * @param env - environment * @return true or false */ @@ -312,7 +312,7 @@ public class PortalTeleportationListener implements Listener { /** * Check if nether or end islands are generated - * @param gm - game mode + * @param overWorld - over world * @param env - environment * @return true or false */ @@ -322,7 +322,7 @@ public class PortalTeleportationListener implements Listener { /** * Get the nether or end world - * @param gm - game mode + * @param overWorld - over world * @param env - environment * @return nether or end world */ @@ -332,7 +332,7 @@ public class PortalTeleportationListener implements Listener { /** * Check if the island has a nether or end island already - * @param gm - game mode + * @param i - island * @param env - environment * @return true or false */ @@ -342,7 +342,6 @@ public class PortalTeleportationListener implements Listener { /** * Check if the default nether or end are allowed by the server settings - * @param gm - game mode * @param env - environment * @return true or false */ @@ -383,10 +382,10 @@ public class PortalTeleportationListener implements Listener { /** * Handle teleport from or to standard nether or end - * @param e - * @param fromWorld - * @param overWorld - * @param env + * @param e - PlayerEntityPortalEvent + * @param fromWorld - from world + * @param overWorld - over world + * @param env - environment involved */ private void handleStandardNetherOrEnd(PlayerEntityPortalEvent e, World fromWorld, World overWorld, Environment env) { if (fromWorld.getEnvironment() != env) { diff --git a/src/main/java/world/bentobox/bentobox/util/teleport/SafeSpotTeleport.java b/src/main/java/world/bentobox/bentobox/util/teleport/SafeSpotTeleport.java index d85848013..7136461e4 100644 --- a/src/main/java/world/bentobox/bentobox/util/teleport/SafeSpotTeleport.java +++ b/src/main/java/world/bentobox/bentobox/util/teleport/SafeSpotTeleport.java @@ -342,7 +342,7 @@ public class SafeSpotTeleport { * Set the home name * @param homeName - home name * @return Builder - * @Since 1.16.0 + * @since 1.16.0 */ public Builder homeName(String homeName) { this.homeName = homeName;