Pulling all pending Bukkit-JavaDoc changes

By: Wesley Wolfe <wesley.d.wolfe+git@gmail.com>
This commit is contained in:
Bukkit/Spigot 2014-07-08 23:56:15 -05:00
parent 7a4e236f4d
commit bbc211faba
4 changed files with 10 additions and 7 deletions

View File

@ -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);

View File

@ -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

View File

@ -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
*/

View File

@ -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;