Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#1117 Fix incorrectly configured scope bounds for Javadoc Checkstyle checks #1118

Merged
merged 7 commits into from
Nov 12, 2024

Conversation

GuusLieben
Copy link
Member

@GuusLieben GuusLieben commented Oct 27, 2024

Type of Change

  • Documentation (documentation changes)
  • Chore (changes to the build process or auxiliary tools)

Description

The checkstyle.xml configuration in hartshorn-assembly incorrectly uses excludeScope. The value of excludeScope applies to the scope property, which defaults to public (instead of our assumption to include all by default). Following https://checkstyle.sourceforge.io/property_types.html#Scope, this means only public 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

  • I have performed a self-review of my own code
  • New and existing unit tests pass locally with my changes
  • Related issue number is linked in pull request title
  • I have added documentation that describes my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have rebased my branch on top of the latest develop branch

Related Issue

Closes #1117

Previously documentation for these types was missed, and did not get
blocked by CI as the Checkstyle configuration was incorrect.
@GuusLieben GuusLieben merged commit 955d6ec into develop/0.7.0 Nov 12, 2024
9 checks passed
@GuusLieben GuusLieben deleted the chore/#1117-checkstyle-javadoc-scope branch November 12, 2024 07:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

Checkstyle MissingJavadocType, JavadocType, and MissingJavadocMethod excludeScope is configured wrongly
1 participant