Fix for Javadoc errors in java.base
Vipin Sharma
vipinsharma85 at gmail.com
Tue Jul 28 05:28:03 UTC 2020
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>
<#DAB4FAD8-2DD7-40BB-A1B8-4E2AA1F9FDF2>
On Tue, Jul 28, 2020 at 5:53 AM Joe Darcy <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/com/sun/crypto/provider/DHPrivateKey.java
> > 2020-07-25 23:46:21.233726447 +0530
> > +++
> > new/src/java.base/share/classes/com/sun/crypto/provider/DHPrivateKey.java
> > 2020-07-25 23:46:20.721720857 +0530
> > @@ -96,8 +96,6 @@
> > * @param p the prime modulus
> > * @param g the base generator
> > * @param l the private-value length
> > - *
> > - * @exception InvalidKeyException if the key cannot be encoded
> > */
> > DHPrivateKey(BigInteger x, BigInteger p, BigInteger g, int l) {
> > this.x = x;
> > ---
> >
> old/src/java.base/share/classes/java/lang/invoke/AbstractValidatingLambdaMetafactory.java
> > 2020-07-25 23:46:22.241737383 +0530
> > +++
> >
> new/src/java.base/share/classes/java/lang/invoke/AbstractValidatingLambdaMetafactory.java
> > 2020-07-25 23:46:21.745732013 +0530
> > @@ -1,5 +1,5 @@
> > /*
> > - * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights
> > reserved.
> > + * Copyright (c) 2012, 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
> > @@ -208,7 +208,7 @@
> > *
> > * @return a CallSite, which, when invoked, will return an
> instance of
> > the
> > * functional interface
> > - * @throws ReflectiveOperationException
> > + * @throws LambdaConversionException
> > */
> > abstract CallSite buildCallSite()
> > throws LambdaConversionException;
> > ---
> >
> old/src/java.base/share/classes/java/lang/invoke/InnerClassLambdaMetafactory.java
> > 2020-07-25 23:46:23.261748361 +0530
> > +++
> >
> new/src/java.base/share/classes/java/lang/invoke/InnerClassLambdaMetafactory.java
> > 2020-07-25 23:46:22.761742991 +0530
> > @@ -200,7 +200,6 @@
> > *
> > * @return a CallSite, which, when invoked, will return an
> instance of
> > the
> > * functional interface
> > - * @throws ReflectiveOperationException
> > * @throws LambdaConversionException If properly formed functional
> > interface
> > * is not found
> > */
> > --- 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) {
> > --- 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)
> > --- old/src/java.base/share/classes/java/net/ServerSocket.java 2020-07-25
> > 23:46:26.449782093 +0530
> > +++ new/src/java.base/share/classes/java/net/ServerSocket.java 2020-07-25
> > 23:46:25.937776742 +0530
> > @@ -1,5 +1,5 @@
> > /*
> > - * Copyright (c) 1995, 2019, Oracle and/or its affiliates. All rights
> > reserved.
> > + * Copyright (c) 1995, 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
> > @@ -315,7 +315,7 @@
> > /**
> > * Creates the socket implementation.
> > *
> > - * @throws IOException if creation fails
> > + * @throws SocketException if creation fails
> > * @since 1.4
> > */
> > void createImpl() throws SocketException {
> > --- old/src/java.base/share/classes/java/net/Socket.java 2020-07-25
> > 23:46:27.485792869 +0530
> > +++ new/src/java.base/share/classes/java/net/Socket.java 2020-07-25
> > 23:46:26.973787565 +0530
> > @@ -533,7 +533,7 @@
> > *
> > * @param stream a {@code boolean} value : {@code true} for a TCP
> > socket,
> > * {@code false} for UDP.
> > - * @throws IOException if creation fails
> > + * @throws SocketException if creation fails
> > * @since 1.4
> > */
> > void createImpl(boolean stream) throws SocketException {
> > ---
> >
> 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) {
> >
> >
> > 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>
<#DAB4FAD8-2DD7-40BB-A1B8-4E2AA1F9FDF2>
More information about the core-libs-dev
mailing list