8019772: Fix doclint issues in javax.crypto and javax.security subpackages
Reviewed-by: darcy
--- a/jdk/src/share/classes/javax/crypto/Cipher.java Wed Jul 03 21:19:25 2013 +0200
+++ b/jdk/src/share/classes/javax/crypto/Cipher.java Wed Jul 03 12:51:45 2013 -0700
@@ -1135,7 +1135,7 @@
*
* <p>If this cipher (including its underlying feedback or padding scheme)
* requires any random bytes (e.g., for parameter generation), it will get
- * them using the {@link SecureRandom <code>SecureRandom</code>}
+ * them using the {@link java.security.SecureRandom}
* implementation of the highest-priority
* installed provider as the source of randomness.
* (If none of the installed providers supply an implementation of
@@ -1263,7 +1263,7 @@
*
* <p>If this cipher (including its underlying feedback or padding scheme)
* requires any random bytes (e.g., for parameter generation), it will get
- * them using the {@link SecureRandom <code>SecureRandom</code>}
+ * them using the {@link java.security.SecureRandom}
* implementation of the highest-priority
* installed provider as the source of randomness.
* (If none of the installed providers supply an implementation of
@@ -1400,7 +1400,7 @@
*
* <p>If this cipher (including its underlying feedback or padding scheme)
* requires any random bytes (e.g., for parameter generation), it will get
- * them using the {@link SecureRandom <code>SecureRandom</code>}
+ * them using the {@link java.security.SecureRandom}
* implementation of the highest-priority
* installed provider as the source of randomness.
* (If none of the installed providers supply an implementation of
--- a/jdk/src/share/classes/javax/crypto/CipherInputStream.java Wed Jul 03 21:19:25 2013 +0200
+++ b/jdk/src/share/classes/javax/crypto/CipherInputStream.java Wed Jul 03 12:51:45 2013 -0700
@@ -245,7 +245,7 @@
* <p>Fewer bytes than requested might be skipped.
* The actual number of bytes skipped is equal to <code>n</code> or
* the result of a call to
- * {@link #available() <code>available</code>},
+ * {@link #available() available},
* whichever is smaller.
* If <code>n</code> is less than zero, no bytes are skipped.
*
--- a/jdk/src/share/classes/javax/crypto/ExemptionMechanism.java Wed Jul 03 21:19:25 2013 +0200
+++ b/jdk/src/share/classes/javax/crypto/ExemptionMechanism.java Wed Jul 03 12:51:45 2013 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1999, 2011, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2013, 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
@@ -116,7 +116,7 @@
* mechanism.
* See the ExemptionMechanism section in the
* <a href=
- * "{docRoot}/../technotes/guides/security/StandardNames.html#Exemption">
+ * "{@docRoot}/../technotes/guides/security/StandardNames.html#Exemption">
* Java Cryptography Architecture Standard Algorithm Name Documentation</a>
* for information about standard exemption mechanism names.
*
@@ -155,7 +155,7 @@
* @param algorithm the standard name of the requested exemption mechanism.
* See the ExemptionMechanism section in the
* <a href=
- * "{docRoot}/../technotes/guides/security/StandardNames.html#Exemption">
+ * "{@docRoot}/../technotes/guides/security/StandardNames.html#Exemption">
* Java Cryptography Architecture Standard Algorithm Name Documentation</a>
* for information about standard exemption mechanism names.
*
@@ -199,7 +199,7 @@
* @param algorithm the standard name of the requested exemption mechanism.
* See the ExemptionMechanism section in the
* <a href=
- * "{docRoot}/../technotes/guides/security/StandardNames.html#Exemption">
+ * "{@docRoot}/../technotes/guides/security/StandardNames.html#Exemption">
* Java Cryptography Architecture Standard Algorithm Name Documentation</a>
* for information about standard exemption mechanism names.
*
--- a/jdk/src/share/classes/javax/crypto/KeyAgreement.java Wed Jul 03 21:19:25 2013 +0200
+++ b/jdk/src/share/classes/javax/crypto/KeyAgreement.java Wed Jul 03 12:51:45 2013 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, 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
@@ -149,7 +149,7 @@
* algorithm.
* See the KeyAgreement section in the <a href=
* "{@docRoot}/../technotes/guides/security/StandardNames.html#KeyAgreement">
- * Java Cryptography Architecture Standard Algorithm Name Documentation
+ * Java Cryptography Architecture Standard Algorithm Name Documentation</a>
* for information about standard algorithm names.
*
* @return the new <code>KeyAgreement</code> object.
@@ -196,7 +196,7 @@
* algorithm.
* See the KeyAgreement section in the <a href=
* "{@docRoot}/../technotes/guides/security/StandardNames.html#KeyAgreement">
- * Java Cryptography Architecture Standard Algorithm Name Documentation
+ * Java Cryptography Architecture Standard Algorithm Name Documentation</a>
* for information about standard algorithm names.
*
* @param provider the name of the provider.
@@ -240,7 +240,7 @@
* algorithm.
* See the KeyAgreement section in the <a href=
* "{@docRoot}/../technotes/guides/security/StandardNames.html#KeyAgreement">
- * Java Cryptography Architecture Standard Algorithm Name Documentation
+ * Java Cryptography Architecture Standard Algorithm Name Documentation</a>
* for information about standard algorithm names.
*
* @param provider the provider.
@@ -418,7 +418,7 @@
*
* <p> If this key agreement requires any random bytes, it will get
* them using the
- * {@link SecureRandom <code>SecureRandom</code>}
+ * {@link java.security.SecureRandom}
* implementation of the highest-priority
* installed provider as the source of randomness.
* (If none of the installed providers supply an implementation of
@@ -476,7 +476,7 @@
*
* <p> If this key agreement requires any random bytes, it will get
* them using the
- * {@link SecureRandom <code>SecureRandom</code>}
+ * {@link java.security.SecureRandom}
* implementation of the highest-priority
* installed provider as the source of randomness.
* (If none of the installed providers supply an implementation of
--- a/jdk/src/share/classes/javax/crypto/KeyGenerator.java Wed Jul 03 21:19:25 2013 +0200
+++ b/jdk/src/share/classes/javax/crypto/KeyGenerator.java Wed Jul 03 12:51:45 2013 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, 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
@@ -398,7 +398,7 @@
*
* <p> If this key generator requires any random bytes, it will get them
* using the
- * {@link SecureRandom <code>SecureRandom</code>}
+ * {@link java.security.SecureRandom}
* implementation of the highest-priority installed
* provider as the source of randomness.
* (If none of the installed providers supply an implementation of
@@ -463,7 +463,7 @@
*
* <p> If this key generator requires any random bytes, it will get them
* using the
- * {@link SecureRandom <code>SecureRandom</code>}
+ * {@link java.security.SecureRandom}
* implementation of the highest-priority installed
* provider as the source of randomness.
* (If none of the installed providers supply an implementation of
--- a/jdk/src/share/classes/javax/crypto/NullCipher.java Wed Jul 03 21:19:25 2013 +0200
+++ b/jdk/src/share/classes/javax/crypto/NullCipher.java Wed Jul 03 12:51:45 2013 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2007, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, 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
@@ -38,6 +38,9 @@
public class NullCipher extends Cipher {
+ /**
+ * Creates a NullCipher object.
+ */
public NullCipher() {
super(new NullCipherSpi(), null);
}
--- a/jdk/src/share/classes/javax/security/auth/Subject.java Wed Jul 03 21:19:25 2013 +0200
+++ b/jdk/src/share/classes/javax/security/auth/Subject.java Wed Jul 03 12:51:45 2013 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2013, 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
@@ -325,6 +325,9 @@
* <code>action</code> will run as. This parameter
* may be <code>null</code>. <p>
*
+ * @param <T> the type of the value returned by the PrivilegedAction's
+ * {@code run} method.
+ *
* @param action the code to be run as the specified
* <code>Subject</code>. <p>
*
@@ -378,6 +381,9 @@
* <code>action</code> will run as. This parameter
* may be <code>null</code>. <p>
*
+ * @param <T> the type of the value returned by the
+ * PrivilegedExceptionAction's {@code run} method.
+ *
* @param action the code to be run as the specified
* <code>Subject</code>. <p>
*
@@ -434,6 +440,9 @@
* <code>action</code> will run as. This parameter
* may be <code>null</code>. <p>
*
+ * @param <T> the type of the value returned by the PrivilegedAction's
+ * {@code run} method.
+ *
* @param action the code to be run as the specified
* <code>Subject</code>. <p>
*
@@ -492,6 +501,9 @@
* <code>action</code> will run as. This parameter
* may be <code>null</code>. <p>
*
+ * @param <T> the type of the value returned by the
+ * PrivilegedExceptionAction's {@code run} method.
+ *
* @param action the code to be run as the specified
* <code>Subject</code>. <p>
*
@@ -590,6 +602,8 @@
*
* <p>
*
+ * @param <T> the type of the class modeled by {@code c}
+ *
* @param c the returned <code>Set</code> of Principals will all be
* instances of this class.
*
@@ -684,6 +698,8 @@
*
* <p>
*
+ * @param <T> the type of the class modeled by {@code c}
+ *
* @param c the returned <code>Set</code> of public credentials will all be
* instances of this class.
*
@@ -721,6 +737,8 @@
*
* <p>
*
+ * @param <T> the type of the class modeled by {@code c}
+ *
* @param c the returned <code>Set</code> of private credentials will all be
* instances of this class.
*
--- a/jdk/src/share/classes/javax/security/cert/X509Certificate.java Wed Jul 03 21:19:25 2013 +0200
+++ b/jdk/src/share/classes/javax/security/cert/X509Certificate.java Wed Jul 03 12:51:45 2013 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, 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
@@ -159,9 +159,9 @@
* certificate is expected to be in the input stream.
* Also, all X509Certificate
* subclasses must provide a constructor of the form:
- * <code><pre>
- * public <subClass>(InputStream inStream) ...
- * </pre></code>
+ * <pre>{@code
+ * public <subClass>(InputStream inStream) ...
+ * }</pre>
*
* @param inStream an input stream with the data to be read to
* initialize the certificate.
@@ -184,9 +184,9 @@
*
* <p>Note: All X509Certificate
* subclasses must provide a constructor of the form:
- * <code><pre>
- * public <subClass>(InputStream inStream) ...
- * </pre></code>
+ * <pre>{@code
+ * public <subClass>(InputStream inStream) ...
+ * }</pre>
*
* @param certData a byte array containing the DER-encoded
* certificate.
@@ -255,10 +255,12 @@
* is valid. It is defined in
* ASN.1 as:
* <pre>
- * validity Validity<p>
+ * validity Validity
+ *
* Validity ::= SEQUENCE {
* notBefore CertificateValidityDate,
- * notAfter CertificateValidityDate }<p>
+ * notAfter CertificateValidityDate }
+ *
* CertificateValidityDate ::= CHOICE {
* utcTime UTCTime,
* generalTime GeneralizedTime }
@@ -291,7 +293,8 @@
* Gets the <code>version</code> (version number) value from the
* certificate. The ASN.1 definition for this is:
* <pre>
- * version [0] EXPLICIT Version DEFAULT v1<p>
+ * version [0] EXPLICIT Version DEFAULT v1
+ *
* Version ::= INTEGER { v1(0), v2(1), v3(2) }
* </pre>
*
@@ -307,7 +310,7 @@
* serial number identify a unique certificate).
* The ASN.1 definition for this is:
* <pre>
- * serialNumber CertificateSerialNumber<p>
+ * serialNumber CertificateSerialNumber
*
* CertificateSerialNumber ::= INTEGER
* </pre>
@@ -325,7 +328,7 @@
* X.500 distinguished name (DN).
* The ASN.1 definition for this is:
* <pre>
- * issuer Name<p>
+ * issuer Name
*
* Name ::= CHOICE { RDNSequence }
* RDNSequence ::= SEQUENCE OF RelativeDistinguishedName
@@ -371,11 +374,12 @@
* the certificate.
* The relevant ASN.1 definitions are:
* <pre>
- * validity Validity<p>
+ * validity Validity
*
* Validity ::= SEQUENCE {
* notBefore CertificateValidityDate,
- * notAfter CertificateValidityDate }<p>
+ * notAfter CertificateValidityDate }
+ *
* CertificateValidityDate ::= CHOICE {
* utcTime UTCTime,
* generalTime GeneralizedTime }
@@ -401,7 +405,8 @@
* signature algorithm. An example is the string "SHA-1/DSA".
* The ASN.1 definition for this is:
* <pre>
- * signatureAlgorithm AlgorithmIdentifier<p>
+ * signatureAlgorithm AlgorithmIdentifier
+ *
* AlgorithmIdentifier ::= SEQUENCE {
* algorithm OBJECT IDENTIFIER,
* parameters ANY DEFINED BY algorithm OPTIONAL }