Clean up the javadoc to pass java 8's doclint

By: Thinkofdeath <thinkofdeath@spigotmc.org>
This commit is contained in:
Bukkit/Spigot
2014-11-30 21:09:01 +00:00
parent 8344aacc6e
commit b2d54f59bb
156 changed files with 1155 additions and 501 deletions

View File

@@ -63,6 +63,7 @@ public class EntityDamageEvent extends EntityEvent implements Cancellable {
* event's construction.
*
* @param type the modifier
* @return the original damage
* @throws IllegalArgumentException if type is null
*/
public double getOriginalDamage(DamageModifier type) throws IllegalArgumentException {
@@ -79,6 +80,7 @@ public class EntityDamageEvent extends EntityEvent implements Cancellable {
/**
* Sets the damage for the specified modifier.
*
* @param type the damage modifier
* @param damage the scalar value of the damage's modifier
* @see #getFinalDamage()
* @throws IllegalArgumentException if type is null
@@ -96,6 +98,7 @@ public class EntityDamageEvent extends EntityEvent implements Cancellable {
/**
* Gets the damage change for some modifier
*
* @param type the damage modifier
* @return The raw amount of damage caused by the event
* @throws IllegalArgumentException if type is null
* @see DamageModifier#BASE
@@ -150,6 +153,8 @@ public class EntityDamageEvent extends EntityEvent implements Cancellable {
* This method exists for legacy reasons to provide backwards
* compatibility. It will not exist at runtime and should not be used
* under any circumstances.
*
* @return the (rounded) damage
*/
@Deprecated
public int _INVALID_getDamage() {
@@ -197,6 +202,8 @@ public class EntityDamageEvent extends EntityEvent implements Cancellable {
* This method exists for legacy reasons to provide backwards
* compatibility. It will not exist at runtime and should not be used
* under any circumstances.
*
* @param damage the new damage value
*/
@Deprecated
public void _INVALID_setDamage(int damage) {

View File

@@ -26,7 +26,7 @@ public class EntityPortalExitEvent extends EntityTeleportEvent {
* Gets a copy of the velocity that the entity has before entering the
* portal.
*
* @return velocity of entity before entering portal
* @return velocity of entity before entering the portal
*/
public Vector getBefore() {
return this.before.clone();
@@ -36,7 +36,7 @@ public class EntityPortalExitEvent extends EntityTeleportEvent {
* Gets a copy of the velocity that the entity will have after exiting the
* portal.
*
* @return velocity of entity after exiting portal
* @return velocity of entity after exiting the portal
*/
public Vector getAfter() {
return this.after.clone();
@@ -44,6 +44,8 @@ public class EntityPortalExitEvent extends EntityTeleportEvent {
/**
* Sets the velocity that the entity will have after exiting the portal.
*
* @param after the velocity after exiting the portal
*/
public void setAfter(Vector after) {
this.after = after.clone();

View File

@@ -38,6 +38,8 @@ public class EntityRegainHealthEvent extends EntityEvent implements Cancellable
* This method exists for legacy reasons to provide backwards
* compatibility. It will not exist at runtime and should not be used
* under any circumstances.
*
* @return the (rounded) amount regained
*/
@Deprecated
public int _INVALID_getAmount() {
@@ -57,16 +59,20 @@ public class EntityRegainHealthEvent extends EntityEvent implements Cancellable
* This method exists for legacy reasons to provide backwards
* compatibility. It will not exist at runtime and should not be used
* under any circumstances.
*
* @param amount the amount that will be regained
*/
@Deprecated
public void _INVALID_setAmount(int amount) {
setAmount(amount);
}
@Override
public boolean isCancelled() {
return cancelled;
}
@Override
public void setCancelled(boolean cancel) {
cancelled = cancel;
}