RFR: JDK-8268420: new Reporter method to report a diagnostic within a DocTree node [v5]

[Pavel Rappo]

On Fri, 9 Jul 2021 15:07:30 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

>> Please review an update to add a new method in Reporter to report a diagnostic within a DocTree node for those DocTree nodes that wrap a string.
>> 
>> This is the last of the current round of updates to improve the diagnostics that can be generated by javadoc.
>> 
>> The general fix, in JavadocLog and Reporter, is pretty simple, given all the improvements in recent related changes.
>> 
>> There are some cosmetic cleanups that were made while exploring the current solution.
>> 
>> The test is "reasonably thorough" and uses a custom taglet to generate diagnostics for selected nodes in doc comment trees. The test then "algorithmically validates" (i.e. no golden files or text blocks) the diagnostics that are either passed to a DiagnosticListener or written to the console stream.
>
> Jonathan Gibbons has updated the pull request incrementally with one additional commit since the last revision:
> 
>   address review feedback

Looks good. I only note that Reporter now imports four types from the com.sun.source.doctree package for documentation purposes; it's not bad, but it's worth noting.

Will anyone from the compiler team review this change too?

test/langtools/jdk/javadoc/doclet/testDocTreeDiags/MyTaglet.java line 50:

> 48: 
> 49: /**
> 50:  * A taglet to be called in the context of the sdtandard doclet.

A typo: sdtandard

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

Marked as reviewed by prappo (Reviewer).

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