Improve Javadoc across Java files #8
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
Enhanced Javadoc comments in DataMatrix.java, IDataMatrix.java, Matrix.java, and MatrixTypes.java. Key improvements include: - Added missing @param, @return, and @throws tags. - Improved clarity and conciseness of existing comments. - Ensured consistent and correct use of HTML tags. - Verified appropriate use of @SInCE tags. - Added @see tags to link related classes and methods. - Addressed TODO comments in DataMatrix.java, including updating the equals() method to handle null inputs correctly and noting the JDK version. - Clarified behavior of methods with array/list parameters, index handling, and automatic resizing. - Provided detailed descriptions for enum constants in MatrixTypes.java.
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.
Enhanced Javadoc comments in DataMatrix.java, IDataMatrix.java, Matrix.java, and MatrixTypes.java.
Key improvements include: