Fix for Javadoc errors in java.base

[Joe Darcy]

Hi Vipin,

My review comments on the files I look after is interspersed below.

On 7/27/2020 10:28 PM, Vipin Sharma wrote:
> Hi Joe,
>
> I ran an IntelliJ inspection to find these errors.
>
> Regards,
> Vipin
>
> <https://www.avast.com/sig-email?utm_medium=email&utm_source=link&utm_campaign=sig-email&utm_content=webmail> 
> 	Virus-free. www.avast.com 
> <https://www.avast.com/sig-email?utm_medium=email&utm_source=link&utm_campaign=sig-email&utm_content=webmail> 
>
>
>
> On Tue, Jul 28, 2020 at 5:53 AM Joe Darcy <joe.darcy at oracle.com 
> <mailto:joe.darcy at oracle.com>> wrote:
>
>     Hello Vipin,
>
>     What tooling was used to find these errors? Running doclint against
>     private methods too?
>
>     Thanks,
>
>     -Joe
>
>     On 7/27/2020 12:37 PM, Vipin Sharma wrote:
>     > Hi,
>     >
>     > This patch fixes Javadoc errors in java.base, please sponsor
>     this patch and
>     > help to create a bug id for this.
>     > I have signed OCA, this is my third patch.
>     >
>

>     > --- old/src/java.base/share/classes/java/math/BigDecimal.java
>     2020-07-25
>     > 23:46:24.285759291 +0530
>     > +++ new/src/java.base/share/classes/java/math/BigDecimal.java
>     2020-07-25
>     > 23:46:23.785753966 +0530
>     > @@ -5413,7 +5413,7 @@
>     >        *
>     >        * @param n the numerator; must be negative
>     >        * @param d the denominator; must not be unity
>     > -     * @return a two-element {@long} array with the remainder
>     and quotient
>     > in
>     > +     * @return a two-element {@code long} array with the
>     remainder and
>     > quotient in
>     >        *         the initial and final elements, respectively
>     >        */
>     >       private static long[] divRemNegativeLong(long n, long d) {
>

Looks fine.


>     > --- old/src/java.base/share/classes/java/math/MutableBigInteger.java
>     > 2020-07-25 23:46:25.381770889 +0530
>     > +++ new/src/java.base/share/classes/java/math/MutableBigInteger.java
>     > 2020-07-25 23:46:24.877765572 +0530
>     > @@ -145,7 +145,6 @@
>     >        * Makes this number an {@code n}-int number all of whose
>     bits are
>     > ones.
>     >        * Used by Burnikel-Ziegler division.
>     >        * @param n number of ints in the {@code value} array
>     > -     * @return a number equal to {@code ((1<<(32*n)))-1}
>     >        */
>     >       private void ones(int n) {
>     >           if (n > value.length)
>
Looks fine.


>     >
>     old/src/java.base/share/classes/sun/reflect/annotation/AnnotationParser.java
>     > 2020-07-25 23:46:28.545803801 +0530
>     > +++
>     >
>     new/src/java.base/share/classes/sun/reflect/annotation/AnnotationParser.java
>     > 2020-07-25 23:46:28.029798501 +0530
>     > @@ -1,5 +1,5 @@
>     >   /*
>     > - * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All
>     rights
>     > reserved.
>     > + * Copyright (c) 2003, 2020, 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
>     > @@ -773,7 +773,7 @@
>     >        * an "annotation structure" OR two bytes into an annotation
>     >        * structure (i.e., after the type index).
>     >        *
>     > -     * @parameter complete true if the byte buffer points to
>     the beginning
>     > +     * @param complete true if the byte buffer points to the
>     beginning
>     >        *     of an annotation structure (rather than two bytes in).
>     >        */
>     >       private static void skipAnnotation(ByteBuffer buf, boolean
>     complete) {
>
Also looks fine.

Cheers,

-Joe



>
> 	
>