Skip to content

Issue #17642: enable javadoc warning but disable missing#17740

Merged
romani merged 1 commit into
checkstyle:masterfrom
romani:i17642-javadoc-def-ctor
Sep 4, 2025
Merged

Issue #17642: enable javadoc warning but disable missing#17740
romani merged 1 commit into
checkstyle:masterfrom
romani:i17642-javadoc-def-ctor

Conversation

@romani

@romani romani commented Sep 4, 2025

Copy link
Copy Markdown
Member

fixes #17642

based on https://stackoverflow.com/a/71785465
https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#doclint
https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet

missing: Checks for missing documentation comments or tags (for example, a missing comment or class, or a missing @return tag or similar tag on a method).

it is not ideal fix, but we enable warning and disable specific validations, we disabling a bit more than required, but it is limitation of javadoc tool

@romani romani force-pushed the i17642-javadoc-def-ctor branch from 60b3fef to 3413c57 Compare September 4, 2025 12:39
@AmitKumarDeoghoria

Copy link
Copy Markdown
Contributor

can we integrate require-javadoc plugin ?

@romani

romani commented Sep 4, 2025

Copy link
Copy Markdown
Member Author

we do not need to , we have our Checks for this.

@romani romani merged commit 723bf04 into checkstyle:master Sep 4, 2025
119 checks passed
@romani romani deleted the i17642-javadoc-def-ctor branch September 4, 2025 19:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix Javadoc Warnings: "use of default constructor, which does not provide a comment"

2 participants