Add explicit constructors to satisfy Javadoc #118
Merged
+125
−5
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
By testing the code base using Java 21 (the default version on the most recent Debian), it was revealed that its Javadoc version generates many warnings. Most were due to classes "using a default constructor which does not provide a comment"; this was addressed by adding an explicit contructor with a trivial comment (perhaps a better one can be added, for some of them). A couple of few other missing comments were added. Since this set of changes is orthogonal to using Java 17 vs 21, it's submitted as a separate PR to be merged.
actyp
approved these changes
Nov 7, 2025
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.
By testing the code base using Java 21 (the default version on the most recent Debian), it was revealed that its Javadoc version generates many warnings. Most were due to classes "using a default constructor which does not provide a comment"; this was addressed by adding an explicit contructor with a trivial comment (perhaps a better one can be added, for some of them). A couple of few other missing comments were added.
Since this set of changes is orthogonal to using Java 17 vs 21, it's submitted as a separate PR to be merged.