RFR: JDK-8284851 Update javax.crypto files to use proper javadoc for mentioned classes [v2]

[Valerie Peng]

On Tue, 28 Jun 2022 19:32:07 GMT, Mark Powers <duke at openjdk.org> wrote:

>> https://bugs.openjdk.org/browse/JDK-8284851
>
> Mark Powers has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Valerie fix

src/java.base/share/classes/javax/crypto/KeyGenerator.java line 297:

> 295:      *
> 296:      * <p> A new {@code KeyGenerator} object encapsulating the
> 297:      * {@code KeyGeneratorSpi} implementation from the specified Provider

Change "Provider" to start with lowercase or add `{@code }`

src/java.base/share/classes/javax/crypto/KeyGenerator.java line 298:

> 296:      * <p> A new {@code KeyGenerator} object encapsulating the
> 297:      * {@code KeyGeneratorSpi} implementation from the specified Provider
> 298:      * object is returned.  Note that the specified Provider object

Same for this one as well.

src/java.base/share/classes/javax/crypto/Mac.java line 146:

> 144:      *
> 145:      * <p> This method traverses the list of registered security Providers,
> 146:      * starting with the most preferred Provider.

Change "Providers"/"Provider" to start with lowercase.

src/java.base/share/classes/javax/crypto/Mac.java line 149:

> 147:      * A new {@code Mac} object encapsulating the
> 148:      * {@code MacSpi} implementation from the first
> 149:      * Provider that supports the specified algorithm is returned.

Provider -> provider

src/java.base/share/classes/javax/crypto/Mac.java line 243:

> 241:      *
> 242:      * <p> A new {@code Mac} object encapsulating the
> 243:      * {@code MacSpi} implementation from the specified Provider

Provider -> provider

src/java.base/share/classes/javax/crypto/NoSuchPaddingException.java line 45:

> 43: 
> 44:     /**
> 45:      * Constructs a <code>NoSuchPaddingException</code> with no detail

Use `{@code }` for all of the javadoc in this class?

src/java.base/share/classes/javax/crypto/NoSuchPaddingException.java line 46:

> 44:     /**
> 45:      * Constructs a <code>NoSuchPaddingException</code> with no detail
> 46:      * message. A detail message is a String that describes this

Add `{@code }` to String

src/java.base/share/classes/javax/crypto/NullCipher.java line 29:

> 27: 
> 28: /**
> 29:  * The <code>NullCipher</code> class is a class that provides an

Use `{@code }` for all of the javadoc in this class?

src/java.base/share/classes/javax/crypto/ProviderVerifier.java line 54:

> 52: 
> 53:     /**
> 54:      * Creates a <code>ProviderVerifier</code> object to verify the given URL.

Use `{@code }` for all of the javadoc in this class?

src/java.base/share/classes/javax/crypto/ProviderVerifier.java line 170:

> 168:      * NOTE: if this <code>ProviderVerifier</code> instance is constructed
> 169:      * with "savePerms" equal to false, then this method would always
> 170:      * return null.

Add `{@code }` to "false" and "null"

src/java.base/share/classes/javax/crypto/SealedObject.java line 43:

> 41:  * confidentiality with a cryptographic algorithm.
> 42:  *
> 43:  * <p> Given any Serializable object, one can create a <code>SealedObject</code>

Use `{@code }` for all of the javadoc in this class?

src/java.base/share/classes/javax/crypto/SealedObject.java line 195:

> 193:     /**
> 194:      * Constructs a <code>SealedObject</code> object from the passed-in
> 195:      * SealedObject.

Add `{@code }` to SealedObject?

src/java.base/share/classes/javax/crypto/SealedObject.java line 198:

> 196:      *
> 197:      * @param so a <code>SealedObject</code> object
> 198:      * @exception NullPointerException if the given sealed object is null.

Add `{@code }` to null?

-------------

PR: https://git.openjdk.org/jdk/pull/9282