RFR: JDK-8252717: Integrate/merge legacy standard doclet diagnostics and doclint

[Jonathan Gibbons]

On Fri, 3 Jun 2022 07:48:15 GMT, Pavel Rappo <prappo at openjdk.org> wrote:

> > Since the introduction of doclint, there was some (small) overlap between the small set ... and the new larger set ... But, the sets do not overlap
> 
> Do or do they not overlap? :)

Ooops. Wrong word. I was meaning that neither set contains the other.

> 
> > the policy has inappropriately suppressed some warnings and inhibited the generation of new warnings
> 
> What's the difference between "suppressed" and "inhibited" here?

I was using "suppressed" with respect to existing doclet warnings, which have not been displayed if doclint was enabled, and was using "inhibited" with respect to writing code to generate new warnings, meaning that there was not much benefit to adding new warnings if they were typically going to be suppressed when doclint was enabled.


> 
> Generally, how can we be sure that we haven't missed any double-reported cases?

I did a visual inspection over the Checker class. Generally, Checker does more in the area of "missing" comments and HTML issues, with less focus on "reference" issues, while the doclet does not report missing comments and does not even attempt to detect HTML issues. The overlap is "syntax" issues and "reference" issues, which are covered here.

The test is set up to be a framework to accommodate new cases if any should arise.

-------------

PR: https://git.openjdk.java.net/jdk/pull/9006