From 4d33e16da12ca8d86a654aecd58ad820e0e43fe4 Mon Sep 17 00:00:00 2001 From: Joe Darcy Date: Tue, 3 Dec 2013 11:52:18 -0800 Subject: [PATCH] 8029475: Fix more doclint issues in javax.security Reviewed-by: juh --- jdk/src/share/classes/javax/crypto/Cipher.java | 6 +++--- .../share/classes/javax/crypto/CipherSpi.java | 16 ++++++++-------- .../share/classes/javax/crypto/KeyGenerator.java | 1 - .../share/classes/javax/crypto/SealedObject.java | 6 ++---- .../share/classes/javax/net/ssl/SSLEngine.java | 6 +++--- .../classes/javax/net/ssl/SSLPermission.java | 3 +-- .../auth/PrivateCredentialPermission.java | 4 ++-- .../auth/kerberos/DelegationPermission.java | 4 ++-- .../auth/kerberos/ServicePermission.java | 6 +++--- .../javax/security/auth/login/LoginContext.java | 12 ++++++------ .../javax/security/auth/x500/X500Principal.java | 2 +- 11 files changed, 31 insertions(+), 35 deletions(-) diff --git a/jdk/src/share/classes/javax/crypto/Cipher.java b/jdk/src/share/classes/javax/crypto/Cipher.java index d16c579469c..ffcc7cf329c 100644 --- a/jdk/src/share/classes/javax/crypto/Cipher.java +++ b/jdk/src/share/classes/javax/crypto/Cipher.java @@ -62,17 +62,17 @@ import sun.security.jca.*; * algorithm (e.g., DES), and may be followed by a feedback mode and * padding scheme. * - *

A transformation is of the form:

+ *

A transformation is of the form: * *

* *

(in the latter case, * provider-specific default values for the mode and padding scheme are used). - * For example, the following is a valid transformation:

+ * For example, the following is a valid transformation: * * 

  *     Cipher c = Cipher.getInstance("DES/CBC/PKCS5Padding");
diff --git a/jdk/src/share/classes/javax/crypto/CipherSpi.java b/jdk/src/share/classes/javax/crypto/CipherSpi.java
index aae33318d1c..ce7258157d5 100644
--- a/jdk/src/share/classes/javax/crypto/CipherSpi.java
+++ b/jdk/src/share/classes/javax/crypto/CipherSpi.java
@@ -62,17 +62,17 @@ import java.nio.ByteBuffer;
  * algorithm (e.g., DES), and may be followed by a feedback mode and
  * padding scheme.
  *
- * 
 A transformation is of the form:

+ * 
 A transformation is of the form:
  *
  * 

  *
  * 
 (in the latter case,
  * provider-specific default values for the mode and padding scheme are used).
- * For example, the following is a valid transformation:

+ * For example, the following is a valid transformation:
  *
  * 
  *     Cipher c = Cipher.getInstance("DES/CBC/PKCS5Padding");
@@ -129,7 +129,7 @@ import java.nio.ByteBuffer;
  * DES/CBC/PKCS5Padding, one that implements
  * DES/CFB/PKCS5Padding, and yet another one that implements
  * DES/OFB/PKCS5Padding. That provider would have the following
- * Cipher properties in its master class:

+ * Cipher properties in its master class:
  *
  * 
    
  *
@@ -160,7 +160,7 @@ import java.nio.ByteBuffer;
  * and one for OFB), one class for PKCS5Padding,
  * and a generic DES class that subclasses from CipherSpi.
  * That provider would have the following
- * Cipher properties in its master class:
    
+ * Cipher properties in its master class:
  *
  * 
      
  *
@@ -197,20 +197,20 @@ import java.nio.ByteBuffer;
  * Check if the provider has registered a subclass of CipherSpi
  * for the specified "algorithm/mode/padding" transformation.
  * 
      If the answer is YES, instantiate it.
- * 
      If the answer is NO, go to the next step.
      
+ * 
      If the answer is NO, go to the next step.
  * 
    • 
  * Check if the provider has registered a subclass of CipherSpi
  * for the sub-transformation "algorithm/mode".
  * 
      If the answer is YES, instantiate it, and call
  * engineSetPadding(padding) on the new instance.
- * 
      If the answer is NO, go to the next step.
      
+ * 
      If the answer is NO, go to the next step.
  * 
    • 
  * Check if the provider has registered a subclass of CipherSpi
  * for the sub-transformation "algorithm//padding" (note the double
  * slashes).
  * 
      If the answer is YES, instantiate it, and call
  * engineSetMode(mode) on the new instance.
- * 
      If the answer is NO, go to the next step.
      
+ * 
      If the answer is NO, go to the next step.
  * 
    • 
  * Check if the provider has registered a subclass of CipherSpi
  * for the sub-transformation "algorithm".
