archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-08-27 14:54:52 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8242366: Fix JavaDoc warnings

Browse source 
Reviewed-by: dfuchs, mullan, prappo, weijun
This commit is contained in:
Vipin Sharma 2020-04-15 20:42:43 +01:00 • committed by Pavel Rappo
parent 941bb3bcb8
commit cc05419e1a
23 changed files with 44 additions and 56 deletions
Download patch file Download diff file Expand all files Collapse all files

4
src/java.base/share/classes/com/sun/crypto/provider/AESCipher.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2002, 2017, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2002, 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
@ -202,7 +202,7 @@ abstract class AESCipher extends CipherSpi {
/**
* Sets the padding mechanism of this cipher.
*
* @param padding the padding mechanism
* @param paddingScheme the padding mechanism
*
* @exception NoSuchPaddingException if the requested padding mechanism
* does not exist

8
src/java.base/share/classes/com/sun/crypto/provider/AESWrapCipher.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2004, 2017, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2004, 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
@ -313,10 +313,10 @@ abstract class AESWrapCipher extends CipherSpi {
* current Cipher.engineInit(...) implementation,
* IllegalStateException will always be thrown upon invocation.
*
* @param in the input buffer
* @param inOffset the offset in <code>in</code> where the input
* @param input the input buffer
* @param inputOffset the offset in <code>in</code> where the input
* starts
* @param inLen the input length.
* @param inputLen the input length.
*
* @return n/a.
*

4
src/java.base/share/classes/com/sun/crypto/provider/BlowfishCrypt.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1998, 2007, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1998, 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
@ -130,7 +130,6 @@ final class BlowfishCrypt extends SymmetricCipher
*
* @param plain the buffer with the input data to be encrypted
* @param plainOffset the offset in <code>plain</code>
* @param plainLen the length of the input data
* @param cipher the buffer for the result
* @param cipherOffset the offset in <code>cipher</code>
*/
@ -154,7 +153,6 @@ final class BlowfishCrypt extends SymmetricCipher
*
* @param cipher the buffer with the input data to be decrypted
* @param cipherOffset the offset in <code>cipherOffset</code>
* @param cipherLen the length of the input data
* @param plain the buffer for the result
* @param plainOffset the offset in <code>plain</code>
*/

10
src/java.base/share/classes/com/sun/crypto/provider/DESCrypt.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 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
@ -552,12 +552,8 @@ class DESCrypt extends SymmetricCipher implements DESConstants {
*
* @param plain the buffer with the input data to be encrypted
* @param plainOffset the offset in <code>plain</code>
* @param plainLen the length of the input data
* @param cipher the buffer for the result
* @param cipherOffset the offset in <code>cipher</code>
*
* @exception IllegalBlockSizeException if the input length is different
* from the cipher's block size
*/
void encryptBlock(byte[] plain, int plainOffset,
byte[] cipher, int cipherOffset)
@ -579,12 +575,8 @@ class DESCrypt extends SymmetricCipher implements DESConstants {
*
* @param cipher the buffer with the input data to be decrypted
* @param cipherOffset the offset in <code>cipherOffset</code>
* @param cipherLen the length of the input data
* @param plain the buffer for the result
* @param plainOffset the offset in <code>plain</code>
*
* @exception IllegalBlockSizeException if the input length is different
* from the cipher's block size
*/
void decryptBlock(byte[] cipher, int cipherOffset,
byte[] plain, int plainOffset)

8
src/java.base/share/classes/com/sun/crypto/provider/GaloisCounterMode.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2013, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2013, 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
@ -262,8 +262,6 @@ final class GaloisCounterMode extends FeedbackCipher {
* @param algorithm the algorithm name
* @param key the key
* @param iv the iv
* @param tagLenBytes the length of tag in bytes
*
* @exception InvalidKeyException if the given key is inappropriate for
* initializing this cipher
*/
@ -279,8 +277,8 @@ final class GaloisCounterMode extends FeedbackCipher {
*
* @param decrypting flag indicating encryption or decryption
* @param algorithm the algorithm name
* @param key the key
* @param iv the iv
* @param keyValue the key
* @param ivValue the iv
* @param tagLenBytes the length of tag in bytes
*
* @exception InvalidKeyException if the given key is inappropriate for

4
src/java.base/share/classes/com/sun/crypto/provider/PBEKeyFactory.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2018, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 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
@ -225,7 +225,7 @@ abstract class PBEKeyFactory extends SecretKeyFactorySpi {
*
* @param key the key
*
* @param keySpec the requested format in which the key material shall be
* @param keySpecCl the requested format in which the key material shall be
* returned
*
* @return the underlying key specification (key material) in the

2
src/java.base/share/classes/com/sun/crypto/provider/PBES1Core.java
View file

@ -92,7 +92,7 @@ final class PBES1Core {
* Sets the padding mechanism of this cipher. This algorithm only uses
* PKCS #5 padding.
*
* @param padding the padding mechanism
* @param paddingScheme the padding mechanism
*
* @exception NoSuchPaddingException if the requested padding mechanism
* is invalid

4
src/java.base/share/classes/com/sun/crypto/provider/PBKDF2Core.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2005, 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
@ -75,7 +75,7 @@ abstract class PBKDF2Core extends SecretKeyFactorySpi {
*
* @param key the key
*
* @param keySpec the requested format in which the key material shall be
* @param keySpecCl the requested format in which the key material shall be
* returned
*
* @return the underlying key specification (key material) in the

4
src/java.base/share/classes/com/sun/crypto/provider/Padding.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2007, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 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
@ -49,7 +49,7 @@ interface Padding {
* interface.
*
* @param in the input buffer with the data to pad
* @param the offset in <code>in</code> where the padding bytes
* @param off the offset in <code>in</code> where the padding bytes
* are appended
* @param len the number of padding bytes to add
*

4
src/java.base/share/classes/com/sun/crypto/provider/SymmetricCipher.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2007, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 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
@ -29,7 +29,7 @@ import java.security.InvalidKeyException;
/**
* This abstract class represents the core of all block ciphers. It allows to
* intialize the cipher and encrypt/decrypt single blocks. Larger quantities
* initialize the cipher and encrypt/decrypt single blocks. Larger quantities
* are handled by modes, which are subclasses of FeedbackCipher.
*
* @author Gigi Ankeny

2
src/java.base/share/classes/java/lang/ProcessBuilder.java
View file

@ -1077,7 +1077,7 @@ public final class ProcessBuilder
* Start a new Process using an explicit array of redirects.
* See {@link #start} for details of starting each Process.
*
* @param redirect array of redirects for stdin, stdout, stderr
* @param redirects array of redirects for stdin, stdout, stderr
* @return the new Process
* @throws IOException if an I/O error occurs
*/

2
src/java.base/share/classes/java/util/GregorianCalendar.java
View file

@ -731,7 +731,7 @@ public class GregorianCalendar extends Calendar {
* Constructs an empty GregorianCalendar.
*
* @param zone the given time zone
* @param aLocale the given locale
* @param locale the given locale
* @param flag the flag requesting an empty instance
*/
GregorianCalendar(TimeZone zone, Locale locale, boolean flag) {

4
src/java.base/share/classes/sun/net/util/IPAddressUtil.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2004, 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
@ -316,7 +316,7 @@ public class IPAddressUtil {
* If the address already has a scope-id or if the address is not local, ipv6
* or link local, then the original address is returned.
*
* @param addr
* @param address
* @exception SocketException if the given ipv6 link local address is found
* on more than one local interface
* @return

4
src/java.base/share/classes/sun/net/www/content/text/PlainTextInputStream.java
View file

@ -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 @@ public class PlainTextInputStream extends FilterInputStream {
/**
* Calls FilterInputStream's constructor.
* @param an InputStream
* @param is an InputStream
*/
PlainTextInputStream(InputStream is) {
super(is);

4
src/java.base/share/classes/sun/net/www/protocol/https/HttpsClient.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2001, 2018, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2001, 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 @@ final class HttpsClient extends HttpClient
* Use New to get new HttpsClient. This constructor is meant to be
* used only by New method. New properly checks for URL spoofing.
*
* @param URL https URL with which a connection must be established
* @param url https URL with which a connection must be established
*/
private HttpsClient(SSLSocketFactory sf, URL url)
throws IOException

2
src/java.base/share/classes/sun/security/jca/ProviderConfig.java
View file

@ -321,7 +321,7 @@ final class ProviderConfig {
/**
* Loads the provider with the specified class name.
*
* @param name the name of the provider
* @param pn the name of the provider
* @return the Provider, or null if it cannot be found or loaded
* @throws ProviderException all other exceptions are ignored
*/

4
src/java.base/share/classes/sun/security/provider/certpath/BasicChecker.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2000, 2012, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2000, 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
@ -72,7 +72,7 @@ class BasicChecker extends PKIXCertPathChecker {
* Constructor that initializes the input parameters.
*
* @param anchor the anchor selected to validate the target certificate
* @param testDate the time for which the validity of the certificate
* @param date the time for which the validity of the certificate
* should be determined
* @param sigProvider the name of the signature provider
* @param sigOnly true if only signature checking is to be done;

4
src/java.base/share/classes/sun/security/provider/certpath/Builder.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2000, 2018, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2000, 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
@ -69,7 +69,7 @@ public abstract class Builder {
/**
* Initialize the builder with the input parameters.
*
* @param params the parameter set used to build a certification path
* @param buildParams the parameter set used to build a certification path
*/
Builder(BuilderParams buildParams) {
this.buildParams = buildParams;

6
src/java.base/share/classes/sun/security/provider/certpath/RevocationChecker.java
View file

@ -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,10 +881,10 @@ class RevocationChecker extends PKIXRevocationChecker {
* 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>
* @param stackedCerts a <code>Set</code> of <code>X509Certificate</code>s
* whose revocation status depends on the
* non-revoked status of this cert. To avoid
* circular dependencies, we assume they're

4
src/java.base/share/classes/sun/security/provider/certpath/URICertStore.java
View file

@ -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 @@ class URICertStore extends CertStoreSpi {
/**
* Creates a URICertStore.
*
* @param parameters specifying the URI
* @param params specifying the URI
*/
URICertStore(CertStoreParameters params)
throws InvalidAlgorithmParameterException, NoSuchAlgorithmException {

4
src/java.base/share/classes/sun/security/ssl/StatusResponseManager.java
View file

@ -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 @@ final class StatusResponseManager {
* 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;

4
src/java.base/share/classes/sun/security/timestamp/TSResponse.java
View file

@ -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 @@ public class TSResponse {
/**
* 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.
*/

4
src/java.base/share/classes/sun/text/DictionaryBasedBreakIterator.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1999, 2016, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1999, 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
@ -111,7 +111,7 @@ public class DictionaryBasedBreakIterator extends RuleBasedBreakIterator {
* @param ruleFile the name of the rule data file
* @param ruleData the rule data loaded from the rule data file
* @param dictionaryFile the name of the dictionary file
* @param dictionartData the dictionary data loaded from the dictionary file
* @param dictionaryData the dictionary data loaded from the dictionary file
* @throws MissingResourceException if rule data or dictionary initialization failed
*/
public DictionaryBasedBreakIterator(String ruleFile, byte[] ruleData,