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.

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

JDK-8272374: doclint should report missing "body" comments #5106

Closed
wants to merge 2 commits into from
Closed

JDK-8272374: doclint should report missing "body" comments #5106

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
60c6f56
JDK-8272374: doclint should report missing "body" comments
jonathan-gibbons Aug 13, 2021
6c87568
address review comment
jonathan-gibbons Aug 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclint/Checker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,10 +197,9 @@ public Void scan(DocCommentTree tree, TreePath p) {
reportMissing("dc.empty.comment");
return null;
} else {
DocTree firstTag = tree.getBlockTags().get(0);
// Don't report an empty description if the comment begins with @deprecated,
// Don't report an empty description if the comment contains @deprecated,
// because javadoc will use the content of that tag in summary tables.
if (firstTag.getKind() != DocTree.Kind.DEPRECATED) {
if (tree.getBlockTags().stream().allMatch(t -> t.getKind() != DocTree.Kind.DEPRECATED)) {
env.messages.report(MISSING, Kind.WARNING, tree, "dc.empty.description");
Copy link
Member

Choose a reason for hiding this comment

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

Is there a reason to not use reportMissing here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It doesn't have the right signature. reportMissing reports a missing comment on an element; here, we're reporting a missing description within a DocTree. There's a similar occurrence at line 1214.

}
}
Expand Down