From d639bab3f338ddfc9c7a1549c0c009dfe347d0b5 Mon Sep 17 00:00:00 2001
From: Chris Hegarty <chegar@openjdk.org>
Date: Wed, 11 Sep 2013 11:03:51 +0100
Subject: [PATCH] 8024508: Fix doclint issues in com.sun.nio.sctp
Reviewed-by: alanb
---
.../classes/com/sun/nio/sctp/Association.java | 7 +++++++
.../sun/nio/sctp/IllegalReceiveException.java | 3 +++
.../com/sun/nio/sctp/IllegalUnbindException.java | 3 +++
.../com/sun/nio/sctp/InvalidStreamException.java | 3 +++
.../classes/com/sun/nio/sctp/MessageInfo.java | 2 +-
.../classes/com/sun/nio/sctp/Notification.java | 2 ++
.../classes/com/sun/nio/sctp/SctpChannel.java | 13 +++++++++++--
.../com/sun/nio/sctp/SctpMultiChannel.java | 16 ++++++++++++++--
.../com/sun/nio/sctp/SctpServerChannel.java | 8 +++++++-
9 files changed, 51 insertions(+), 6 deletions(-)
diff --git a/jdk/src/share/classes/com/sun/nio/sctp/Association.java b/jdk/src/share/classes/com/sun/nio/sctp/Association.java
index b367412b83f..965feae3418 100644
--- a/jdk/src/share/classes/com/sun/nio/sctp/Association.java
+++ b/jdk/src/share/classes/com/sun/nio/sctp/Association.java
@@ -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 --git a/jdk/src/share/classes/com/sun/nio/sctp/IllegalReceiveException.java b/jdk/src/share/classes/com/sun/nio/sctp/IllegalReceiveException.java
index 0dc063bd55c..b5a4137054d 100644
--- a/jdk/src/share/classes/com/sun/nio/sctp/IllegalReceiveException.java
+++ b/jdk/src/share/classes/com/sun/nio/sctp/IllegalReceiveException.java
@@ -41,6 +41,9 @@ public class IllegalReceiveException extends IllegalStateException {
/**
* 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 --git a/jdk/src/share/classes/com/sun/nio/sctp/IllegalUnbindException.java b/jdk/src/share/classes/com/sun/nio/sctp/IllegalUnbindException.java
index b48ef56b1b5..4088df34687 100644
--- a/jdk/src/share/classes/com/sun/nio/sctp/IllegalUnbindException.java
+++ b/jdk/src/share/classes/com/sun/nio/sctp/IllegalUnbindException.java
@@ -41,6 +41,9 @@ public class IllegalUnbindException extends IllegalStateException {
/**
* 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 --git a/jdk/src/share/classes/com/sun/nio/sctp/InvalidStreamException.java b/jdk/src/share/classes/com/sun/nio/sctp/InvalidStreamException.java
index 40a818fe5bd..abe49f24593 100644
--- a/jdk/src/share/classes/com/sun/nio/sctp/InvalidStreamException.java
+++ b/jdk/src/share/classes/com/sun/nio/sctp/InvalidStreamException.java
@@ -40,6 +40,9 @@ public class InvalidStreamException extends IllegalArgumentException {
/**
* 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 --git a/jdk/src/share/classes/com/sun/nio/sctp/MessageInfo.java b/jdk/src/share/classes/com/sun/nio/sctp/MessageInfo.java
index d7a2ee81563..997c6253834 100644
--- a/jdk/src/share/classes/com/sun/nio/sctp/MessageInfo.java
+++ b/jdk/src/share/classes/com/sun/nio/sctp/MessageInfo.java
@@ -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 --git a/jdk/src/share/classes/com/sun/nio/sctp/Notification.java b/jdk/src/share/classes/com/sun/nio/sctp/Notification.java
index cc23b8f2e47..2436fae7ba7 100644
--- a/jdk/src/share/classes/com/sun/nio/sctp/Notification.java
+++ b/jdk/src/share/classes/com/sun/nio/sctp/Notification.java
@@ -40,6 +40,8 @@ package com.sun.nio.sctp;
public interface Notification {
/**
* Returns the association that this notification is applicable to.
+ *
+ * @return The association
*/
public Association association();
}
diff --git a/jdk/src/share/classes/com/sun/nio/sctp/SctpChannel.java b/jdk/src/share/classes/com/sun/nio/sctp/SctpChannel.java
index 0b351a4ca3f..22cf07650f4 100644
--- a/jdk/src/share/classes/com/sun/nio/sctp/SctpChannel.java
+++ b/jdk/src/share/classes/com/sun/nio/sctp/SctpChannel.java
@@ -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
*
@@ -659,6 +662,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 --git a/jdk/src/share/classes/com/sun/nio/sctp/SctpMultiChannel.java b/jdk/src/share/classes/com/sun/nio/sctp/SctpMultiChannel.java
index f8745dba41e..42e56591e43 100644
--- a/jdk/src/share/classes/com/sun/nio/sctp/SctpMultiChannel.java
+++ b/jdk/src/share/classes/com/sun/nio/sctp/SctpMultiChannel.java
@@ -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
*
@@ -464,6 +470,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
*
@@ -567,6 +576,9 @@ public abstract class SctpMultiChannel
* 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 --git a/jdk/src/share/classes/com/sun/nio/sctp/SctpServerChannel.java b/jdk/src/share/classes/com/sun/nio/sctp/SctpServerChannel.java
index 637df72d394..c96e516ca4d 100644
--- a/jdk/src/share/classes/com/sun/nio/sctp/SctpServerChannel.java
+++ b/jdk/src/share/classes/com/sun/nio/sctp/SctpServerChannel.java
@@ -47,7 +47,7 @@ import java.nio.channels.spi.AbstractSelectableChannel;
* {@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
*
@@ -367,6 +370,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
*