#1117 Fix incorrectly configured scope bounds for Javadoc Checkstyle checks #1118
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.
Type of Change
Description
The
checkstyle.xml
configuration in hartshorn-assembly incorrectly usesexcludeScope
. The value ofexcludeScope
applies to thescope
property, which defaults topublic
(instead of our assumption to include all by default). Following https://checkstyle.sourceforge.io/property_types.html#Scope, this means onlypublic
is checked, while package-private, protected, private, and anonymous inner classes are always skipped.These changes fix this issue by correctly setting up the scope boundaries of the configuration. Additionally, pending documentation is included in this PR, to ensure CI passes going forward.
Checklist
develop
branchRelated Issue
Closes #1117