-
Notifications
You must be signed in to change notification settings - Fork 59
Fixed PlayerFishEvent documentation. Fixes BUKKIT-4975 #53
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Method getCaught() actually returns an Item as Entity if fishing successful, not null.
This doesn't follow proper formatting. A |
Method getCaught() returns an Item as Entity if fishing successful, not null
* | ||
* @return Entity caught by the player, null if fishing, bobber has gotten stuck in the ground or nothing has been caught | ||
* <p> | ||
* If player has fished successfully, the result may be cast to {@link Item}. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You'll need a line break here.
Method getCaught() returns an Item as Entity if fishing successful, not null
Also, on line 43, you need to get rid of the space after the |
Method getCaught() returns an Item as Entity if fishing successful, not null
This needs to be updated to the latest master. Could you also provide proof for the behavior defined? Links to craftbukkit should suffice. /edit: And at least make a comment indicating that it has been updated, for alert reasons. |
Lines 390 & 392. PlayerFishEvent playerFishEvent = new PlayerFishEvent((Player) this.owner.getBukkitEntity(), entityitem.getBukkitEntity(), (Fish) this.getBukkitEntity(), PlayerFishEvent.State.CAUGHT_FISH); |
The doc on line 44 exceeds 78 characters. |
Split line 44
* | ||
* @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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line still exceeds the 78 character limit.
Thanks @fragtastic, @aerouk commit 9631a66 Author: aerouk Date: 2014-04-10 22:53:53 +0100 Fixed up #53 commit 493bd85 Author: frag Date: 2013-12-13 12:24:45 -0800 Fixed doc length Split line 44 commit 0597b7d Author: fragtastic Date: 2013-12-13 01:45:33 -0800 Merged with upstream commit 1dcd22b Author: frag Date: 2013-12-02 16:24:15 -0800 Fixed PlayerFishEvent documentation. Fixes BUKKIT-4975 Method getCaught() returns an Item as Entity if fishing successful, not null commit 0bb0369 Author: frag Date: 2013-12-02 08:30:18 -0800 Fixed PlayerFishEvent documentation. Fixes BUKKIT-4975 Method getCaught() returns an Item as Entity if fishing successful, not null commit 1eb1346 Author: frag Date: 2013-12-01 21:28:28 -0800 Fixed PlayerFishEvent documentation. Fixes BUKKIT-4975 Method getCaught() returns an Item as Entity if fishing successful, not null commit 9be1783 Author: frag Date: 2013-12-01 14:49:47 -0800 Fixed PlayerFishEvent documentation. Fixes BUKKIT-4975 Method getCaught() actually returns an Item as Entity if fishing successful, not null.
Method getCaught() actually returns an Item as Entity if fishing successful, not null.