From 4bf8cc2939106fd354514d8c70ec08944486872c Mon Sep 17 00:00:00 2001 From: juh Date: Wed, 3 Jul 2013 12:51:45 -0700 Subject: [PATCH] 8019772: Fix doclint issues in javax.crypto and javax.security subpackages Reviewed-by: darcy --- src/share/classes/javax/crypto/Cipher.java | 6 ++-- .../javax/crypto/CipherInputStream.java | 2 +- .../javax/crypto/ExemptionMechanism.java | 8 ++--- .../classes/javax/crypto/KeyAgreement.java | 12 +++---- .../classes/javax/crypto/KeyGenerator.java | 6 ++-- .../classes/javax/crypto/NullCipher.java | 5 ++- .../classes/javax/security/auth/Subject.java | 20 ++++++++++- .../javax/security/cert/X509Certificate.java | 35 +++++++++++-------- 8 files changed, 60 insertions(+), 34 deletions(-) diff --git a/src/share/classes/javax/crypto/Cipher.java b/src/share/classes/javax/crypto/Cipher.java index 70d8d3466..d16c57946 100644 --- a/src/share/classes/javax/crypto/Cipher.java +++ b/src/share/classes/javax/crypto/Cipher.java @@ -1135,7 +1135,7 @@ public class Cipher { * *

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 SecureRandom} + * 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 @@ public class Cipher { * *

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 SecureRandom} + * 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 @@ public class Cipher { * *

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 SecureRandom} + * 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 diff --git a/src/share/classes/javax/crypto/CipherInputStream.java b/src/share/classes/javax/crypto/CipherInputStream.java index f062a1bc2..a8b4152a5 100644 --- a/src/share/classes/javax/crypto/CipherInputStream.java +++ b/src/share/classes/javax/crypto/CipherInputStream.java @@ -245,7 +245,7 @@ public class CipherInputStream extends FilterInputStream { *

Fewer bytes than requested might be skipped. * The actual number of bytes skipped is equal to n or * the result of a call to - * {@link #available() available}, + * {@link #available() available}, * whichever is smaller. * If n is less than zero, no bytes are skipped. * diff --git a/src/share/classes/javax/crypto/ExemptionMechanism.java b/src/share/classes/javax/crypto/ExemptionMechanism.java index 6a7cc90d3..72b0e75cf 100644 --- a/src/share/classes/javax/crypto/ExemptionMechanism.java +++ b/src/share/classes/javax/crypto/ExemptionMechanism.java @@ -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 @@ public class ExemptionMechanism { * mechanism. * See the ExemptionMechanism section in the * + * "{@docRoot}/../technotes/guides/security/StandardNames.html#Exemption"> * Java Cryptography Architecture Standard Algorithm Name Documentation * for information about standard exemption mechanism names. * @@ -155,7 +155,7 @@ public class ExemptionMechanism { * @param algorithm the standard name of the requested exemption mechanism. * See the ExemptionMechanism section in the * + * "{@docRoot}/../technotes/guides/security/StandardNames.html#Exemption"> * Java Cryptography Architecture Standard Algorithm Name Documentation * for information about standard exemption mechanism names. * @@ -199,7 +199,7 @@ public class ExemptionMechanism { * @param algorithm the standard name of the requested exemption mechanism. * See the ExemptionMechanism section in the * + * "{@docRoot}/../technotes/guides/security/StandardNames.html#Exemption"> * Java Cryptography Architecture Standard Algorithm Name Documentation * for information about standard exemption mechanism names. * diff --git a/src/share/classes/javax/crypto/KeyAgreement.java b/src/share/classes/javax/crypto/KeyAgreement.java index cb85cb57d..70221aa0c 100644 --- a/src/share/classes/javax/crypto/KeyAgreement.java +++ b/src/share/classes/javax/crypto/KeyAgreement.java @@ -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 @@ public class KeyAgreement { * algorithm. * See the KeyAgreement section in the - * Java Cryptography Architecture Standard Algorithm Name Documentation + * Java Cryptography Architecture Standard Algorithm Name Documentation * for information about standard algorithm names. * * @return the new KeyAgreement object. @@ -196,7 +196,7 @@ public class KeyAgreement { * algorithm. * See the KeyAgreement section in the - * Java Cryptography Architecture Standard Algorithm Name Documentation + * Java Cryptography Architecture Standard Algorithm Name Documentation * for information about standard algorithm names. * * @param provider the name of the provider. @@ -240,7 +240,7 @@ public class KeyAgreement { * algorithm. * See the KeyAgreement section in the - * Java Cryptography Architecture Standard Algorithm Name Documentation + * Java Cryptography Architecture Standard Algorithm Name Documentation * for information about standard algorithm names. * * @param provider the provider. @@ -418,7 +418,7 @@ public class KeyAgreement { * *

If this key agreement requires any random bytes, it will get * them using the - * {@link SecureRandom SecureRandom} + * {@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 @@ public class KeyAgreement { * *

If this key agreement requires any random bytes, it will get * them using the - * {@link SecureRandom SecureRandom} + * {@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 diff --git a/src/share/classes/javax/crypto/KeyGenerator.java b/src/share/classes/javax/crypto/KeyGenerator.java index fee083929..961f0ea9e 100644 --- a/src/share/classes/javax/crypto/KeyGenerator.java +++ b/src/share/classes/javax/crypto/KeyGenerator.java @@ -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 @@ public class KeyGenerator { * *

If this key generator requires any random bytes, it will get them * using the - * {@link SecureRandom SecureRandom} + * {@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 @@ public class KeyGenerator { * *

If this key generator requires any random bytes, it will get them * using the - * {@link SecureRandom SecureRandom} + * {@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 diff --git a/src/share/classes/javax/crypto/NullCipher.java b/src/share/classes/javax/crypto/NullCipher.java index 39afb2ac4..5c8d2f547 100644 --- a/src/share/classes/javax/crypto/NullCipher.java +++ b/src/share/classes/javax/crypto/NullCipher.java @@ -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 @@ package javax.crypto; public class NullCipher extends Cipher { + /** + * Creates a NullCipher object. + */ public NullCipher() { super(new NullCipherSpi(), null); } diff --git a/src/share/classes/javax/security/auth/Subject.java b/src/share/classes/javax/security/auth/Subject.java index 1caaad400..c72734eda 100644 --- a/src/share/classes/javax/security/auth/Subject.java +++ b/src/share/classes/javax/security/auth/Subject.java @@ -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 @@ public final class Subject implements java.io.Serializable { * action will run as. This parameter * may be null.

* + * @param the type of the value returned by the PrivilegedAction's + * {@code run} method. + * * @param action the code to be run as the specified * Subject.

* @@ -378,6 +381,9 @@ public final class Subject implements java.io.Serializable { * action will run as. This parameter * may be null.

* + * @param the type of the value returned by the + * PrivilegedExceptionAction's {@code run} method. + * * @param action the code to be run as the specified * Subject.

* @@ -434,6 +440,9 @@ public final class Subject implements java.io.Serializable { * action will run as. This parameter * may be null.

* + * @param the type of the value returned by the PrivilegedAction's + * {@code run} method. + * * @param action the code to be run as the specified * Subject.

* @@ -492,6 +501,9 @@ public final class Subject implements java.io.Serializable { * action will run as. This parameter * may be null.

* + * @param the type of the value returned by the + * PrivilegedExceptionAction's {@code run} method. + * * @param action the code to be run as the specified * Subject.

* @@ -590,6 +602,8 @@ public final class Subject implements java.io.Serializable { * *

* + * @param the type of the class modeled by {@code c} + * * @param c the returned Set of Principals will all be * instances of this class. * @@ -684,6 +698,8 @@ public final class Subject implements java.io.Serializable { * *

* + * @param the type of the class modeled by {@code c} + * * @param c the returned Set of public credentials will all be * instances of this class. * @@ -721,6 +737,8 @@ public final class Subject implements java.io.Serializable { * *

* + * @param the type of the class modeled by {@code c} + * * @param c the returned Set of private credentials will all be * instances of this class. * diff --git a/src/share/classes/javax/security/cert/X509Certificate.java b/src/share/classes/javax/security/cert/X509Certificate.java index 1f5af7e2d..16fb01498 100644 --- a/src/share/classes/javax/security/cert/X509Certificate.java +++ b/src/share/classes/javax/security/cert/X509Certificate.java @@ -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 @@ public abstract class X509Certificate extends Certificate { * certificate is expected to be in the input stream. * Also, all X509Certificate * subclasses must provide a constructor of the form: - * 

-     * public <subClass>(InputStream inStream) ...
-     *
+ * 
{@code
+     * public (InputStream inStream) ...
+     * }
* * @param inStream an input stream with the data to be read to * initialize the certificate. @@ -184,9 +184,9 @@ public abstract class X509Certificate extends Certificate { * *

Note: All X509Certificate * subclasses must provide a constructor of the form: - * 

-     * public <subClass>(InputStream inStream) ...
-     *
+ * 
{@code
+     * public (InputStream inStream) ...
+     * }
* * @param certData a byte array containing the DER-encoded * certificate. @@ -255,10 +255,12 @@ public abstract class X509Certificate extends Certificate { * is valid. It is defined in * ASN.1 as: * 
-     * validity             Validity

+     * validity             Validity
+     *
      * Validity ::= SEQUENCE {
      *     notBefore      CertificateValidityDate,
-     *     notAfter       CertificateValidityDate }

+     *     notAfter       CertificateValidityDate }
+     *
      * CertificateValidityDate ::= CHOICE {
      *     utcTime        UTCTime,
      *     generalTime    GeneralizedTime }
@@ -291,7 +293,8 @@ public abstract class X509Certificate extends Certificate {
      * Gets the version (version number) value from the
      * certificate. The ASN.1 definition for this is:
      * 
-     * version         [0]  EXPLICIT Version DEFAULT v1

+     * version         [0]  EXPLICIT Version DEFAULT v1
+     *
      * Version  ::=  INTEGER  {  v1(0), v2(1), v3(2)  }
      * 

      *
@@ -307,7 +310,7 @@ public abstract class X509Certificate extends Certificate {
      * serial number identify a unique certificate).
      * The ASN.1 definition for this is:
      * 
-     * serialNumber     CertificateSerialNumber

+     * serialNumber     CertificateSerialNumber
      *
      * CertificateSerialNumber  ::=  INTEGER
      * 

@@ -325,7 +328,7 @@ public abstract class X509Certificate extends Certificate {
      * X.500 distinguished name (DN).
      * The ASN.1 definition for this is:
      * 
-     * issuer    Name

+     * issuer    Name
      *
      * Name ::= CHOICE { RDNSequence }
      * RDNSequence ::= SEQUENCE OF RelativeDistinguishedName
@@ -371,11 +374,12 @@ public abstract class X509Certificate extends Certificate {
      * the certificate.
      * The relevant ASN.1 definitions are:
      * 
-     * validity             Validity

+     * validity             Validity
      *
      * Validity ::= SEQUENCE {
      *     notBefore      CertificateValidityDate,
-     *     notAfter       CertificateValidityDate }

+     *     notAfter       CertificateValidityDate }
+     *
      * CertificateValidityDate ::= CHOICE {
      *     utcTime        UTCTime,
      *     generalTime    GeneralizedTime }
@@ -401,7 +405,8 @@ public abstract class X509Certificate extends Certificate {
      * signature algorithm. An example is the string "SHA-1/DSA".
      * The ASN.1 definition for this is:
      * 
-     * signatureAlgorithm   AlgorithmIdentifier

+     * signatureAlgorithm   AlgorithmIdentifier
+     *
      * AlgorithmIdentifier  ::=  SEQUENCE  {
      *     algorithm               OBJECT IDENTIFIER,
      *     parameters              ANY DEFINED BY algorithm OPTIONAL  }
-- 
GitLab