summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWesley Wolfe <wesley.d.wolfe+git@gmail.com>2014-07-08 23:56:15 -0500
committerWesley Wolfe <wesley.d.wolfe+git@gmail.com>2014-07-08 23:56:15 -0500
commit9b7b142ad0534452325bb997d8d55e8beb4b3d99 (patch)
treeb2cf6db9fe02164b8aaccd196d52c320177f107b
parent9e41b5bd335b94dd55076844b2cc25a9b23d916a (diff)
downloadbukkit-9b7b142ad0534452325bb997d8d55e8beb4b3d99.tar
bukkit-9b7b142ad0534452325bb997d8d55e8beb4b3d99.tar.gz
bukkit-9b7b142ad0534452325bb997d8d55e8beb4b3d99.tar.lz
bukkit-9b7b142ad0534452325bb997d8d55e8beb4b3d99.tar.xz
bukkit-9b7b142ad0534452325bb997d8d55e8beb4b3d99.zip
Pulling all pending Bukkit-JavaDoc changes
-rw-r--r--src/main/java/org/bukkit/GameMode.java2
-rw-r--r--src/main/java/org/bukkit/Location.java2
-rw-r--r--src/main/java/org/bukkit/entity/HumanEntity.java4
-rw-r--r--src/main/java/org/bukkit/event/player/PlayerFishEvent.java9
4 files changed, 10 insertions, 7 deletions
diff --git a/src/main/java/org/bukkit/GameMode.java b/src/main/java/org/bukkit/GameMode.java
index 47b2d90b..f85ed0b2 100644
--- a/src/main/java/org/bukkit/GameMode.java
+++ b/src/main/java/org/bukkit/GameMode.java
@@ -23,7 +23,7 @@ public enum GameMode {
SURVIVAL(0),
/**
- * Adventure mode cannot break blocks, use chat, use buckets, etc.
+ * Adventure mode cannot break blocks without the correct tools.
*/
ADVENTURE(2);
diff --git a/src/main/java/org/bukkit/Location.java b/src/main/java/org/bukkit/Location.java
index 9e1e6045..5c18507b 100644
--- a/src/main/java/org/bukkit/Location.java
+++ b/src/main/java/org/bukkit/Location.java
@@ -219,7 +219,7 @@ public class Location implements Cloneable {
}
/**
- * Sets the pitch of this location, measured in degrees.
+ * Gets the pitch of this location, measured in degrees.
* <ul>
* <li>A pitch of 0 represents level forward facing.
* <li>A pitch of 90 represents downward facing, or negative y
diff --git a/src/main/java/org/bukkit/entity/HumanEntity.java b/src/main/java/org/bukkit/entity/HumanEntity.java
index 6f70db4d..3f8646dd 100644
--- a/src/main/java/org/bukkit/entity/HumanEntity.java
+++ b/src/main/java/org/bukkit/entity/HumanEntity.java
@@ -148,14 +148,14 @@ public interface HumanEntity extends LivingEntity, AnimalTamer, Permissible, Inv
public int getSleepTicks();
/**
- * Gets this humans current {@link GameMode}
+ * Gets this human's current {@link GameMode}
*
* @return Current game mode
*/
public GameMode getGameMode();
/**
- * Sets this humans current {@link GameMode}
+ * Sets this human's current {@link GameMode}
*
* @param mode New game mode
*/
diff --git a/src/main/java/org/bukkit/event/player/PlayerFishEvent.java b/src/main/java/org/bukkit/event/player/PlayerFishEvent.java
index e92acdfc..7416a0ae 100644
--- a/src/main/java/org/bukkit/event/player/PlayerFishEvent.java
+++ b/src/main/java/org/bukkit/event/player/PlayerFishEvent.java
@@ -37,10 +37,13 @@ public class PlayerFishEvent extends PlayerEvent implements Cancellable {
}
/**
- * Gets the entity caught by the player
+ * Gets the entity caught by the player.
+ * <p>
+ * If player has fished successfully, the result may be cast to {@link
+ * Item}.
*
- * @return Entity caught by the player, null if fishing, bobber has gotten
- * stuck in the ground or nothing has been caught
+ * @return Entity caught by the player, Entity if fishing, and null if
+ * bobber has gotten stuck in the ground or nothing has been caught
*/
public Entity getCaught() {
return entity;