JDK 9 RFR of JDK-8077915: Fix doclint issues in javax.smartcardio

joe darcy joe.darcy at oracle.com
Thu Apr 16 00:36:32 UTC 2015


Hello,

The javax.smartcardio subcomponet in JBS is under the security-libs 
component so I suppose this is the best place to send a code review request.

In any case, some missing doclint in javax.smartcardio is preventing 
doclint checking for that package being enabled in the build; please 
review the addition of the missing javadoc:

     JDK-8077915: Fix doclint issues in javax.smartcardio
     http://cr.openjdk.java.net/~darcy/8077915.0/

Patch below.

Thanks,

-Joe

--- old/src/java.smartcardio/share/classes/javax/smartcardio/Card.java 
2015-04-15 17:33:02.248101501 -0700
+++ new/src/java.smartcardio/share/classes/javax/smartcardio/Card.java 
2015-04-15 17:33:02.072101497 -0700
@@ -69,6 +69,7 @@
       * Returns the CardChannel for the basic logical channel. The basic
       * logical channel has a channel number of 0.
       *
+     * @return the CardChannel for the basic logical channel
       * @throws SecurityException if a SecurityManager exists and the
       *   caller does not have the required
       *   {@linkplain CardPermission permission}
@@ -82,6 +83,7 @@
       * opened by issuing a <code>MANAGE CHANNEL</code> command that 
should use
       * the format <code>[00 70 00 00 01]</code>.
       *
+     * @return the card to which a logical channel has been opened
       * @throws SecurityException if a SecurityManager exists and the
       *   caller does not have the required
       *   {@linkplain CardPermission permission}
@@ -137,6 +139,7 @@
       *
       * @param controlCode the control code of the command
       * @param command the command data
+     * @return the response from the terminal device
       *
       * @throws SecurityException if a SecurityManager exists and the
       *   caller does not have the required
--- 
old/src/java.smartcardio/share/classes/javax/smartcardio/CardTerminal.java 
2015-04-15 17:33:02.684101511 -0700
+++ 
new/src/java.smartcardio/share/classes/javax/smartcardio/CardTerminal.java 
2015-04-15 17:33:02.508101507 -0700
@@ -83,6 +83,7 @@
       * @throws SecurityException if a SecurityManager exists and the
       *   caller does not have the required
       *   {@linkplain CardPermission permission}
+     * @return the card the connection has been established with
       */
      public abstract Card connect(String protocol) throws CardException;

--- 
old/src/java.smartcardio/share/classes/javax/smartcardio/CardTerminals.java 
2015-04-15 17:33:03.124101521 -0700
+++ 
new/src/java.smartcardio/share/classes/javax/smartcardio/CardTerminals.java 
2015-04-15 17:33:02.956101517 -0700
@@ -105,6 +105,7 @@
       * Returns the terminal with the specified name or null if no such
       * terminal exists.
       *
+     * @param name the terminal name
       * @return the terminal with the specified name or null if no such
       * terminal exists.
       *



More information about the security-dev mailing list