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

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