SteamWar/Paper
9
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Clean up the javadoc to pass java 8's doclint

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

3
paper-api/src/main/java/org/bukkit/entity/CreatureType.java
View File

@@ -71,6 +71,7 @@ public enum CreatureType {
/**
*
* @return the raw type id
* @deprecated Magic value
*/
@Deprecated
@@ -84,6 +85,8 @@ public enum CreatureType {
/**
*
* @param id the raw type id
* @return the matching CreatureType or null
* @deprecated Magic value
*/
@Deprecated

17
paper-api/src/main/java/org/bukkit/entity/Damageable.java
View File

@@ -15,6 +15,8 @@ public interface Damageable extends Entity {
* 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 Amount of damage to deal
*/
@Deprecated
void _INVALID_damage(int amount);
@@ -32,6 +34,9 @@ public interface Damageable extends Entity {
* 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 Amount of damage to deal
* @param source Entity which to attribute this damage from
*/
@Deprecated
void _INVALID_damage(int amount, Entity source);
@@ -47,6 +52,8 @@ public interface Damageable extends Entity {
* 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 Health represented from 0 to max
*/
@Deprecated
int _INVALID_getHealth();
@@ -56,7 +63,7 @@ public interface Damageable extends Entity {
* dead.
*
* @param health New health represented from 0 to max
* @throws IllegalArgumentException Thrown if the health is < 0 or >
* @throws IllegalArgumentException Thrown if the health is {@literal < 0 or >}
* {@link #getMaxHealth()}
*/
void setHealth(double health);
@@ -65,6 +72,10 @@ public interface Damageable extends Entity {
* 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 health New health represented from 0 to max
* @throws IllegalArgumentException Thrown if the health is {@literal < 0 or >}
* {@link #getMaxHealth()}
*/
@Deprecated
void _INVALID_setHealth(int health);
@@ -80,6 +91,8 @@ public interface Damageable extends Entity {
* 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 Maximum health
*/
@Deprecated
int _INVALID_getMaxHealth();
@@ -101,6 +114,8 @@ public interface Damageable extends Entity {
* 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 health amount of health to set the maximum to
*/
@Deprecated
void _INVALID_setMaxHealth(int health);

3
paper-api/src/main/java/org/bukkit/entity/Entity.java
View File

@@ -30,6 +30,7 @@ public interface Entity extends Metadatable {
* If the provided Location is null this method does nothing and returns
* null.
*
* @param loc the location to copy into
* @return The Location object provided or null
*/
public Location getLocation(Location loc);
@@ -109,7 +110,7 @@ public interface Entity extends Metadatable {
* @param x 1/2 the size of the box along x axis
* @param y 1/2 the size of the box along y axis
* @param z 1/2 the size of the box along z axis
* @return List<Entity> List of entities nearby
* @return {@code List<Entity>} List of entities nearby
*/
public List<org.bukkit.entity.Entity> getNearbyEntities(double x, double y, double z);

6
paper-api/src/main/java/org/bukkit/entity/EntityType.java
View File

@@ -209,6 +209,7 @@ public enum EntityType {
/**
*
* @return the entity type's name
* @deprecated Magic value
*/
@Deprecated
@@ -222,6 +223,7 @@ public enum EntityType {
/**
*
* @return the raw type id
* @deprecated Magic value
*/
@Deprecated
@@ -231,6 +233,8 @@ public enum EntityType {
/**
*
* @param name the entity type's name
* @return the matching entity type or null
* @deprecated Magic value
*/
@Deprecated
@@ -243,6 +247,8 @@ public enum EntityType {
/**
*
* @param id the raw type id
* @return the matching entity type or null
* @deprecated Magic value
*/
@Deprecated

4
paper-api/src/main/java/org/bukkit/entity/LivingEntity.java
View File

@@ -173,6 +173,8 @@ public interface LivingEntity extends Entity, Damageable, ProjectileSource {
* 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 damage taken since the last no damage ticks time period
*/
@Deprecated
public int _INVALID_getLastDamage();
@@ -188,6 +190,8 @@ public interface LivingEntity extends Entity, Damageable, ProjectileSource {
* 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 amount of damage
*/
@Deprecated
public void _INVALID_setLastDamage(int damage);

4
paper-api/src/main/java/org/bukkit/entity/Minecart.java
View File

@@ -11,6 +11,8 @@ public interface Minecart extends Vehicle {
* 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 over 40 to "kill" a minecart
*/
@Deprecated
public void _INVALID_setDamage(int damage);
@@ -26,6 +28,8 @@ public interface Minecart extends Vehicle {
* 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 damage
*/
@Deprecated
public int _INVALID_getDamage();

4
paper-api/src/main/java/org/bukkit/entity/Player.java
View File

@@ -255,6 +255,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
/**
* Plays an effect to just this player.
*
* @param <T> the data based based on the type of the effect
* @param loc the location to play the effect at
* @param effect the {@link Effect}
* @param data a data bit needed for some effects
@@ -360,6 +361,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
/**
* Gets whether this player has the given achievement.
*
* @param achievement the achievement to check
* @return whether the player has the achievement
* @throws IllegalArgumentException if achievement is null
*/
@@ -763,7 +765,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
* Gets the players current saturation level.
* <p>
* Saturation is a buffer for food level. Your food level will not drop if
* you are saturated > 0.
* you are saturated {@literal >} 0.
*
* @return Saturation level
*/

4
paper-api/src/main/java/org/bukkit/entity/Projectile.java
View File

@@ -11,6 +11,8 @@ public interface Projectile extends Entity {
* 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 {@link LivingEntity} that shot this projectile
*/
@Deprecated
public LivingEntity _INVALID_getShooter();
@@ -26,6 +28,8 @@ public interface Projectile extends Entity {
* 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 shooter the {@link LivingEntity} that shot this projectile
*/
@Deprecated
public void _INVALID_setShooter(LivingEntity shooter);