Integrated: JDK-8271258: @param with non-ascii variable names produces incorrect results

Jonathan Gibbons jjg at openjdk.java.net
Tue Aug 24 14:44:29 UTC 2021


On Wed, 18 Aug 2021 20:10:48 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

> Please review a simple change to fix the use of non-ASCII characters in @param names.
> 
> The underlying problem was accidentally relying on `DocTree.toString()` for an `IdentifierTree` in `CommentHelper`.  The fix is simply to get the underlying `Name` and call `toString` on that.
> 
> There is some loosely related cleanup in `ParamTaglet`. I did see if it was possible to avoid excessive use of `String` in this part of the code, but that quickly became a rat-hole.
> 
> The existing related test is updated to include this new case, of a Chinese identifier occurring in various places, similar to the test case in the original bug.

This pull request has now been integrated.

Changeset: 94f5e441
Author:    Jonathan Gibbons <jjg at openjdk.org>
URL:       https://git.openjdk.java.net/jdk/commit/94f5e441f637b7a75227ba11a2b25d70f96cd274
Stats:     92 lines in 3 files changed: 62 ins; 6 del; 24 mod

8271258: @param with non-ascii variable names produces incorrect results

Reviewed-by: hannesw

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

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


More information about the javadoc-dev mailing list