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

Pulling all pending Bukkit-JavaDoc changes

Browse Source 
By: Edmond Poon <sagaciouszzzz@gmail.com>
This commit is contained in:
Bukkit/Spigot
2013-04-02 00:11:22 -04:00
parent 745a0d7683
commit 761a84cb1b
93 changed files with 539 additions and 505 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
paper-api/src/main/java/org/bukkit/inventory/EntityEquipment.java
View File

@@ -97,7 +97,7 @@ public interface EntityEquipment {
/**
* Gets the chance of the currently held item being dropped upon this creature's death
* <p />
* <p>
* <li />A drop chance of 0F will never drop
* <li />A drop chance of 1F will always drop
*
@@ -107,7 +107,7 @@ public interface EntityEquipment {
/**
* Sets the chance of the item this creature is currently holding being dropped upon this creature's death
* <p />
* <p>
* <li />A drop chance of 0F will never drop
* <li />A drop chance of 1F will always drop
*
@@ -118,7 +118,7 @@ public interface EntityEquipment {
/**
* Gets the chance of the helmet being dropped upon this creature's death
* <p />
* <p>
* <li />A drop chance of 0F will never drop
* <li />A drop chance of 1F will always drop
*
@@ -128,7 +128,7 @@ public interface EntityEquipment {
/**
* Sets the chance of the helmet being dropped upon this creature's death
* <p />
* <p>
* <li />A drop chance of 0F will never drop
* <li />A drop chance of 1F will always drop
*
@@ -139,7 +139,7 @@ public interface EntityEquipment {
/**
* Gets the chance of the chest plate being dropped upon this creature's death
* <p />
* <p>
* <li />A drop chance of 0F will never drop
* <li />A drop chance of 1F will always drop
*
@@ -149,7 +149,7 @@ public interface EntityEquipment {
/**
* Sets the chance of the chest plate being dropped upon this creature's death
* <p />
* <p>
* <li />A drop chance of 0F will never drop
* <li />A drop chance of 1F will always drop
*
@@ -160,7 +160,7 @@ public interface EntityEquipment {
/**
* Gets the chance of the leggings being dropped upon this creature's death
* <p />
* <p>
* <li />A drop chance of 0F will never drop
* <li />A drop chance of 1F will always drop
*
@@ -170,7 +170,7 @@ public interface EntityEquipment {
/**
* Sets the chance of the leggings being dropped upon this creature's death
* <p />
* <p>
* <li />A drop chance of 0F will never drop
* <li />A drop chance of 1F will always drop
*
@@ -181,7 +181,7 @@ public interface EntityEquipment {
/**
* Gets the chance of the boots being dropped upon this creature's death
* <p />
* <p>
* <li />A drop chance of 0F will never drop
* <li />A drop chance of 1F will always drop
*
@@ -191,7 +191,7 @@ public interface EntityEquipment {
/**
* Sets the chance of the boots being dropped upon this creature's death
* <p />
* <p>
* <li />A drop chance of 0F will never drop
* <li />A drop chance of 1F will always drop
*

16
paper-api/src/main/java/org/bukkit/inventory/Inventory.java
View File

@@ -29,7 +29,7 @@ public interface Inventory extends Iterable<ItemStack> {
/**
* This method allows you to change the maximum stack size for an inventory.
* <p /><b>Caveats:</b>
* <p><b>Caveats:</b>
* <ul>
* <li>Not all inventories respect this value.
* <li>Stacks larger than 127 may be clipped when the world is saved.
@@ -68,12 +68,12 @@ public interface Inventory extends Iterable<ItemStack> {
/**
* Stores the given ItemStacks in the inventory.
* This will try to fill existing stacks and empty slots as well as it can.
* <p />
* <p>
* The returned HashMap contains what it couldn't store, where the key is the
* index of the parameter, and the value is the ItemStack at that index
* of the varargs parameter. If all items are stored, it will return an
* empty HashMap.
* <p />
* <p>
* If you pass in ItemStacks which exceed the maximum stack size for the
* Material, first they will be added to partial stacks where
* Material.getMaxStackSize() is not exceeded, up to
@@ -89,10 +89,10 @@ public interface Inventory extends Iterable<ItemStack> {
/**
* Removes the given ItemStacks from the inventory.
* <p />
* <p>
* It will try to remove 'as much as possible' from the types and amounts you
* give as arguments.
* <p />
* <p>
* The returned HashMap contains what it couldn't remove, where the key is the
* index of the parameter, and the value is the ItemStack at that index of the
* varargs parameter. If all the given ItemStacks are removed, it will return
@@ -187,7 +187,7 @@ public interface Inventory extends Iterable<ItemStack> {
/**
* Returns a HashMap with all slots and ItemStacks in the inventory with
* given materialId.
* <p />
* <p>
* The HashMap contains entries where, the key is the slot index, and the
* value is the ItemStack in that slot. If no matching ItemStack with the
* given materialId is found, an empty map is returned.
@@ -200,7 +200,7 @@ public interface Inventory extends Iterable<ItemStack> {
/**
* Returns a HashMap with all slots and ItemStacks in the inventory with
* the given Material.
* <p />
* <p>
* The HashMap contains entries where, the key is the slot index, and the
* value is the ItemStack in that slot. If no matching ItemStack with the
* given Material is found, an empty map is returned.
@@ -214,7 +214,7 @@ public interface Inventory extends Iterable<ItemStack> {
/**
* Finds all slots in the inventory containing any ItemStacks with the given ItemStack
* This will only match slots if both the type and the amount of the stack match
* <p />
* <p>
* The HashMap contains entries where, the key is the
* slot index, and the value is the ItemStack in that slot. If no matching
* ImemStrack with the given Material is found, an empty map is returned.

2
paper-api/src/main/java/org/bukkit/inventory/InventoryView.java
View File

@@ -88,7 +88,7 @@ public abstract class InventoryView {
/**
* Sets one item in this inventory view by its raw slot ID.
* <p />
* <p>
* Note: If slot ID -999 is chosen, it may be expected that the item is
* dropped on the ground. This is not required behaviour, however.
* @param slot The ID as returned by InventoryClickEvent.getRawSlot()

14
paper-api/src/main/java/org/bukkit/inventory/ItemStack.java
View File

@@ -148,7 +148,7 @@ public class ItemStack implements Cloneable, ConfigurationSerializable {
/**
* Sets the type of this item
* <p />
* <p>
* Note that in doing so you will reset the MaterialData for this stack
*
* @param type New type to set the items in this stack to
@@ -170,7 +170,7 @@ public class ItemStack implements Cloneable, ConfigurationSerializable {
/**
* Sets the type id of this item
* <p />
* <p>
* Note that in doing so you will reset the MaterialData for this stack
*
* @param type New type id to set the items in this stack to
@@ -381,7 +381,7 @@ public class ItemStack implements Cloneable, ConfigurationSerializable {
/**
* Adds the specified enchantments to this item stack.
* <p />
* <p>
* This method is the same as calling {@link #addEnchantment(org.bukkit.enchantments.Enchantment, int)}
* for each element of the map.
*
@@ -400,7 +400,7 @@ public class ItemStack implements Cloneable, ConfigurationSerializable {
/**
* Adds the specified {@link Enchantment} to this item stack.
* <p />
* <p>
* If this item stack already contained the given enchantment (at any level), it will be replaced.
*
* @param ench Enchantment to add
@@ -421,7 +421,7 @@ public class ItemStack implements Cloneable, ConfigurationSerializable {
/**
* Adds the specified enchantments to this item stack in an unsafe manner.
* <p />
* <p>
* This method is the same as calling {@link #addUnsafeEnchantment(org.bukkit.enchantments.Enchantment, int)}
* for each element of the map.
*
@@ -436,9 +436,9 @@ public class ItemStack implements Cloneable, ConfigurationSerializable {
/**
* Adds the specified {@link Enchantment} to this item stack.
* <p />
* <p>
* If this item stack already contained the given enchantment (at any level), it will be replaced.
* <p />
* <p>
* This method is unsafe and will ignore level restrictions or item type. Use at your own
* discretion.
*