summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorWesley Wolfe <weswolf@aol.com>2013-04-13 01:36:32 -0500
committerWesley Wolfe <weswolf@aol.com>2013-04-13 01:36:32 -0500
commita3dde01dca452447d868068cd730f6282319337c (patch)
treef441dc8023daf3740af5f008375f850f86bb6131 /src
parente3acdd7b9ab53849f16e36c139bb61080c944775 (diff)
downloadbukkit-a3dde01dca452447d868068cd730f6282319337c.tar
bukkit-a3dde01dca452447d868068cd730f6282319337c.tar.gz
bukkit-a3dde01dca452447d868068cd730f6282319337c.tar.lz
bukkit-a3dde01dca452447d868068cd730f6282319337c.tar.xz
bukkit-a3dde01dca452447d868068cd730f6282319337c.zip
Pulling all pending Bukkit-JavaDoc changes
Diffstat (limited to 'src')
-rw-r--r--src/main/java/org/bukkit/entity/Player.java10
-rw-r--r--src/main/java/org/bukkit/event/enchantment/EnchantItemEvent.java3
-rw-r--r--src/main/java/org/bukkit/event/enchantment/PrepareItemEnchantEvent.java2
-rw-r--r--src/main/java/org/bukkit/event/entity/EntityDamageEvent.java2
-rw-r--r--src/main/java/org/bukkit/event/player/PlayerPickupItemEvent.java2
-rw-r--r--src/main/java/org/bukkit/potion/PotionEffect.java4
6 files changed, 16 insertions, 7 deletions
diff --git a/src/main/java/org/bukkit/entity/Player.java b/src/main/java/org/bukkit/entity/Player.java
index 80c8cb8d..dec22141 100644
--- a/src/main/java/org/bukkit/entity/Player.java
+++ b/src/main/java/org/bukkit/entity/Player.java
@@ -636,10 +636,14 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
public Scoreboard getScoreboard();
/**
- * Sets the player's visible Scoreboard
- * Scoreboard must be currently registered or an IllegalArgumentException is thrown
+ * Sets the player's visible Scoreboard.
*
* @param scoreboard New Scoreboard for the player
+ * @throws IllegalArgumentException if scoreboard is null
+ * @throws IllegalArgumentException if scoreboard was not created by the
+ * {@link org.bukkit.scoreboard.ScoreboardManager scoreboard manager}
+ * @throws IllegalStateException if this is a player that is not logged
+ * yet or has logged out
*/
- public void setScoreboard(Scoreboard scoreboard);
+ public void setScoreboard(Scoreboard scoreboard) throws IllegalArgumentException, IllegalStateException;
}
diff --git a/src/main/java/org/bukkit/event/enchantment/EnchantItemEvent.java b/src/main/java/org/bukkit/event/enchantment/EnchantItemEvent.java
index 97cfe25b..295ac52a 100644
--- a/src/main/java/org/bukkit/event/enchantment/EnchantItemEvent.java
+++ b/src/main/java/org/bukkit/event/enchantment/EnchantItemEvent.java
@@ -65,6 +65,7 @@ public class EnchantItemEvent extends InventoryEvent implements Cancellable {
/**
* Get cost in exp levels of the enchantment
+ *
* @return experience level cost
*/
public int getExpLevelCost() {
@@ -73,6 +74,7 @@ public class EnchantItemEvent extends InventoryEvent implements Cancellable {
/**
* Set cost in exp levels of the enchantment
+ *
* @param level - cost in levels
*/
public void setExpLevelCost(int level) {
@@ -91,6 +93,7 @@ public class EnchantItemEvent extends InventoryEvent implements Cancellable {
/**
* Which button was pressed to initiate the enchanting.
+ *
* @return The button index (0, 1, or 2).
*/
public int whichButton() {
diff --git a/src/main/java/org/bukkit/event/enchantment/PrepareItemEnchantEvent.java b/src/main/java/org/bukkit/event/enchantment/PrepareItemEnchantEvent.java
index 9121db75..6028accb 100644
--- a/src/main/java/org/bukkit/event/enchantment/PrepareItemEnchantEvent.java
+++ b/src/main/java/org/bukkit/event/enchantment/PrepareItemEnchantEvent.java
@@ -59,6 +59,7 @@ public class PrepareItemEnchantEvent extends InventoryEvent implements Cancellab
/**
* Get list of offered exp level costs of the enchantment (modify values to change offer)
+ *
* @return experience level costs offered
*/
public int[] getExpLevelCostsOffered() {
@@ -67,6 +68,7 @@ public class PrepareItemEnchantEvent extends InventoryEvent implements Cancellab
/**
* Get enchantment bonus in effect - corresponds to number of bookshelves
+ *
* @return enchantment bonus
*/
public int getEnchantmentBonus() {
diff --git a/src/main/java/org/bukkit/event/entity/EntityDamageEvent.java b/src/main/java/org/bukkit/event/entity/EntityDamageEvent.java
index 6d773f8b..bd3d7c6d 100644
--- a/src/main/java/org/bukkit/event/entity/EntityDamageEvent.java
+++ b/src/main/java/org/bukkit/event/entity/EntityDamageEvent.java
@@ -177,7 +177,7 @@ public class EntityDamageEvent extends EntityEvent implements Cancellable {
*/
MAGIC,
/**
- *
+ * Damage caused by Wither potion effect
*/
WITHER,
/**
diff --git a/src/main/java/org/bukkit/event/player/PlayerPickupItemEvent.java b/src/main/java/org/bukkit/event/player/PlayerPickupItemEvent.java
index cac3234f..dfba8163 100644
--- a/src/main/java/org/bukkit/event/player/PlayerPickupItemEvent.java
+++ b/src/main/java/org/bukkit/event/player/PlayerPickupItemEvent.java
@@ -21,7 +21,7 @@ public class PlayerPickupItemEvent extends PlayerEvent implements Cancellable {
}
/**
- * Gets the ItemDrop created by the player
+ * Gets the Item picked up by the player.
*
* @return Item
*/
diff --git a/src/main/java/org/bukkit/potion/PotionEffect.java b/src/main/java/org/bukkit/potion/PotionEffect.java
index 5182a074..3ef82b40 100644
--- a/src/main/java/org/bukkit/potion/PotionEffect.java
+++ b/src/main/java/org/bukkit/potion/PotionEffect.java
@@ -44,11 +44,11 @@ public class PotionEffect implements ConfigurationSerializable {
}
/**
- * Creates a potion affect. Assumes ambient is true.
+ * Creates a potion effect. Assumes ambient is true.
*
* @param type Effect type
* @param duration measured in ticks
- * @param amplifier the amplifier for the affect
+ * @param amplifier the amplifier for the effect
* @see PotionEffect#PotionEffect(PotionEffectType, int, int, boolean)
*/
public PotionEffect(PotionEffectType type, int duration, int amplifier) {