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

More validation of documenting annotations #165

Merged
merged 6 commits into from
Jun 16, 2024

Conversation

WaitingIdly
Copy link
Collaborator

changes in this PR:

  • adds some more checks for missing document stuff, logging as warns.
    • No methods targeting an annotated field (Couldn't find any methods targeting field '{}' in recipe builder '{}')
    • No such annotated field targeted by a method (Couldn't find field '{}' referenced in a method used for recipe builder '{}')
    • No fields used at all (Couldn't find any fields being used for recipe builder '{}')
  • removed an used constructor param for the Builder.
  • updated annotations, a lang key, and an example file to ensure existing annotations pass these checks. (impacts Pyrotech, Astral Sorcery, Mekanism, and Rustic)

@WaitingIdly WaitingIdly added the documentation Improvements or additions to documentation label May 22, 2024
@brachy84 brachy84 merged commit 21915c9 into CleanroomMC:master Jun 16, 2024
@WaitingIdly WaitingIdly deleted the more-doc-warnings branch July 7, 2024 03:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants