On Wed, 16 Jun 2021 17:18:31 GMT, Jonathan Gibbons <[email protected]> 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
Re-synchronize with the CSR.
src/jdk.javadoc/share/classes/jdk/javadoc/doclet/Reporter.java line 97:
> 95: * The positions should satisfy the relation {@code start <= pos <=
> end}.
> 96: *
> 97: * @implNote
Should be `@implSpec` instead; please make sure the CSR is updated as well
since it also uses `@implNote`.
src/jdk.javadoc/share/classes/jdk/javadoc/doclet/Reporter.java line 99:
> 97: * @implNote
> 98: * This implementation ignores the {@code (start, pos, end)} values
> and simply calls
> 99: * {@link #print(Diagnostic.Kind, DocTreePath,String) print(kind,
> path, message)};
Add a single space character after `,` in the reference.
-------------
Changes requested by prappo (Reviewer).
PR: https://git.openjdk.java.net/jdk/pull/4489
