docs(util): add Javadoc to protected utility constructors - #19
Merged
Conversation
Document the protected constructors of CommonPoolUtil and StreamUtil with a brief 'Do not instantiate.' note, matching the utility-class convention.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Adds Javadoc to the protected constructors of two utility classes so the generated API docs no longer leave them undocumented.
Changes Made
CommonPoolUtil: documented theprotectedconstructor with a briefDo not instantiate.note.StreamUtil: documented theprotectedconstructor with the same note.Both follow the existing utility-class convention (abstract class + protected constructor that is never meant to be called).
Testing
mvn testsuite still applies and was unaffected.Breaking Changes
Additional Notes