From 1861013a8c070400d70d3b9703e1c9afcce0be80 Mon Sep 17 00:00:00 2001 From: md_5 Date: Fri, 10 Feb 2017 20:16:18 +1100 Subject: SPIGOT-3059: Update PlayerFishEvent documentation --- .../java/org/bukkit/event/player/PlayerFishEvent.java | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/src/main/java/org/bukkit/event/player/PlayerFishEvent.java b/src/main/java/org/bukkit/event/player/PlayerFishEvent.java index 72eebe96..211e304f 100644 --- a/src/main/java/org/bukkit/event/player/PlayerFishEvent.java +++ b/src/main/java/org/bukkit/event/player/PlayerFishEvent.java @@ -106,24 +106,29 @@ public class PlayerFishEvent extends PlayerEvent implements Cancellable { */ FISHING, /** - * When a player has successfully caught a fish and is reeling it in. + * When a player has successfully caught a fish and is reeling it in. In + * this instance, a "fish" is any item retrieved from water as a result + * of fishing, ie an item, but not necessarily a fish. */ CAUGHT_FISH, /** - * When a player has successfully caught an entity + * When a player has successfully caught an entity. This refers to any + * already spawned entity in the world that has been hooked directly by + * the rod. */ CAUGHT_ENTITY, /** - * When a bobber is stuck in the ground + * When a bobber is stuck in the ground. */ IN_GROUND, /** * When a player fails to catch anything while fishing usually due to - * poor aiming or timing + * poor aiming or timing. */ FAILED_ATTEMPT, /** - * Called when there is a bite on the hook and it is ready to be reeled in. + * Called when there is a bite on the hook and it is ready to be reeled + * in. */ BITE } -- cgit v1.2.3