RFR: JDK-8242607 -Xdoclint doesn't report missing/unexpected comments

Jonathan Gibbons jonathan.gibbons at oracle.com
Tue Jun 9 04:48:57 UTC 2020


Please review a partial fix for this issue, which is about different 
doclint results
when invoking doclint from javac and javadoc.

The reason for the partial fix is explained here:
https://bugs.openjdk.java.net/browse/JDK-8242607?focusedCommentId=14344614&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-14344614

Within the patch, the primary change is the restructuring of the 
if-statement at about line 2706
in Utils.java. Specifically, the call

	configuration.workArounds.runDocLint(path);

is moved outside of the test

if (docCommentTree != null

which is the root cause of the error.

At the same time, the patch includes a minor cleanup to rename the 
`DocCommentDuo`
class to a slightly more abstract name `DocCommentInfo`. The old 
`DocCommentDuo`
inappropriately reflects some of the historical origins of the name. The 
change percolates
into some local variable names and member names as well.  I also tried 
to cleanup some
of the comments in this area, without changing functionality. The net 
result is a
perceived need for more cleanup, including functionality cleanup, in 
another changeset.

-- Jon


JBS: https://bugs.openjdk.java.net/browse/JDK-8242607
Webrev: http://cr.openjdk.java.net/~jjg/8242607/webrev.00/

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.openjdk.java.net/pipermail/javadoc-dev/attachments/20200608/5c9c04e0/attachment.htm>


More information about the javadoc-dev mailing list