RFR 7061590 : Javadoc issues in Charset and StandardCharsets

[Jonathan Gibbons]

Ivan,

You would do better to avoid the use of the shorthand "a.k.a." which may 
not be known to many readers.  In general, the style should be to avoid 
abbreviations like this, including e.g. i.e. etc. (sic)

I recommend replacing "a.k.a." with "also known as:.

-- Jon


On 05/20/2019 11:48 AM, Ivan Gerasimov wrote:
> Hello!
>
> A few small javadoc issues.
>
> The most visible one is that the last dot in abbreviation a.k.a. is 
> treated as a period, so the generated description appears broken (see 
> [1] 
> <https://docs.oracle.com/en/java/javase/12/docs/api/java.base/java/nio/charset/StandardCharsets.html>):
>
> static Charset    ISO_8859_1    ISO Latin Alphabet No. 1, a.k.a.
> static Charset    US_ASCII      Seven-bit ASCII, a.k.a.
> ...
>
> Would you please help review the fix?
>
> BUGURL: https://bugs.openjdk.java.net/browse/JDK-7061590
> WEBREV: http://cr.openjdk.java.net/~igerasim/7061590/00/webrev/
>
> [1] 
> https://docs.oracle.com/en/java/javase/12/docs/api/java.base/java/nio/charset/StandardCharsets.html
>