Plugin JavaDocs #125
Open
Plugin JavaDocs #125
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
Sytm
suggested changes
Mar 31, 2020
Sytm
left a comment
Sytm
left a comment
There was a problem hiding this comment.
Some top tier JavaDocs in most places, but sometimes you are just explaining how it internally functions instead of what it actually is supposed to do.
I am gonna leave it open if you should actually JavaDoc private fields, I think it's weird but it kinda explains the fields better than without
| /** | ||
| * Inventory close boolean. This field being a boolean, is the key to allowing the inventory to | ||
| * be closed or not. | ||
| */ |
There was a problem hiding this comment.
This JavaDoc is just floating around with nothing attached to it
Author
There was a problem hiding this comment.
Fixed the floating JavaDoc. Also added some more Javadocs along with clearing up the meaning behind what things are actually suppose to do. Will add more when I can, with whatever you have not added in v2.0.0
portlek
approved these changes
Jun 6, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Willing to do as much JavaDocs as I can if you would like me to. I enjoy it and it actually helps me learn more about Java. I am not a beginner but I am also not a pro at Java but I'll do my best to keep it as generic and accurate as possible.