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

View File

@@ -13,7 +13,8 @@ import org.bukkit.inventory.InventoryView;
import org.bukkit.inventory.ItemStack;
/**
* Called when an ItemStack is successfully enchanted (currently at enchantment table)
* Called when an ItemStack is successfully enchanted (currently at
* enchantment table)
*/
public class EnchantItemEvent extends InventoryEvent implements Cancellable {
private static final HandlerList handlers = new HandlerList();
@@ -82,8 +83,9 @@ public class EnchantItemEvent extends InventoryEvent implements Cancellable {
}
/**
* Get map of enchantment (levels, keyed by type) to be added to item (modify map returned to change values)
* Note: Any enchantments not allowed for the item will be ignored
* Get map of enchantment (levels, keyed by type) to be added to item
* (modify map returned to change values). Note: Any enchantments not
* allowed for the item will be ignored
*
* @return map of enchantment levels, keyed by enchantment
*/

View File

@@ -9,7 +9,8 @@ import org.bukkit.inventory.InventoryView;
import org.bukkit.inventory.ItemStack;
/**
* Called when an ItemStack is inserted in an enchantment table - can be called multiple times
* Called when an ItemStack is inserted in an enchantment table - can be
* called multiple times
*/
public class PrepareItemEnchantEvent extends InventoryEvent implements Cancellable {
private static final HandlerList handlers = new HandlerList();
@@ -58,7 +59,8 @@ public class PrepareItemEnchantEvent extends InventoryEvent implements Cancellab
}
/**
* Get list of offered exp level costs of the enchantment (modify values to change offer)
* Get list of offered exp level costs of the enchantment (modify values
* to change offer)
*
* @return experience level costs offered
*/