Complete getCurrentItem() @return description #85
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In addition to adding "slot" to "the item in the clicked", it may be helpful to state that empty slots return Air, while clicking outside the inventory returns null. (I've tested this to confirm)
| @@ -93,7 +93,8 @@ public ItemStack getCursor() { | |||
| /** | |||
| * Gets the ItemStack currently in the clicked slot. | |||
| * | |||
| * @return the item in the clicked | |||
| * @return the item in the clicked slot. Air for empty slots, null for | |||
| * clicking outside the inventory | |||
There was a problem hiding this comment.
I don't know why this shows extra space before the " * "... it's not showing in my editor nor GitHub's editor that I used.
|
I've updated it to remove the tab. I could have sworn I didn't use any tabs :) |
|
In most of Java's Javadocs, clarifications to what the return value can be is in the javadoc body and not on the tag. |
|
Apologies, @SagaciousZed, GitHub decided not to send an email about your reply so 4 days later, I find I need changes :) |
Wolvereness
added a commit
that referenced
this pull request
Jul 9, 2014
Thanks @Bionicrm commit 6ba95fb Author: T.J. M Date: 2014-04-27 02:35:27 -0400 Complete getCurrentItem() description and @return commit bdbe059 Author: T.J. M Date: 2014-04-18 21:52:02 -0400 Remove tab from beginning of " * " commit 6c563ad Author: T.J. M Date: 2014-04-18 21:48:23 -0400 Complete getCurrentItem() @return description In addition to adding "slot" to "the item in the clicked", it may be helpful to state that empty slots return Air, while clicking outside the inventory returns null. (I've tested this to confirm)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In addition to adding "slot" to "the item in the clicked", it may be helpful to state that empty slots return Air, while clicking outside the inventory returns null. (I've tested this to confirm)