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

FindMissingTypes: New option to check references in Javadoc #5206

Merged
merged 2 commits into from
Mar 21, 2025

Conversation

knutwannheden
Copy link
Contributor

@knutwannheden knutwannheden commented Mar 21, 2025

Up until now references in Javadoc have always been checked and reported by this recipe. Now this check is optional.

@okundzich
Copy link
Member

Curious why we change the default in this recipe (according to the title of this PR) rather than just using a different configuration from the compilation verification

@knutwannheden
Copy link
Contributor Author

Curious why we change the default in this recipe (according to the title of this PR) rather than just using a different configuration from the compilation verification

I was also unsure about this. Maybe we should indeed keep the default. At the moment we basically just have two uses: The test harness and the compile verification. For the test harness the default is still to check for missing types in Javadoc.

But I can definitely also change the default of the recipe to true.

@knutwannheden knutwannheden changed the title FindMissingTypes now by default does not check Javadoc FindMissingTypes: New option to check references in Javadoc Mar 21, 2025
@knutwannheden
Copy link
Contributor Author

I lean towards leaving the default as is (not check documentation) because we typically use this recipe to check if something went wrong during the ingestion and missing types in Javadoc are not helpful then, because we can't easily tell if it is the Javadoc that is wrong or not.

@knutwannheden knutwannheden merged commit 20dc764 into main Mar 21, 2025
2 checks passed
@knutwannheden knutwannheden deleted the no-missing-javadoc-references branch March 21, 2025 13:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants