Skip to content

Annotation processor for documentation enforcing #151

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.

Sign up for GitHub

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

Jump to bottom
Open
todvora wants to merge 2 commits into
base: feature/parameter-types-validator-processor
Choose a base branch
from
Open

Annotation processor for documentation enforcing #151

todvora wants to merge 2 commits into from

Conversation

@todvora
Copy link
Contributor

@todvora todvora commented Dec 10, 2025

This annotation processor is validating that every field annotated with @Parameter also has a valid @Documentation attached. This will force us to document every changed and added configuration property.

image

Notes for Reviewers

  • The commit history must be preserved - please use the rebase-merge or standard merge option instead of squash-merge
  • Sync up with the author before merging

@janheise janheise self-requested a review December 10, 2025 13:08
janheise
janheise approved these changes Dec 10, 2025
View reviewed changes
Copy link
Contributor

@janheise janheise left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@janheise janheise janheise approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@todvora @janheise