JDK-8251200: False positive messages about missing comments for serialization

[jonathan-gibbons]

Using the @serial tag, a class can explicitly opt-in to being documented on the serialized form page. However, a class that does not want to opt-in should not be required to have a doc comment, and should not trigger the "missing comment" warning if there is no comment.

The fix is to check for the presence of the comment on a class before analyzing it to see if it contains @serial tags.

The code in Utils.getDocCommentTree0 is slightly refactored to allow a new predicate hasDocCommentTree to be added.

---

Progress

• Change must not contain extraneous whitespace
• Commit message must refer to an issue
• Change must be properly reviewed

Issue

• JDK-8251200: False positive messages about missing comments for serialization

Reviewers

• Hannes Wallnöfer (@hns - Reviewer) ⚠️ Review applies to 76b61ce

Download

$ git fetch https://git.openjdk.java.net/jdk16 pull/70/head:pull/70
$ git checkout pull/70

[bridgekeeper]

👋 Welcome back jjg! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

[openjdk]

@jonathan-gibbons The following label will be automatically applied to this pull request:

• javadoc

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

[mlbridge]

Webrevs

• 01: Full - Incremental (fc58528)
• 00: Full (76b61ce)

[hns]

Looks good, apart from two typos in a comment.

[hns]

typo: eleme nt

[openjdk]

@jonathan-gibbons This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8251200: False positive messages about missing comments for serialization

Reviewed-by: hannesw

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been no new commits pushed to the master branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

[kusrinivasan]

Looks good, saw the same typos Hannes noted.

[jonathan-gibbons]

/integrate

[openjdk]

@jonathan-gibbons Pushed as commit eef43be.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.