diff --git a/jdk/src/share/classes/javax/crypto/KeyGenerator.java b/jdk/src/share/classes/javax/crypto/KeyGenerator.java
index 961f0ea9eb3..030207eab51 100644
--- a/jdk/src/share/classes/javax/crypto/KeyGenerator.java
+++ b/jdk/src/share/classes/javax/crypto/KeyGenerator.java
@@ -66,7 +66,6 @@ import sun.security.jca.GetInstance.Instance;
  * algorithm-independent init methods, it is up to the
  * provider what to do about the algorithm-specific parameters (if any) to be
  * associated with each of the keys.
- * 
      
  *
  * 
    • Algorithm-Specific Initialization
  * 
      For situations where a set of algorithm-specific parameters already
diff --git a/jdk/src/share/classes/javax/crypto/SealedObject.java b/jdk/src/share/classes/javax/crypto/SealedObject.java
index 9166c28d10c..9cee4d070f1 100644
--- a/jdk/src/share/classes/javax/crypto/SealedObject.java
+++ b/jdk/src/share/classes/javax/crypto/SealedObject.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
@@ -50,7 +50,7 @@ import java.security.NoSuchProviderException;
  * to a SealedObject.
  *
  * 
       The original object that was sealed can be recovered in two different
- * ways: 
      
+ * ways:
  *
  * 
        
  *
@@ -68,8 +68,6 @@ import java.security.NoSuchProviderException;
  * decryption key, it could hand over the cipher object to
  * another party who then unseals the sealed object.
  *
- * 
        
