changeset 8036:517c5e99fb2f

8024508: Fix doclint issues in com.sun.nio.sctp Reviewed-by: alanb
author chegar
date Wed, 11 Sep 2013 11:03:51 +0100
parents b271ea30f440
children d389dedd1ccb
files src/share/classes/com/sun/nio/sctp/Association.java src/share/classes/com/sun/nio/sctp/IllegalReceiveException.java src/share/classes/com/sun/nio/sctp/IllegalUnbindException.java src/share/classes/com/sun/nio/sctp/InvalidStreamException.java src/share/classes/com/sun/nio/sctp/MessageInfo.java src/share/classes/com/sun/nio/sctp/Notification.java src/share/classes/com/sun/nio/sctp/SctpChannel.java src/share/classes/com/sun/nio/sctp/SctpMultiChannel.java src/share/classes/com/sun/nio/sctp/SctpServerChannel.java
diffstat 9 files changed, 51 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/src/share/classes/com/sun/nio/sctp/Association.java	Wed Sep 11 09:45:52 2013 +0200
+++ b/src/share/classes/com/sun/nio/sctp/Association.java	Wed Sep 11 11:03:51 2013 +0100
@@ -58,6 +58,13 @@
 
     /**
      * Initializes a new instance of this class.
+     *
+     * @param  associationID
+     *         The association ID
+     * @param  maxInStreams
+     *         The maximum number of inbound streams
+     * @param  maxOutStreams
+     *         The maximum number of outbound streams
      */
     protected Association(int associationID,
                           int maxInStreams,
--- a/src/share/classes/com/sun/nio/sctp/IllegalReceiveException.java	Wed Sep 11 09:45:52 2013 +0200
+++ b/src/share/classes/com/sun/nio/sctp/IllegalReceiveException.java	Wed Sep 11 11:03:51 2013 +0100
@@ -41,6 +41,9 @@
 
     /**
      * Constructs an instance of this class with the specified message.
+     *
+     * @param  msg
+     *         The String that contains a detailed message
      */
     public IllegalReceiveException(String msg) {
         super(msg);
--- a/src/share/classes/com/sun/nio/sctp/IllegalUnbindException.java	Wed Sep 11 09:45:52 2013 +0200
+++ b/src/share/classes/com/sun/nio/sctp/IllegalUnbindException.java	Wed Sep 11 11:03:51 2013 +0100
@@ -41,6 +41,9 @@
 
     /**
      * Constructs an instance of this class with the specified detailed message.
+     *
+     * @param  msg
+     *         The String that contains a detailed message
      */
     public IllegalUnbindException(String msg) {
         super(msg);
--- a/src/share/classes/com/sun/nio/sctp/InvalidStreamException.java	Wed Sep 11 09:45:52 2013 +0200
+++ b/src/share/classes/com/sun/nio/sctp/InvalidStreamException.java	Wed Sep 11 11:03:51 2013 +0100
@@ -40,6 +40,9 @@
 
     /**
      * Constructs an instance of this class with the specified detailed message.
+     *
+     * @param  msg
+     *         The String that contains a detailed message
      */
     public InvalidStreamException(String msg) {
         super(msg);
--- a/src/share/classes/com/sun/nio/sctp/MessageInfo.java	Wed Sep 11 09:45:52 2013 +0200
+++ b/src/share/classes/com/sun/nio/sctp/MessageInfo.java	Wed Sep 11 11:03:51 2013 +0100
@@ -48,7 +48,7 @@
  * longer required to be sent after the time period expires. It is not a hard
  * timeout and may be influenced by whether the association supports the partial
  * reliability extension, <a href=http://www.ietf.org/rfc/rfc3758.txt>RFC 3758
- * <a>
+ * </a>.
  *
  * <P> {@code MessageInfo} instances are not safe for use by multiple concurrent
  * threads. If a MessageInfo is to be used by more than one thread then access
--- a/src/share/classes/com/sun/nio/sctp/Notification.java	Wed Sep 11 09:45:52 2013 +0200
+++ b/src/share/classes/com/sun/nio/sctp/Notification.java	Wed Sep 11 11:03:51 2013 +0100
@@ -40,6 +40,8 @@
 public interface Notification {
     /**
      * Returns the association that this notification is applicable to.
+     *
+     * @return  The association
      */
     public Association association();
 }
--- a/src/share/classes/com/sun/nio/sctp/SctpChannel.java	Wed Sep 11 09:45:52 2013 +0200
+++ b/src/share/classes/com/sun/nio/sctp/SctpChannel.java	Wed Sep 11 11:03:51 2013 +0100
@@ -59,7 +59,7 @@
  * {@link #setOption(SctpSocketOption,Object) setOption} method. An SCTP
  * channel support the following options:
  * <blockquote>
- * <table border>
+ * <table border summary="Socket options">
  *   <tr>
  *     <th>Option Name</th>
  *     <th>Description</th>
@@ -636,6 +636,9 @@
     /**
      * Returns the value of a socket option.
      *
+     * @param   <T>
+     *          The type of the socket option value
+     *
      * @param   name
      *          The socket option
      *
@@ -659,6 +662,9 @@
     /**
      * Sets the value of a socket option.
      *
+     * @param   <T>
+     *          The type of the socket option value
+     *
      * @param   name
      *          The socket option
      *
@@ -752,6 +758,9 @@
      * the {@code receive} method of this channel, if it does an
      * {@link IllegalReceiveException} will be thrown.
      *
+     * @param  <T>
+     *         The type of the attachment
+     *
      * @param  dst
      *         The buffer into which message bytes are to be transferred
      *
@@ -831,7 +840,7 @@
      *          there was insufficient room for the message in the underlying
      *          output buffer
      *
-     * @throws  InvalidStreamExcepton
+     * @throws  InvalidStreamException
      *          If {@code streamNumner} is negative or greater than or equal to
      *          the maximum number of outgoing streams
      *
--- a/src/share/classes/com/sun/nio/sctp/SctpMultiChannel.java	Wed Sep 11 09:45:52 2013 +0200
+++ b/src/share/classes/com/sun/nio/sctp/SctpMultiChannel.java	Wed Sep 11 11:03:51 2013 +0100
@@ -63,7 +63,7 @@
  * {@link #setOption(SctpSocketOption,Object,Association) setOption} method. An
  * {@code SctpMultiChannel} supports the following options:
  * <blockquote>
- * <table border>
+ * <table border summary="Socket options">
  *   <tr>
  *     <th>Option Name</th>
  *     <th>Description</th>
@@ -394,6 +394,9 @@
      * Returns all of the remote addresses to which the given association on
      * this channel's socket is connected.
      *
+     * @param  association
+     *         The association
+     *
      * @return  All of the remote addresses for the given association, or
      *          an empty {@code Set} if the association has been shutdown
      *
@@ -431,6 +434,9 @@
      * ignored if given. However, if the option is association specific then the
      * association must be given.
      *
+     * @param  <T>
+     *         The type of the socket option value
+     *
      * @param  name
      *         The socket option
      *
@@ -464,6 +470,9 @@
      * ignored if given. However, if the option is association specific then the
      * association must be given.
      *
+     * @param   <T>
+     *          The type of the socket option value
+     *
      * @param   name
      *          The socket option
      *
@@ -567,6 +576,9 @@
      * the {@code receive} method of this channel, if it does an
      * {@link IllegalReceiveException} will be thrown.
      *
+     * @param  <T>
+     *         The type of the attachment
+     *
      * @param  buffer
      *         The buffer into which bytes are to be transferred
      *
@@ -673,7 +685,7 @@
      *          there was insufficient room for the message in the underlying
      *          output buffer
      *
-     * @throws  InvalidStreamExcepton
+     * @throws  InvalidStreamException
      *          If {@code streamNumber} is negative, or if an association already
      *          exists and {@code streamNumber} is greater than the maximum number
      *          of outgoing streams
--- a/src/share/classes/com/sun/nio/sctp/SctpServerChannel.java	Wed Sep 11 09:45:52 2013 +0200
+++ b/src/share/classes/com/sun/nio/sctp/SctpServerChannel.java	Wed Sep 11 11:03:51 2013 +0100
@@ -47,7 +47,7 @@
  * {@link #setOption(SctpSocketOption,Object) setOption} method. SCTP server socket
  * channels support the following options:
  * <blockquote>
- * <table border>
+ * <table border summary="Socket options">
  *   <tr>
  *     <th>Option Name</th>
  *     <th>Description</th>
@@ -345,6 +345,9 @@
     /**
      * Returns the value of a socket option.
      *
+     * @param   <T>
+     *          The type of the socket option value
+     *
      * @param   name
      *          The socket option
      *
@@ -367,6 +370,9 @@
     /**
      * Sets the value of a socket option.
      *
+     * @param   <T>
+     *          The type of the socket option value
+     *
      * @param   name
      *          The socket option
      *