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

Improve MissingDoclet linter to check records correctly #13332

Merged
merged 4 commits into from
Apr 30, 2024

Conversation

uschindler
Copy link
Contributor

New checks:

  • exclude default ctors
  • exclude accessor methods (like with enums)
  • on "method" level checking also check that every record component has an @param tag

See #13329 for more information.

- exclude default ctors
- exclude accessor methods (like with enums)
- on "method" level checking also check that every record component has an @param tag
@uschindler
Copy link
Contributor Author

We have no tests for the linter, but I validated that the code complains correctly on missing javadocs for components and excludes component accessors.

@uschindler uschindler requested a review from rmuir April 30, 2024 14:58
@uschindler
Copy link
Contributor Author

I will merge this later this evening so we can proceed with #13328

Copy link
Member

@rmuir rmuir left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you for taking care of this

@uschindler uschindler merged commit e6dac34 into apache:main Apr 30, 2024
3 checks passed
@uschindler uschindler deleted the dev/improveRecordMissingDoclet branch April 30, 2024 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants