Need sponsor to fix Javadoc warnings

Sat Apr 11 19:23:57 UTC 2020

Hi Pavel,

> On Apr 9, 2020, at 2:45 AM, Pavel Rappo <pavel.rappo at oracle.com> wrote:
> 
> If your new patch addresses a similar type of problem, please send it in reply to this email,
> so that I could merge it with the existing patch. Let's try to minimize process overhead if possible.
> 
This is additional patch:

--- old/src/java.base/share/classes/jdk/internal/icu/text/StringPrep.java	2020-04-12 00:33:54.818724363 +0530
+++ new/src/java.base/share/classes/jdk/internal/icu/text/StringPrep.java	2020-04-12 00:33:54.398714466 +0530
@@ -142,7 +142,7 @@
        /**
         * Called by com.ibm.icu.util.Trie to extract from a lead surrogate's
         * data the index array offset of the indexes for that lead surrogate.
-        * @param property data value for a surrogate from the trie, including
+        * @param value data value for a surrogate from the trie, including
         *        the folding offset
         * @return data offset or 0 if there is no data for the lead surrogate
         */
--- old/src/java.base/share/classes/sun/net/www/content/text/PlainTextInputStream.java	2020-04-12 00:33:55.778746974 +0530
+++ new/src/java.base/share/classes/sun/net/www/content/text/PlainTextInputStream.java	2020-04-12 00:33:55.346736801 +0530
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1996, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 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
@@ -39,7 +39,7 @@
 
     /**
      * Calls FilterInputStream's constructor.
-     * @param an InputStream
+     * @param is an InputStream
      */
     PlainTextInputStream(InputStream is) {
         super(is);
--- old/src/java.base/share/classes/sun/security/provider/certpath/RevocationChecker.java	2020-04-12 00:33:56.726769287 +0530
+++ new/src/java.base/share/classes/sun/security/provider/certpath/RevocationChecker.java	2020-04-12 00:33:56.306759403 +0530
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012, 2017, 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
@@ -881,7 +881,7 @@
      * only CRLs signed with a different key (but the same issuer
      * name) as the certificate being checked.
      *
-     * @param currCert the <code>X509Certificate</code> to be checked
+     * @param cert the <code>X509Certificate</code> to be checked
      * @param prevKey the <code>PublicKey</code> that failed
      * @param signFlag <code>true</code> if that key was trusted to sign CRLs
      * @param stackedCerts a <code>Set</code> of <code>X509Certificate</code>s>
--- old/src/java.base/share/classes/sun/security/provider/certpath/URICertStore.java	2020-04-12 00:33:57.658791207 +0530
+++ new/src/java.base/share/classes/sun/security/provider/certpath/URICertStore.java	2020-04-12 00:33:57.250781612 +0530
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2006, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2006, 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
@@ -166,7 +166,7 @@
     /**
      * Creates a URICertStore.
      *
-     * @param parameters specifying the URI
+     * @param params parameters specifying the URI
      */
     URICertStore(CertStoreParameters params)
         throws InvalidAlgorithmParameterException, NoSuchAlgorithmException {
--- old/src/java.base/share/classes/sun/security/ssl/StatusResponseManager.java	2020-04-12 00:33:58.602813394 +0530
+++ new/src/java.base/share/classes/sun/security/ssl/StatusResponseManager.java	2020-04-12 00:33:58.178803431 +0530
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2015, 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
@@ -483,7 +483,7 @@
          * and its corresponding CertId.
          *
          * @param subjectCert the certificate to be checked for revocation
-         * @param cid the CertId for {@code subjectCert}
+         * @param certId the CertId for {@code subjectCert}
          */
         StatusInfo(X509Certificate subjectCert, CertId certId) {
             cert = subjectCert;
--- old/src/java.base/share/classes/sun/security/timestamp/TSResponse.java	2020-04-12 00:33:59.542835473 +0530
+++ new/src/java.base/share/classes/sun/security/timestamp/TSResponse.java	2020-04-12 00:33:59.126825705 +0530
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2003, 2019, 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
@@ -193,7 +193,7 @@
     /**
      * Constructs an object to store the response to a timestamp request.
      *
-     * @param status A buffer containing the ASN.1 BER encoded response.
+     * @param tsReply A buffer containing the ASN.1 BER encoded response.
      * @throws IOException The exception is thrown if a problem is encountered
      *         parsing the timestamp response.
      */


>> On 8 Apr 2020, at 17:35, Vipin Sharma <vipinsharma85 at gmail.com> wrote:
>> 
>> 
>> 
>>> On Apr 8, 2020, at 6:57 PM, Pavel Rappo <pavel.rappo at oracle.com> wrote:
>>> 
>>> Why assume something that sophisticated where it can be adequately explained by
>>> a simpler thing? :) I bet it was an IDE inspection.
>>> 
>>> -Pavel
>> 
>> Yes, it was IDE inspection in java.base, it looked like the best way to start contributing and understand the process.
>> If it helps and not creating noise for you all, I see an opportunity for one more such patch. What do you think?
>> 
>>> 
>>>> On 8 Apr 2020, at 14:14, Alan Bateman <Alan.Bateman at oracle.com> wrote:
>>>> 
>>>> On 08/04/2020 14:07, Daniel Fuchs wrote:
>>>>> Hi Pavel,
>>>>> 
>>>>> On 08/04/2020 13:56, David Holmes wrote:
>>>>>> and `@exception` tags for checked exceptions that were neither thrown
>>>>>> nor imported
>>>>> 
>>>>> Hopefully that's only on internal classes.
>>>> From a quick scan, the changes are to internal classes and a few non-public elements of public API classes. So I don't think anything should impact the javadoc. I'm guessing this patch is motivated by something creating that is running the javadoc tool with different options to what the "docs" target uses.
>>>> 
>>>> -Alan
>>> 
>> 
>> Regards,
>> Vipin
> 
Regards,
Vipin


