From c70487a3eeb8b4f7152345f83c09fe21e873e123 Mon Sep 17 00:00:00 2001 From: Bukkit/Spigot Date: Thu, 9 Jun 2011 23:11:35 -0700 Subject: [PATCH] Cleaned up some Javadocs. By: sk89q --- paper-api/src/main/java/org/bukkit/World.java | 26 ++++++++++++------- .../main/java/org/bukkit/entity/Player.java | 16 +++++------- 2 files changed, 23 insertions(+), 19 deletions(-) diff --git a/paper-api/src/main/java/org/bukkit/World.java b/paper-api/src/main/java/org/bukkit/World.java index cda7cb3e22..912f2cd0d5 100644 --- a/paper-api/src/main/java/org/bukkit/World.java +++ b/paper-api/src/main/java/org/bukkit/World.java @@ -263,7 +263,7 @@ public interface World { /** * Creates a tree at the given {@link Location} * - * @param location Location to spawn the tree + * @param loc Location to spawn the tree * @param type Type of the tree to create * @param delegate A class to call for each block changed as a result of this method * @return true if the tree was created successfully, otherwise false @@ -281,7 +281,7 @@ public interface World { /** * Creates a storage minecart at the given {@link Location} * - * @param location Location to spawn the minecart + * @param loc Location to spawn the minecart * @return StorageMinecart created as a result of this method */ public StorageMinecart spawnStorageMinecart(Location loc); @@ -289,7 +289,7 @@ public interface World { /** * Creates a powered minecart at the given {@link Location} * - * @param location Location to spawn the minecart + * @param loc Location to spawn the minecart * @return PoweredMinecart created as a result of this method */ public PoweredMinecart spawnPoweredMinecart(Location loc); @@ -297,7 +297,7 @@ public interface World { /** * Creates a boat at the given {@link Location} * - * @param location Location to spawn the boat + * @param loc Location to spawn the boat * @return Boat created as a result of this method */ public Boat spawnBoat(Location loc); @@ -374,7 +374,10 @@ public interface World { /** * Sets the spawn location of the world - * + * + * @param x + * @param y + * @param z * @return True if it was successfully set. */ public boolean setSpawnLocation(int x, int y, int z); @@ -480,11 +483,14 @@ public interface World { public void setThunderDuration(int duration); /** - * Creates explosion at given coordinates with given power - * - * @param power The power of explosion, where 4F is TNT - * @return false if explosion was canceled, otherwise true - */ + * Creates explosion at given coordinates with given power + * + * @param x + * @param y + * @param z + * @param power The power of explosion, where 4F is TNT + * @return false if explosion was canceled, otherwise true + */ public boolean createExplosion(double x, double y, double z, float power); /** diff --git a/paper-api/src/main/java/org/bukkit/entity/Player.java b/paper-api/src/main/java/org/bukkit/entity/Player.java index ddfd0ed7a1..d4dd0884ea 100644 --- a/paper-api/src/main/java/org/bukkit/entity/Player.java +++ b/paper-api/src/main/java/org/bukkit/entity/Player.java @@ -26,8 +26,8 @@ public interface Player extends HumanEntity, CommandSender { * * Note that this name will not be displayed in game, only in chat and places * defined by plugins - * - * @return String containing a color formatted name to display for this player + * + * @return the friendly name */ public String getDisplayName(); @@ -36,8 +36,8 @@ public interface Player extends HumanEntity, CommandSender { * * Note that this name will not be displayed in game, only in chat and places * defined by plugins - * - * @return String containing a color formatted name to display for this player + * + * @param name */ public void setDisplayName(String name); @@ -70,8 +70,8 @@ public interface Player extends HumanEntity, CommandSender { /** * Kicks player with custom kick message. - * - * @return + * + * @param message kick message */ public void kickPlayer(String message); @@ -139,7 +139,6 @@ public interface Player extends HumanEntity, CommandSender { * @param loc * @param instrument * @param note - * @return */ public void playNote(Location loc, byte instrument, byte note); @@ -194,10 +193,9 @@ public interface Player extends HumanEntity, CommandSender { /** * Forces an update of the player's entire inventory. * - * @return - * * @deprecated This method should not be relied upon as it is a temporary work-around for a larger, more complicated issue. */ + @Deprecated public void updateInventory(); /**