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

@@ -98,8 +98,8 @@ public interface EntityEquipment {
/**
* Gets the chance of the currently held item being dropped upon this
* creature's death
* <p>
* creature's death.
*
* <ul>
* <li>A drop chance of 0F will never drop
* <li>A drop chance of 1F will always drop
@@ -111,8 +111,8 @@ public interface EntityEquipment {
/**
* Sets the chance of the item this creature is currently holding being
* dropped upon this creature's death
* <p>
* dropped upon this creature's death.
*
* <ul>
* <li>A drop chance of 0F will never drop
* <li>A drop chance of 1F will always drop
@@ -124,8 +124,8 @@ public interface EntityEquipment {
void setItemInHandDropChance(float chance);
/**
* Gets the chance of the helmet being dropped upon this creature's death
* <p>
* Gets the chance of the helmet being dropped upon this creature's death.
*
* <ul>
* <li>A drop chance of 0F will never drop
* <li>A drop chance of 1F will always drop
@@ -136,8 +136,8 @@ public interface EntityEquipment {
float getHelmetDropChance();
/**
* Sets the chance of the helmet being dropped upon this creature's death
* <p>
* Sets the chance of the helmet being dropped upon this creature's death.
*
* <ul>
* <li>A drop chance of 0F will never drop
* <li>A drop chance of 1F will always drop
@@ -150,8 +150,8 @@ public interface EntityEquipment {
/**
* Gets the chance of the chest plate being dropped upon this creature's
* death
* <p>
* death.
*
* <ul>
* <li>A drop chance of 0F will never drop
* <li>A drop chance of 1F will always drop
@@ -163,8 +163,8 @@ public interface EntityEquipment {
/**
* Sets the chance of the chest plate being dropped upon this creature's
* death
* <p>
* death.
*
* <ul>
* <li>A drop chance of 0F will never drop
* <li>A drop chance of 1F will always drop
@@ -177,8 +177,8 @@ public interface EntityEquipment {
/**
* Gets the chance of the leggings being dropped upon this creature's
* death
* <p>
* death.
*
* <ul>
* <li>A drop chance of 0F will never drop
* <li>A drop chance of 1F will always drop
@@ -190,8 +190,8 @@ public interface EntityEquipment {
/**
* Sets the chance of the leggings being dropped upon this creature's
* death
* <p>
* death.
*
* <ul>
* <li>A drop chance of 0F will never drop
* <li>A drop chance of 1F will always drop
@@ -203,8 +203,8 @@ public interface EntityEquipment {
void setLeggingsDropChance(float chance);
/**
* Gets the chance of the boots being dropped upon this creature's death
* <p>
* Gets the chance of the boots being dropped upon this creature's death.
*
* <ul>
* <li>A drop chance of 0F will never drop
* <li>A drop chance of 1F will always drop
@@ -215,8 +215,8 @@ public interface EntityEquipment {
float getBootsDropChance();
/**
* Sets the chance of the boots being dropped upon this creature's death
* <p>
* Sets the chance of the boots being dropped upon this creature's death.
*
* <ul>
* <li>A drop chance of 0F will never drop
* <li>A drop chance of 1F will always drop

View File

@@ -62,6 +62,7 @@ public abstract class InventoryView {
/**
*
* @return the id of this view
* @deprecated Magic value
*/
@Deprecated

View File

@@ -95,6 +95,10 @@ public class ItemStack implements Cloneable, ConfigurationSerializable {
}
/**
* @param type the raw type id
* @param amount the amount in the stack
* @param damage the damage value of the item
* @param data the data value or null
* @deprecated this method uses an ambiguous data byte object
*/
@Deprecated
@@ -109,6 +113,10 @@ public class ItemStack implements Cloneable, ConfigurationSerializable {
}
/**
* @param type the type
* @param amount the amount in the stack
* @param damage the damage value of the item
* @param data the data value or null
* @deprecated this method uses an ambiguous data byte object
*/
@Deprecated

View File

@@ -57,7 +57,7 @@ public interface FireworkMeta extends ItemMeta {
* Remove an effect from this firework.
*
* @param index The index of the effect to remove
* @throws IndexOutOfBoundsException If index < 0 or index > {@link
* @throws IndexOutOfBoundsException If index {@literal < 0 or index >} {@link
* #getEffectsSize()}
*/
void removeEffect(int index) throws IndexOutOfBoundsException;
@@ -86,7 +86,7 @@ public interface FireworkMeta extends ItemMeta {
* a second of flight time.
*
* @param power the power of the firework, from 0-128
* @throws IllegalArgumentException if height<0 or height>128
* @throws IllegalArgumentException if {@literal height<0 or height>128}
*/
void setPower(int power) throws IllegalArgumentException;

View File

@@ -87,7 +87,7 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable {
int getEnchantLevel(Enchantment ench);
/**
* Returns a copy the enchantments in this ItemMeta.<br />
* Returns a copy the enchantments in this ItemMeta. <br>
* Returns an empty map if none.
*
* @return An immutable copy of the enchantments