Pulling all pending Bukkit-JavaDoc changes

A special thanks goes to @aerouk for almost all of the changes found here.

By: Wesley Wolfe <weswolf@aol.com>
This commit is contained in:
Bukkit/Spigot
2013-12-15 01:07:43 -05:00
parent 800679913f
commit bb50f1a774
310 changed files with 4218 additions and 2904 deletions
@@ -25,8 +25,10 @@ public interface Entity extends Metadatable {
public Location getLocation();
/**
* Stores the entity's current position in the provided Location object.<br />
* If the provided Location is null this method does nothing and returns null.
* Stores the entity's current position in the provided Location object.
* <p>
* If the provided Location is null this method does nothing and returns
* null.
*
* @return The Location object provided or null
*/
@@ -47,8 +49,9 @@ public interface Entity extends Metadatable {
public Vector getVelocity();
/**
* Returns true if the entity is supported by a block. This value is a state
* updated by the server and is not recalculated unless the entity moves.
* Returns true if the entity is supported by a block. This value is a
* state updated by the server and is not recalculated unless the entity
* moves.
*
* @return True if entity is on ground.
*/
@@ -96,7 +99,8 @@ public interface Entity extends Metadatable {
public boolean teleport(Entity destination, TeleportCause cause);
/**
* Returns a list of entities within a bounding box centered around this entity
* Returns a list of entities within a bounding box centered around this
* entity
*
* @param x 1/2 the size of the box along x axis
* @param y 1/2 the size of the box along y axis
@@ -113,7 +117,8 @@ public interface Entity extends Metadatable {
public int getEntityId();
/**
* Returns the entity's current fire ticks (ticks before the entity stops being on fire).
* Returns the entity's current fire ticks (ticks before the entity stops
* being on fire).
*
* @return int fireTicks
*/
@@ -127,7 +132,8 @@ public interface Entity extends Metadatable {
public int getMaxFireTicks();
/**
* Sets the entity's current fire ticks (ticks before the entity stops being on fire).
* Sets the entity's current fire ticks (ticks before the entity stops
* being on fire).
*
* @param ticks Current ticks remaining
*/
@@ -148,6 +154,7 @@ public interface Entity extends Metadatable {
/**
* Returns false if the entity has died or been despawned for some other
* reason.
*
* @return True if valid.
*/
public boolean isValid();
@@ -211,9 +218,11 @@ public interface Entity extends Metadatable {
public void setLastDamageCause(EntityDamageEvent event);
/**
* Retrieve the last {@link EntityDamageEvent} inflicted on this entity. This event may have been cancelled.
* Retrieve the last {@link EntityDamageEvent} inflicted on this entity.
* This event may have been cancelled.
*
* @return the last known {@link EntityDamageEvent} or null if hitherto unharmed
* @return the last known {@link EntityDamageEvent} or null if hitherto
* unharmed
*/
public EntityDamageEvent getLastDamageCause();
@@ -236,7 +245,8 @@ public interface Entity extends Metadatable {
/**
* Sets the amount of ticks this entity has lived for.
* <p>
* This is the equivalent to "age" in entities. May not be less than one tick.
* This is the equivalent to "age" in entities. May not be less than one
* tick.
*
* @param value Age of entity
*/
@@ -253,6 +263,7 @@ public interface Entity extends Metadatable {
/**
* Get the type of the entity.
*
* @return The entity type.
*/
public EntityType getType();
@@ -265,9 +276,9 @@ public interface Entity extends Metadatable {
public boolean isInsideVehicle();
/**
* Leave the current vehicle. If the entity is currently in a vehicle
* (and is removed from it), true will be returned, otherwise false will
* be returned.
* Leave the current vehicle. If the entity is currently in a vehicle (and
* is removed from it), true will be returned, otherwise false will be
* returned.
*
* @return True if the entity was in a vehicle.
*/