提交 e77ef9ea 编写于 作者: C chegar

8024508: Fix doclint issues in com.sun.nio.sctp

Reviewed-by: alanb
上级 4976c8cc
...@@ -58,6 +58,13 @@ public class Association { ...@@ -58,6 +58,13 @@ public class Association {
/** /**
* Initializes a new instance of this class. * 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, protected Association(int associationID,
int maxInStreams, int maxInStreams,
......
...@@ -41,6 +41,9 @@ public class IllegalReceiveException extends IllegalStateException { ...@@ -41,6 +41,9 @@ public class IllegalReceiveException extends IllegalStateException {
/** /**
* Constructs an instance of this class with the specified message. * Constructs an instance of this class with the specified message.
*
* @param msg
* The String that contains a detailed message
*/ */
public IllegalReceiveException(String msg) { public IllegalReceiveException(String msg) {
super(msg); super(msg);
......
...@@ -41,6 +41,9 @@ public class IllegalUnbindException extends IllegalStateException { ...@@ -41,6 +41,9 @@ public class IllegalUnbindException extends IllegalStateException {
/** /**
* Constructs an instance of this class with the specified detailed message. * Constructs an instance of this class with the specified detailed message.
*
* @param msg
* The String that contains a detailed message
*/ */
public IllegalUnbindException(String msg) { public IllegalUnbindException(String msg) {
super(msg); super(msg);
......
...@@ -40,6 +40,9 @@ public class InvalidStreamException extends IllegalArgumentException { ...@@ -40,6 +40,9 @@ public class InvalidStreamException extends IllegalArgumentException {
/** /**
* Constructs an instance of this class with the specified detailed message. * Constructs an instance of this class with the specified detailed message.
*
* @param msg
* The String that contains a detailed message
*/ */
public InvalidStreamException(String msg) { public InvalidStreamException(String msg) {
super(msg); super(msg);
......
...@@ -48,7 +48,7 @@ import java.net.SocketAddress; ...@@ -48,7 +48,7 @@ import java.net.SocketAddress;
* longer required to be sent after the time period expires. It is not a hard * 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 * 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 * 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 * <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 * threads. If a MessageInfo is to be used by more than one thread then access
......
...@@ -40,6 +40,8 @@ package com.sun.nio.sctp; ...@@ -40,6 +40,8 @@ package com.sun.nio.sctp;
public interface Notification { public interface Notification {
/** /**
* Returns the association that this notification is applicable to. * Returns the association that this notification is applicable to.
*
* @return The association
*/ */
public Association association(); public Association association();
} }
...@@ -59,7 +59,7 @@ import java.nio.channels.SelectionKey; ...@@ -59,7 +59,7 @@ import java.nio.channels.SelectionKey;
* {@link #setOption(SctpSocketOption,Object) setOption} method. An SCTP * {@link #setOption(SctpSocketOption,Object) setOption} method. An SCTP
* channel support the following options: * channel support the following options:
* <blockquote> * <blockquote>
* <table border> * <table border summary="Socket options">
* <tr> * <tr>
* <th>Option Name</th> * <th>Option Name</th>
* <th>Description</th> * <th>Description</th>
...@@ -636,6 +636,9 @@ public abstract class SctpChannel ...@@ -636,6 +636,9 @@ public abstract class SctpChannel
/** /**
* Returns the value of a socket option. * Returns the value of a socket option.
* *
* @param <T>
* The type of the socket option value
*
* @param name * @param name
* The socket option * The socket option
* *
...@@ -659,6 +662,9 @@ public abstract class SctpChannel ...@@ -659,6 +662,9 @@ public abstract class SctpChannel
/** /**
* Sets the value of a socket option. * Sets the value of a socket option.
* *
* @param <T>
* The type of the socket option value
*
* @param name * @param name
* The socket option * The socket option
* *
...@@ -752,6 +758,9 @@ public abstract class SctpChannel ...@@ -752,6 +758,9 @@ public abstract class SctpChannel
* the {@code receive} method of this channel, if it does an * the {@code receive} method of this channel, if it does an
* {@link IllegalReceiveException} will be thrown. * {@link IllegalReceiveException} will be thrown.
* *
* @param <T>
* The type of the attachment
*
* @param dst * @param dst
* The buffer into which message bytes are to be transferred * The buffer into which message bytes are to be transferred
* *
...@@ -831,7 +840,7 @@ public abstract class SctpChannel ...@@ -831,7 +840,7 @@ public abstract class SctpChannel
* there was insufficient room for the message in the underlying * there was insufficient room for the message in the underlying
* output buffer * output buffer
* *
* @throws InvalidStreamExcepton * @throws InvalidStreamException
* If {@code streamNumner} is negative or greater than or equal to * If {@code streamNumner} is negative or greater than or equal to
* the maximum number of outgoing streams * the maximum number of outgoing streams
* *
......
...@@ -63,7 +63,7 @@ import java.nio.channels.SelectionKey; ...@@ -63,7 +63,7 @@ import java.nio.channels.SelectionKey;
* {@link #setOption(SctpSocketOption,Object,Association) setOption} method. An * {@link #setOption(SctpSocketOption,Object,Association) setOption} method. An
* {@code SctpMultiChannel} supports the following options: * {@code SctpMultiChannel} supports the following options:
* <blockquote> * <blockquote>
* <table border> * <table border summary="Socket options">
* <tr> * <tr>
* <th>Option Name</th> * <th>Option Name</th>
* <th>Description</th> * <th>Description</th>
...@@ -394,6 +394,9 @@ public abstract class SctpMultiChannel ...@@ -394,6 +394,9 @@ public abstract class SctpMultiChannel
* Returns all of the remote addresses to which the given association on * Returns all of the remote addresses to which the given association on
* this channel's socket is connected. * this channel's socket is connected.
* *
* @param association
* The association
*
* @return All of the remote addresses for the given association, or * @return All of the remote addresses for the given association, or
* an empty {@code Set} if the association has been shutdown * an empty {@code Set} if the association has been shutdown
* *
...@@ -431,6 +434,9 @@ public abstract class SctpMultiChannel ...@@ -431,6 +434,9 @@ public abstract class SctpMultiChannel
* ignored if given. However, if the option is association specific then the * ignored if given. However, if the option is association specific then the
* association must be given. * association must be given.
* *
* @param <T>
* The type of the socket option value
*
* @param name * @param name
* The socket option * The socket option
* *
...@@ -464,6 +470,9 @@ public abstract class SctpMultiChannel ...@@ -464,6 +470,9 @@ public abstract class SctpMultiChannel
* ignored if given. However, if the option is association specific then the * ignored if given. However, if the option is association specific then the
* association must be given. * association must be given.
* *
* @param <T>
* The type of the socket option value
*
* @param name * @param name
* The socket option * The socket option
* *
...@@ -567,6 +576,9 @@ public abstract class SctpMultiChannel ...@@ -567,6 +576,9 @@ public abstract class SctpMultiChannel
* the {@code receive} method of this channel, if it does an * the {@code receive} method of this channel, if it does an
* {@link IllegalReceiveException} will be thrown. * {@link IllegalReceiveException} will be thrown.
* *
* @param <T>
* The type of the attachment
*
* @param buffer * @param buffer
* The buffer into which bytes are to be transferred * The buffer into which bytes are to be transferred
* *
...@@ -673,7 +685,7 @@ public abstract class SctpMultiChannel ...@@ -673,7 +685,7 @@ public abstract class SctpMultiChannel
* there was insufficient room for the message in the underlying * there was insufficient room for the message in the underlying
* output buffer * output buffer
* *
* @throws InvalidStreamExcepton * @throws InvalidStreamException
* If {@code streamNumber} is negative, or if an association already * If {@code streamNumber} is negative, or if an association already
* exists and {@code streamNumber} is greater than the maximum number * exists and {@code streamNumber} is greater than the maximum number
* of outgoing streams * of outgoing streams
......
...@@ -47,7 +47,7 @@ import java.nio.channels.spi.AbstractSelectableChannel; ...@@ -47,7 +47,7 @@ import java.nio.channels.spi.AbstractSelectableChannel;
* {@link #setOption(SctpSocketOption,Object) setOption} method. SCTP server socket * {@link #setOption(SctpSocketOption,Object) setOption} method. SCTP server socket
* channels support the following options: * channels support the following options:
* <blockquote> * <blockquote>
* <table border> * <table border summary="Socket options">
* <tr> * <tr>
* <th>Option Name</th> * <th>Option Name</th>
* <th>Description</th> * <th>Description</th>
...@@ -345,6 +345,9 @@ public abstract class SctpServerChannel ...@@ -345,6 +345,9 @@ public abstract class SctpServerChannel
/** /**
* Returns the value of a socket option. * Returns the value of a socket option.
* *
* @param <T>
* The type of the socket option value
*
* @param name * @param name
* The socket option * The socket option
* *
...@@ -367,6 +370,9 @@ public abstract class SctpServerChannel ...@@ -367,6 +370,9 @@ public abstract class SctpServerChannel
/** /**
* Sets the value of a socket option. * Sets the value of a socket option.
* *
* @param <T>
* The type of the socket option value
*
* @param name * @param name
* The socket option * The socket option
* *
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册