13
0
geforkt von Mirrors/Paper

Cleaned up some Javadocs.

By: sk89q <the.sk89q@gmail.com>
Dieser Commit ist enthalten in:
Bukkit/Spigot 2011-06-09 23:11:35 -07:00
Ursprung 4cc21b5ce6
Commit c70487a3ee
2 geänderte Dateien mit 23 neuen und 19 gelöschten Zeilen

Datei anzeigen

@ -263,7 +263,7 @@ public interface World {
/** /**
* Creates a tree at the given {@link Location} * 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 type Type of the tree to create
* @param delegate A class to call for each block changed as a result of this method * @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 * @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} * 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 * @return StorageMinecart created as a result of this method
*/ */
public StorageMinecart spawnStorageMinecart(Location loc); public StorageMinecart spawnStorageMinecart(Location loc);
@ -289,7 +289,7 @@ public interface World {
/** /**
* Creates a powered minecart at the given {@link Location} * 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 * @return PoweredMinecart created as a result of this method
*/ */
public PoweredMinecart spawnPoweredMinecart(Location loc); public PoweredMinecart spawnPoweredMinecart(Location loc);
@ -297,7 +297,7 @@ public interface World {
/** /**
* Creates a boat at the given {@link Location} * 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 * @return Boat created as a result of this method
*/ */
public Boat spawnBoat(Location loc); public Boat spawnBoat(Location loc);
@ -375,6 +375,9 @@ public interface World {
/** /**
* Sets the spawn location of the world * Sets the spawn location of the world
* *
* @param x
* @param y
* @param z
* @return True if it was successfully set. * @return True if it was successfully set.
*/ */
public boolean setSpawnLocation(int x, int y, int z); public boolean setSpawnLocation(int x, int y, int z);
@ -482,6 +485,9 @@ public interface World {
/** /**
* Creates explosion at given coordinates with given power * Creates explosion at given coordinates with given power
* *
* @param x
* @param y
* @param z
* @param power The power of explosion, where 4F is TNT * @param power The power of explosion, where 4F is TNT
* @return false if explosion was canceled, otherwise true * @return false if explosion was canceled, otherwise true
*/ */

Datei anzeigen

@ -27,7 +27,7 @@ public interface Player extends HumanEntity, CommandSender {
* Note that this name will not be displayed in game, only in chat and places * Note that this name will not be displayed in game, only in chat and places
* defined by plugins * defined by plugins
* *
* @return String containing a color formatted name to display for this player * @return the friendly name
*/ */
public String getDisplayName(); public String getDisplayName();
@ -37,7 +37,7 @@ public interface Player extends HumanEntity, CommandSender {
* Note that this name will not be displayed in game, only in chat and places * Note that this name will not be displayed in game, only in chat and places
* defined by plugins * defined by plugins
* *
* @return String containing a color formatted name to display for this player * @param name
*/ */
public void setDisplayName(String name); public void setDisplayName(String name);
@ -71,7 +71,7 @@ public interface Player extends HumanEntity, CommandSender {
/** /**
* Kicks player with custom kick message. * Kicks player with custom kick message.
* *
* @return * @param message kick message
*/ */
public void kickPlayer(String message); public void kickPlayer(String message);
@ -139,7 +139,6 @@ public interface Player extends HumanEntity, CommandSender {
* @param loc * @param loc
* @param instrument * @param instrument
* @param note * @param note
* @return
*/ */
public void playNote(Location loc, byte instrument, byte note); 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. * 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 This method should not be relied upon as it is a temporary work-around for a larger, more complicated issue.
*/ */
@Deprecated
public void updateInventory(); public void updateInventory();
/** /**