Re: Java 8 RFR 8020539: Clean up doclint problems in java.util package, part 2

[Joe Darcy]

Hi Brian,

For the changes in j.u.Random,
-     * pseudorandomly generated and returned. All 2<font size="-1"><sup>32
+     * pseudorandomly generated and returned. All 2<font 
style="font-size:smaller;"><sup>32

I would just dispense with the size adjustment of the exponent -- the 
<sup></sup> tag alone should be sufficient. Plain <sup></sup> is used in 
java.lang.Integer and elsewhere in the core libraries.

For the changes in Scanner, I recommend using definition lists instead. 
For guidance, here is an example from java.lang.Integer:

     * <dl>
     * <dt><i>DecodableString:</i>
     * <dd><i>Sign<sub>opt</sub> DecimalNumeral</i>
     * <dd><i>Sign<sub>opt</sub></i> {@code 0x} <i>HexDigits</i>
     * <dd><i>Sign<sub>opt</sub></i> {@code 0X} <i>HexDigits</i>
     * <dd><i>Sign<sub>opt</sub></i> {@code #} <i>HexDigits</i>
     * <dd><i>Sign<sub>opt</sub></i> {@code 0} <i>OctalDigits</i>
     * <p>
     * <dt><i>Sign:</i>
     * <dd>{@code -}
     * <dd>{@code +}
     * </dl>

The other changes look fine.

Thanks,

-Joe

On 07/16/2013 01:37 PM, Brian Burkhalter wrote:
Reviewers:

Issue:  http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=8020539
Webrev: http://cr.openjdk.java.net/~bpb/8020539/

I think the only dubious change in here is in the Scanner class comments. This was previously 
using empty <tt></tt> tag pairs for spacing purposes. I replaced each these with 
&nbsp; repeated four times. There is no visible change in the generated HTML from what I 
can see and doclint likes this better.

Thanks,

Brian