- *
  * 
      • by using one of the
  * {@link #getObject(java.security.Key) getObject} methods
  * that take a Key object.
diff --git a/jdk/src/share/classes/javax/net/ssl/SSLEngine.java b/jdk/src/share/classes/javax/net/ssl/SSLEngine.java
index 92e838623f4..64110880258 100644
--- a/jdk/src/share/classes/javax/net/ssl/SSLEngine.java
+++ b/jdk/src/share/classes/javax/net/ssl/SSLEngine.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2003, 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
@@ -329,7 +329,7 @@ import java.nio.ReadOnlyBufferException;
  * is saved.  All future delegated tasks will be processed using this
  * context:  that is, all access control decisions will be made using the
  * context captured at engine creation.
- * 
        
+ *
  * 
        
  *
  * Concurrency Notes:
@@ -345,7 +345,7 @@ import java.nio.ReadOnlyBufferException;
  *      out-of-order, unexpected or fatal results may occur.
  * 
        
  *      For example:
- * 
        
+ *
  *      
          *              synchronized (outboundLock) {
  *                  sslEngine.wrap(src, dst);
diff --git a/jdk/src/share/classes/javax/net/ssl/SSLPermission.java b/jdk/src/share/classes/javax/net/ssl/SSLPermission.java
index bac011d6579..b27142128ae 100644
--- a/jdk/src/share/classes/javax/net/ssl/SSLPermission.java
+++ b/jdk/src/share/classes/javax/net/ssl/SSLPermission.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2000, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2000, 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
@@ -43,7 +43,6 @@ import java.security.*;
  * The following table lists all the possible SSLPermission target names,
  * and for each provides a description of what the permission allows
  * and a discussion of the risks of granting code the permission.
- * 
        
  *
  * 
diff --git a/jdk/src/share/classes/javax/security/auth/PrivateCredentialPermission.java b/jdk/src/share/classes/javax/security/auth/PrivateCredentialPermission.java
index 810cff2228a..37a2660cb03 100644
--- a/jdk/src/share/classes/javax/security/auth/PrivateCredentialPermission.java
+++ b/jdk/src/share/classes/javax/security/auth/PrivateCredentialPermission.java
@@ -228,8 +228,8 @@ public final class PrivateCredentialPermission extends Permission {
      * 
        
      *
      * This method returns true if:
-     * 
          
-     * 
        •  p is an instanceof PrivateCredentialPermission and 
          
+     * 
            
+     * 
          •  p is an instanceof PrivateCredentialPermission and
      * 
          •  the target name for p is implied by this object's
      *          target name.  For example:
      * 
            diff --git a/jdk/src/share/classes/javax/security/auth/kerberos/DelegationPermission.java b/jdk/src/share/classes/javax/security/auth/kerberos/DelegationPermission.java
index 77aabb8b9d6..bdd3ff9c4a9 100644
--- a/jdk/src/share/classes/javax/security/auth/kerberos/DelegationPermission.java
+++ b/jdk/src/share/classes/javax/security/auth/kerberos/DelegationPermission.java
@@ -48,14 +48,14 @@ import java.io.IOException;
  * 
            
  * For example, to specify the "host" service use of a forwardable TGT the
  * target permission is specified as follows:
- * 
            
+ *
  * 
              *  DelegationPermission("\"host/foo.example.com@EXAMPLE.COM\" \"krbtgt/EXAMPLE.COM@EXAMPLE.COM\"");
  * 
            
  * 
            
  * To give the "backup" service a proxiable nfs service ticket the target permission
  * might be specified:
- * 
            
+ *
  * 
              *  DelegationPermission("\"backup/bar.example.com@EXAMPLE.COM\" \"nfs/home.EXAMPLE.COM@EXAMPLE.COM\"");
  * 
            
diff --git a/jdk/src/share/classes/javax/security/auth/kerberos/ServicePermission.java b/jdk/src/share/classes/javax/security/auth/kerberos/ServicePermission.java
index 50a0517fa44..893284e548c 100644
--- a/jdk/src/share/classes/javax/security/auth/kerberos/ServicePermission.java
+++ b/jdk/src/share/classes/javax/security/auth/kerberos/ServicePermission.java
@@ -62,7 +62,7 @@ import java.io.IOException;
  * Authentication Service exchange.
  * 
            
  * The possible actions are:
- * 
            
+ *
  * 
              *    initiate -              allow the caller to use the credential to
  *                            initiate a security context with a service
@@ -75,7 +75,7 @@ import java.io.IOException;
  *
  * For example, to specify the permission to access to the TGT to
  * initiate a security context the permission is constructed as follows:
- * 
            
+ *
  * 
              *     ServicePermission("krbtgt/EXAMPLE.COM@EXAMPLE.COM", "initiate");
  * 
            
@@ -89,7 +89,7 @@ import java.io.IOException;
  * For a Kerberized server the action is "accept". For example, the permission
  * necessary to access and use the secret key of the  Kerberized "host"
  * service (telnet and the likes)  would be constructed as follows:
- * 
            
+ *
  * 
              *     ServicePermission("host/foo.example.com@EXAMPLE.COM", "accept");
  * 
            
diff --git a/jdk/src/share/classes/javax/security/auth/login/LoginContext.java b/jdk/src/share/classes/javax/security/auth/login/LoginContext.java
index a9685bca811..ba18e5ce6a0 100644
--- a/jdk/src/share/classes/javax/security/auth/login/LoginContext.java
+++ b/jdk/src/share/classes/javax/security/auth/login/LoginContext.java
@@ -101,11 +101,11 @@ import sun.security.util.ResourcesMgr;
  * 
          •  If the constructor has a Subject
  * input parameter, the LoginContext uses the caller-specified
  * Subject object.
- * 
            
+ *
  * 
          •  If the caller specifies a {@code null} Subject
  * and a {@code null} value is permitted,
  * the LoginContext instantiates a new Subject.
- * 
            
+ *
  * 
          •  If the constructor does not have a Subject
  * input parameter, the LoginContext instantiates a new Subject.
  * 
            
@@ -132,7 +132,7 @@ import sun.security.util.ResourcesMgr;
  * {@code getAppConfigurationEntry} with the name, "other"
  * (the default entry name).  If there is no entry for "other",
  * then a {@code LoginException} is thrown.
- * 
            
+ *
  * 
          •  When LoginContext uses the installed Configuration, the caller
  * requires the createLoginContext.name and possibly
  * createLoginContext.other AuthPermissions. Furthermore, the
@@ -141,7 +141,7 @@ import sun.security.util.ResourcesMgr;
  * perform security-sensitive tasks (such as connecting to remote hosts,
  * and updating the Subject) will require the respective permissions, but
  * the callers of the LoginContext will not require those permissions.
- * 
            
+ *
  * 
          •  When LoginContext uses a caller-specified Configuration, the caller
  * does not require any createLoginContext AuthPermission.  The LoginContext
  * saves the {@code AccessControlContext} for the caller,
@@ -158,7 +158,7 @@ import sun.security.util.ResourcesMgr;
  * 
          •  If the constructor has a CallbackHandler
  * input parameter, the LoginContext uses the caller-specified
  * CallbackHandler object.
- * 
            
+ *
  * 
          •  If the constructor does not have a CallbackHandler
  * input parameter, or if the caller specifies a {@code null}
  * CallbackHandler object (and a {@code null} value is permitted),
@@ -171,7 +171,7 @@ import sun.security.util.ResourcesMgr;
  * with users.  The caller thus assumes that the configured
  * modules have alternative means for authenticating the user.
  *
- * 
            
+ *
  * 
          •  When the LoginContext uses the installed Configuration (instead of
  * a caller-specified Configuration, see above),
  * then this LoginContext must wrap any
diff --git a/jdk/src/share/classes/javax/security/auth/x500/X500Principal.java b/jdk/src/share/classes/javax/security/auth/x500/X500Principal.java
index 5c0a5621261..77292b0be22 100644
--- a/jdk/src/share/classes/javax/security/auth/x500/X500Principal.java
+++ b/jdk/src/share/classes/javax/security/auth/x500/X500Principal.java
@@ -314,7 +314,7 @@ public final class X500Principal implements Principal, java.io.Serializable {
      * this method returns an RFC 2253 conformant string representation
      * with the following additional canonicalizations:
      *
-     * 
              
+     * 
                
      * 
              1.  Leading zeros are removed from attribute types
      *          that are encoded as dotted decimal OIDs
      * 
              2.  DirectoryString attribute values of type