JDK 8 code review request for java.math doclint / accessibility cleanup

[Lance Andersen]

Hi Joe,

Looks fine

Best
Lance
On Jun 26, 2013, at 3:21 PM, Joe Darcy <joe.darcy at oracle.com> wrote:

> Hello,
> 
> Please review the changes in the patch below; these change address the doclint and HTML accessibility issues in java.math.
> 
> I'll find an existing bug or if one is not present, file a new bug to cover this work.
> 
> Thanks,
> 
> -Joe
> 
> diff -r 336e5a862013 src/share/classes/java/math/BigDecimal.java
> --- a/src/share/classes/java/math/BigDecimal.java    Wed Jun 26 11:21:01 2013 -0700
> +++ b/src/share/classes/java/math/BigDecimal.java    Wed Jun 26 12:20:28 2013 -0700
> @@ -2572,6 +2572,9 @@
>      * ({@code this} * 10<sup>n</sup>).  The scale of
>      * the result is {@code (this.scale() - n)}.
>      *
> +     * @param n the exponent power to ten to scale by
> +     * @return a BigDecimal whose numerical value is equal to
> +     * ({@code this} * 10<sup>n</sup>)
>      * @throws ArithmeticException if the scale would be
>      *         outside the range of a 32-bit integer.
>      *
> diff -r 336e5a862013 src/share/classes/java/math/RoundingMode.java
> --- a/src/share/classes/java/math/RoundingMode.java    Wed Jun 26 11:21:01 2013 -0700
> +++ b/src/share/classes/java/math/RoundingMode.java    Wed Jun 26 12:20:28 2013 -0700
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 2003, 2011, Oracle and/or its affiliates. All rights reserved.
> + * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
>  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
>  *
>  * This code is free software; you can redistribute it and/or modify it
> @@ -101,6 +101,7 @@
>          *
>          *<p>Example:
>          *<table border>
> +         * <caption><b>Rounding mode UP Examples</b></caption>
>          *<tr valign=top><th>Input Number</th>
>          *    <th>Input rounded to one digit<br> with {@code UP} rounding
>          *<tr align=right><td>5.5</td> <td>6</td>
> @@ -124,6 +125,7 @@
>          *
>          *<p>Example:
>          *<table border>
> +         * <caption><b>Rounding mode DOWN Examples</b></caption>
>          *<tr valign=top><th>Input Number</th>
>          *    <th>Input rounded to one digit<br> with {@code DOWN} rounding
>          *<tr align=right><td>5.5</td> <td>5</td>
> @@ -148,6 +150,7 @@
>          *
>          *<p>Example:
>          *<table border>
> +         * <caption><b>Rounding mode CEILING Examples</b></caption>
>          *<tr valign=top><th>Input Number</th>
>          *    <th>Input rounded to one digit<br> with {@code CEILING} rounding
>          *<tr align=right><td>5.5</td> <td>6</td>
> @@ -172,6 +175,7 @@
>          *
>          *<p>Example:
>          *<table border>
> +         * <caption><b>Rounding mode FLOOR Examples</b></caption>
>          *<tr valign=top><th>Input Number</th>
>          *    <th>Input rounded to one digit<br> with {@code FLOOR} rounding
>          *<tr align=right><td>5.5</td> <td>5</td>
> @@ -198,6 +202,7 @@
>          *
>          *<p>Example:
>          *<table border>
> +         * <caption><b>Rounding mode HALF_UP Examples</b></caption>
>          *<tr valign=top><th>Input Number</th>
>          *    <th>Input rounded to one digit<br> with {@code HALF_UP} rounding
>          *<tr align=right><td>5.5</td> <td>6</td>
> @@ -223,6 +228,7 @@
>          *
>          *<p>Example:
>          *<table border>
> +         * <caption><b>Rounding mode HALF_DOWN Examples</b></caption>
>          *<tr valign=top><th>Input Number</th>
>          *    <th>Input rounded to one digit<br> with {@code HALF_DOWN} rounding
>          *<tr align=right><td>5.5</td> <td>5</td>
> @@ -255,6 +261,7 @@
>          *
>          *<p>Example:
>          *<table border>
> +         * <caption><b>Rounding mode HALF_EVEN Examples</b></caption>
>          *<tr valign=top><th>Input Number</th>
>          *    <th>Input rounded to one digit<br> with {@code HALF_EVEN} rounding
>          *<tr align=right><td>5.5</td> <td>6</td>
> @@ -278,6 +285,7 @@
>          * {@code ArithmeticException} is thrown.
>          *<p>Example:
>          *<table border>
> +         * <caption><b>Rounding mode UNNECESSARY Examples</b></caption>
>          *<tr valign=top><th>Input Number</th>
>          *    <th>Input rounded to one digit<br> with {@code UNNECESSARY} rounding
>          *<tr align=right><td>5.5</td> <td>throw {@code ArithmeticException}</td>
> 




Lance Andersen| Principal Member of Technical Staff | +1.781.442.2037
Oracle Java Engineering 
1 Network Drive 
Burlington, MA 01803
Lance.Andersen at oracle.com