Add JavaDoc comments for PlayerLoginData, PlayerInterface, Player, LoginChainData, HumanEntity, CommandSender, CommandMap, Command.java, and BaseArgument methods. #45
Conversation
This file contains 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
Improved clarity by documenting the purpose and behavior of key methods in `BaseArgument`. These comments explain argument parsing, type handling, and metadata retrieval, aiding future developers in understanding and extending the code.
Enhanced the code with detailed Javadoc comments for all public and private methods in Command.java. These comments provide clear descriptions, parameter details, return values, and usage context to improve maintainability and developer understanding.
Provided comprehensive documentation for all methods in the `CommandMap` interface. This enhances code readability, clarifies method purposes, and assists developers in understanding the expected behavior and parameters.
Provide detailed documentation for all methods in the CommandSender interface, improving code clarity and usability. The added comments specify method functionality, parameters, and return values to assist developers in understanding and using the interface effectively.
Updated method documentation to improve clarity and ensure proper usage. Modified `sendSkin` to accept a target list, allowing more flexible skin packet broadcasts. Removed unused imports to clean up the codebase.
Enhanced the `LoginChainData` interface with comprehensive JavaDoc comments, improving code readability and developer understanding. Each method now includes clear descriptions of its purpose and return values. This change facilitates easier maintenance and usage of the interface.
Enhance code readability and maintainability by adding detailed Javadoc comments to the methods in the Player class. These comments describe method functionality, parameters, and return values, ensuring clear documentation and better developer understanding.
Improved documentation by adding detailed Javadoc comments for all methods in the PlayerInterface. This ensures better understanding of the interface's functionality and improves code maintainability.
Enhanced documentation by adding JavaDoc comments to key methods in the PlayerLoginData class. These comments describe method purposes, parameters, and return values, improving code readability and maintainability.
AzaleeX
added
Priority: Low
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.
Description:
This pull request enhances
code documentationby adding comprehensiveJavaDoccomments to key methods in various classes and interfaces. The added comments describe method purposes, parameters, return values, and usage contexts, improving codereadability,maintainability, and developer understanding. Additionally, method documentation inHumanEntityhas been updated for clarity and flexibility, including modifications for more flexible skin packet broadcasts and codebase clean-up.