RFR: 8284908: Refine diagnostic positions for DCErroneous
Jonathan Gibbons
jjg at openjdk.java.net
Wed Apr 20 21:50:42 UTC 2022
On Fri, 15 Apr 2022 16:58:55 GMT, Pavel Rappo <prappo at openjdk.org> wrote:
> Before:
>
> Standard Doclet version 18+36-2087
> Building tree for all the packages and classes...
> Generating /tmp/whatever/ExampleDiagnostics.html...
> ExampleDiagnostics.java:5: error: unexpected content
> * {@docRoot a}
> ^
> ExampleDiagnostics.java:11: error: unexpected content
> * {@inheritDoc a}
> ^
> ExampleDiagnostics.java:17: error: '>' expected
> * @param <T param
> ^
>
> After:
>
> Standard Doclet version 19-internal-2022-04-07-1105474.pavelrappo...
> Building tree for all the packages and classes...
> Generating /tmp/whatever/ExampleDiagnostics.html...
> ExampleDiagnostics.java:5: error: unexpected content
> * {@docRoot a}
> ^
> ExampleDiagnostics.java:11: error: unexpected content
> * {@inheritDoc a}
> ^
> ExampleDiagnostics.java:17: error: '>' expected
> * @param <T param
> ^
Looks generally good for me. One small suggestion in the base `DocCommentTester` class
test/langtools/tools/javac/doctree/DocCommentTester.java line 732:
> 730: var n = (DCTree) node;
> 731: out.println(simpleClassName(node) + "[" + node.getKind() + ", pos:" + n.pos +
> 732: (n.getPreferredPosition() > n.pos ? ", prefPos:" + n.getPreferredPosition() : ""));
Being paranoid, I suggest using `!=` instead of `>`
-------------
Marked as reviewed by jjg (Reviewer).
PR: https://git.openjdk.java.net/jdk/pull/8264
More information about the javadoc-dev
mailing list