RFR: 8024508 Fix doclint issues in com.sun.nio.sctp
Chris Hegarty
chris.hegarty at oracle.com
Tue Sep 10 02:09:18 PDT 2013
Trivial doclint issues in the com.sun.nio.sctp public package.
diff -r 4fd7abaf0a5f src/share/classes/com/sun/nio/sctp/Association.java
--- a/src/share/classes/com/sun/nio/sctp/Association.java Mon Sep
09 13:44:30 2013 +0100
+++ b/src/share/classes/com/sun/nio/sctp/Association.java Tue Sep
10 10:08:09 2013 +0100
@@ -58,6 +58,13 @@ public class Association {
/**
* 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,
diff -r 4fd7abaf0a5f
src/share/classes/com/sun/nio/sctp/IllegalReceiveException.java
--- a/src/share/classes/com/sun/nio/sctp/IllegalReceiveException.java
Mon Sep 09 13:44:30 2013 +0100
+++ b/src/share/classes/com/sun/nio/sctp/IllegalReceiveException.java
Tue Sep 10 10:08:09 2013 +0100
@@ -41,6 +41,9 @@ public class IllegalReceiveException ext
/**
* 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);
diff -r 4fd7abaf0a5f
src/share/classes/com/sun/nio/sctp/IllegalUnbindException.java
--- a/src/share/classes/com/sun/nio/sctp/IllegalUnbindException.java
Mon Sep 09 13:44:30 2013 +0100
+++ b/src/share/classes/com/sun/nio/sctp/IllegalUnbindException.java
Tue Sep 10 10:08:09 2013 +0100
@@ -41,6 +41,9 @@ public class IllegalUnbindException exte
/**
* 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);
diff -r 4fd7abaf0a5f
src/share/classes/com/sun/nio/sctp/InvalidStreamException.java
--- a/src/share/classes/com/sun/nio/sctp/InvalidStreamException.java
Mon Sep 09 13:44:30 2013 +0100
+++ b/src/share/classes/com/sun/nio/sctp/InvalidStreamException.java
Tue Sep 10 10:08:09 2013 +0100
@@ -40,6 +40,9 @@ public class InvalidStreamException exte
/**
* 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);
diff -r 4fd7abaf0a5f src/share/classes/com/sun/nio/sctp/MessageInfo.java
--- a/src/share/classes/com/sun/nio/sctp/MessageInfo.java Mon Sep
09 13:44:30 2013 +0100
+++ b/src/share/classes/com/sun/nio/sctp/MessageInfo.java Tue Sep
10 10:08:09 2013 +0100
@@ -48,7 +48,7 @@ import java.net.SocketAddress;
* 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
diff -r 4fd7abaf0a5f src/share/classes/com/sun/nio/sctp/Notification.java
--- a/src/share/classes/com/sun/nio/sctp/Notification.java Mon Sep
09 13:44:30 2013 +0100
+++ b/src/share/classes/com/sun/nio/sctp/Notification.java Tue Sep
10 10:08:09 2013 +0100
@@ -40,6 +40,8 @@ public interface Notification {
public interface Notification {
/**
* Returns the association that this notification is applicable to.
+ *
+ * @return The association
*/
public Association association();
}
diff -r 4fd7abaf0a5f src/share/classes/com/sun/nio/sctp/SctpChannel.java
--- a/src/share/classes/com/sun/nio/sctp/SctpChannel.java Mon Sep
09 13:44:30 2013 +0100
+++ b/src/share/classes/com/sun/nio/sctp/SctpChannel.java Tue Sep
10 10:08:09 2013 +0100
@@ -59,7 +59,7 @@ import java.nio.channels.SelectionKey;
* {@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 @@ public abstract class SctpChannel
/**
* Returns the value of a socket option.
*
+ * @param <T>
+ * The type of the socket option value
+ *
* @param name
* The socket option
*
@@ -658,6 +661,9 @@ public abstract class SctpChannel
/**
* 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 @@ public abstract class SctpChannel
* 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 @@ public abstract class SctpChannel
* 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
*
diff -r 4fd7abaf0a5f
src/share/classes/com/sun/nio/sctp/SctpMultiChannel.java
--- a/src/share/classes/com/sun/nio/sctp/SctpMultiChannel.java Mon Sep
09 13:44:30 2013 +0100
+++ b/src/share/classes/com/sun/nio/sctp/SctpMultiChannel.java Tue Sep
10 10:08:09 2013 +0100
@@ -63,7 +63,7 @@ import java.nio.channels.SelectionKey;
* {@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 @@ public abstract class SctpMultiChannel
* 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 @@ public abstract class SctpMultiChannel
* 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
*
@@ -463,6 +469,9 @@ public abstract class SctpMultiChannel
* therefore the {@code association} parameter is not applicable
and will be
* 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
@@ -566,6 +575,9 @@ public abstract class SctpMultiChannel
* will not stall other threads from receiving. A handler should
not invoke
* 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 @@ public abstract class SctpMultiChannel
* 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
diff -r 4fd7abaf0a5f
src/share/classes/com/sun/nio/sctp/SctpServerChannel.java
--- a/src/share/classes/com/sun/nio/sctp/SctpServerChannel.java Mon Sep
09 13:44:30 2013 +0100
+++ b/src/share/classes/com/sun/nio/sctp/SctpServerChannel.java Tue Sep
10 10:08:09 2013 +0100
@@ -47,7 +47,7 @@ import java.nio.channels.spi.AbstractSel
* {@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 @@ public abstract class SctpServerChannel
/**
* Returns the value of a socket option.
*
+ * @param <T>
+ * The type of the socket option value
+ *
* @param name
* The socket option
*
@@ -366,6 +369,9 @@ public abstract class SctpServerChannel
/**
* Sets the value of a socket option.
+ *
+ * @param <T>
+ * The type of the socket option value
*
* @param name
* The socket option
-Chris.
More information about the net-dev
mailing list