# HG changeset patch # User alanb # Date 1371020651 -3600 # Node ID 68f1bc4eadd40e011da8f4cbaccbe906cf84e23d # Parent c0b32e884b700c5368035cae862cbd4d434bbe0d 8016370: javadoc warnings, unexpected
mostly Reviewed-by: martin, jjg diff -r c0b32e884b70 -r 68f1bc4eadd4 jdk/makefiles/scripts/genExceptions.sh --- a/jdk/makefiles/scripts/genExceptions.sh Tue Jun 11 15:39:20 2013 -0700 +++ b/jdk/makefiles/scripts/genExceptions.sh Wed Jun 12 08:04:11 2013 +0100 @@ -70,7 +70,7 @@ private $ARG_TYPE $ARG_ID; /** - * Constructs an instance of this class. + * Constructs an instance of this class. * * @param $ARG_ID * The $ARG_PHRASE @@ -81,7 +81,7 @@ } /** - * Retrieves the $ARG_PHRASE. + * Retrieves the $ARG_PHRASE. * * @return The $ARG_PHRASE */ diff -r c0b32e884b70 -r 68f1bc4eadd4 jdk/src/share/classes/java/nio/Buffer.java --- a/jdk/src/share/classes/java/nio/Buffer.java Tue Jun 11 15:39:20 2013 -0700 +++ b/jdk/src/share/classes/java/nio/Buffer.java Wed Jun 12 08:04:11 2013 +0100 @@ -209,7 +209,7 @@ } /** - * Returns this buffer's capacity. + * Returns this buffer's capacity. * * @return The capacity of this buffer */ @@ -218,7 +218,7 @@ } /** - * Returns this buffer's position. + * Returns this buffer's position. * * @return The position of this buffer */ @@ -228,7 +228,7 @@ /** * Sets this buffer's position. If the mark is defined and larger than the - * new position then it is discarded. + * new position then it is discarded. * * @param newPosition * The new position value; must be non-negative @@ -248,7 +248,7 @@ } /** - * Returns this buffer's limit. + * Returns this buffer's limit. * * @return The limit of this buffer */ @@ -259,7 +259,7 @@ /** * Sets this buffer's limit. If the position is larger than the new limit * then it is set to the new limit. If the mark is defined and larger than - * the new limit then it is discarded. + * the new limit then it is discarded. * * @param newLimit * The new limit value; must be non-negative @@ -280,7 +280,7 @@ } /** - * Sets this buffer's mark at its position. + * Sets this buffer's mark at its position. * * @return This buffer */ @@ -383,7 +383,7 @@ /** * Returns the number of elements between the current position and the - * limit. + * limit. * * @return The number of elements remaining in this buffer */ @@ -393,7 +393,7 @@ /** * Tells whether there are any elements between the current position and - * the limit. + * the limit. * * @return true if, and only if, there is at least one element * remaining in this buffer @@ -403,7 +403,7 @@ } /** - * Tells whether or not this buffer is read-only. + * Tells whether or not this buffer is read-only. * * @return true if, and only if, this buffer is read-only */ @@ -477,7 +477,7 @@ /** * Tells whether or not this buffer is - * direct. + * direct. * * @return true if, and only if, this buffer is direct * @@ -491,7 +491,7 @@ /** * Checks the current position against the limit, throwing a {@link * BufferUnderflowException} if it is not smaller than the limit, and then - * increments the position. + * increments the position. * * @return The current position value, before it is incremented */ @@ -512,7 +512,7 @@ /** * Checks the current position against the limit, throwing a {@link * BufferOverflowException} if it is not smaller than the limit, and then - * increments the position. + * increments the position. * * @return The current position value, before it is incremented */ diff -r c0b32e884b70 -r 68f1bc4eadd4 jdk/src/share/classes/java/nio/ByteOrder.java --- a/jdk/src/share/classes/java/nio/ByteOrder.java Tue Jun 11 15:39:20 2013 -0700 +++ b/jdk/src/share/classes/java/nio/ByteOrder.java Wed Jun 12 08:04:11 2013 +0100 @@ -45,7 +45,6 @@ /** * Constant denoting big-endian byte order. In this order, the bytes of a * multibyte value are ordered from most significant to least significant. - * */ public static final ByteOrder BIG_ENDIAN = new ByteOrder("BIG_ENDIAN"); @@ -53,7 +52,7 @@ /** * Constant denoting little-endian byte order. In this order, the bytes of * a multibyte value are ordered from least significant to most - * significant. + * significant. */ public static final ByteOrder LITTLE_ENDIAN = new ByteOrder("LITTLE_ENDIAN"); diff -r c0b32e884b70 -r 68f1bc4eadd4 jdk/src/share/classes/java/nio/X-Buffer.java.template --- a/jdk/src/share/classes/java/nio/X-Buffer.java.template Tue Jun 11 15:39:20 2013 -0700 +++ b/jdk/src/share/classes/java/nio/X-Buffer.java.template Wed Jun 12 08:04:11 2013 +0100 @@ -551,7 +551,7 @@ /** * Relative get method. Reads the $type$ at this buffer's - * current position, and then increments the position. + * current position, and then increments the position. * * @return The $type$ at the buffer's current position * @@ -581,7 +581,7 @@ /** * Absolute get method. Reads the $type$ at the given - * index. + * index. * * @param index * The index from which the $type$ will be read @@ -658,7 +658,7 @@ * } * * except that it first checks that there are sufficient $type$s in - * this buffer and it is potentially much more efficient. + * this buffer and it is potentially much more efficient. * * @param dst * The array into which $type$s are to be written @@ -739,7 +739,7 @@ * dst.put(src.get()); * * except that it first checks that there is sufficient space in this - * buffer and it is potentially much more efficient. + * buffer and it is potentially much more efficient. * * @param src * The source buffer from which $type$s are to be read; @@ -795,7 +795,7 @@ * } * * except that it first checks that there is sufficient space in this - * buffer and it is potentially much more efficient. + * buffer and it is potentially much more efficient. * * @param src * The array from which $type$s are to be read @@ -882,7 +882,7 @@ * } * * except that it first checks that there is sufficient space in this - * buffer and it is potentially much more efficient. + * buffer and it is potentially much more efficient. * * @param src * The string from which $type$s are to be read @@ -1060,7 +1060,7 @@ public abstract $Type$Buffer compact(); /** - * Tells whether or not this $type$ buffer is direct. + * Tells whether or not this $type$ buffer is direct. * * @return true if, and only if, this buffer is direct */ @@ -1069,7 +1069,7 @@ #if[!char] /** - * Returns a string summarizing the state of this buffer. + * Returns a string summarizing the state of this buffer. * * @return A summary string */ @@ -1254,7 +1254,7 @@ /** * Reads the character at the given index relative to the current - * position. + * position. * * @param index * The index of the character to be read, relative to the position; @@ -1452,7 +1452,7 @@ } /** - * Modifies this buffer's byte order. + * Modifies this buffer's byte order. * * @param bo * The new byte order, diff -r c0b32e884b70 -r 68f1bc4eadd4 jdk/src/share/classes/java/nio/channels/AsynchronousServerSocketChannel.java --- a/jdk/src/share/classes/java/nio/channels/AsynchronousServerSocketChannel.java Tue Jun 11 15:39:20 2013 -0700 +++ b/jdk/src/share/classes/java/nio/channels/AsynchronousServerSocketChannel.java Wed Jun 12 08:04:11 2013 +0100 @@ -253,7 +253,7 @@ *To allow for concurrent handling of new connections, the completion * handler is not invoked directly by the initiating thread when a new * connection is accepted immediately (see Threading). + * href="AsynchronousChannelGroup.html#threading">Threading). * *
If a security manager has been installed then it verifies that the * address and port number of the connection's remote endpoint are permitted diff -r c0b32e884b70 -r 68f1bc4eadd4 jdk/src/share/classes/java/nio/channels/Channel.java --- a/jdk/src/share/classes/java/nio/channels/Channel.java Tue Jun 11 15:39:20 2013 -0700 +++ b/jdk/src/share/classes/java/nio/channels/Channel.java Wed Jun 12 08:04:11 2013 +0100 @@ -56,7 +56,7 @@ public interface Channel extends Closeable { /** - * Tells whether or not this channel is open.
+ * Tells whether or not this channel is open. * * @return true if, and only if, this channel is open */ diff -r c0b32e884b70 -r 68f1bc4eadd4 jdk/src/share/classes/java/nio/channels/FileChannel.java --- a/jdk/src/share/classes/java/nio/channels/FileChannel.java Tue Jun 11 15:39:20 2013 -0700 +++ b/jdk/src/share/classes/java/nio/channels/FileChannel.java Wed Jun 12 08:04:11 2013 +0100 @@ -418,7 +418,7 @@ // -- Other operations -- /** - * Returns this channel's file position. + * Returns this channel's file position. * * @return This channel's file position, * a non-negative integer counting the number of bytes @@ -461,7 +461,7 @@ public abstract FileChannel position(long newPosition) throws IOException; /** - * Returns the current size of this channel's file. + * Returns the current size of this channel's file. * * @return The current size of this channel's file, * measured in bytes diff -r c0b32e884b70 -r 68f1bc4eadd4 jdk/src/share/classes/java/nio/channels/FileLock.java --- a/jdk/src/share/classes/java/nio/channels/FileLock.java Tue Jun 11 15:39:20 2013 -0700 +++ b/jdk/src/share/classes/java/nio/channels/FileLock.java Wed Jun 12 08:04:11 2013 +0100 @@ -124,7 +124,7 @@ private final boolean shared; /** - * Initializes a new instance of this class. + * Initializes a new instance of this class. * * @param channel * The file channel upon whose file this lock is held @@ -249,7 +249,7 @@ } /** - * Tells whether this lock is shared. + * Tells whether this lock is shared. * * @return true if lock is shared, * false if it is exclusive @@ -259,7 +259,7 @@ } /** - * Tells whether or not this lock overlaps the given lock range. + * Tells whether or not this lock overlaps the given lock range. * * @return true if, and only if, this lock and the given lock * range overlap by at least one byte diff -r c0b32e884b70 -r 68f1bc4eadd4 jdk/src/share/classes/java/nio/channels/Pipe.java --- a/jdk/src/share/classes/java/nio/channels/Pipe.java Tue Jun 11 15:39:20 2013 -0700 +++ b/jdk/src/share/classes/java/nio/channels/Pipe.java Wed Jun 12 08:04:11 2013 +0100 @@ -53,7 +53,7 @@ public abstract class Pipe { /** - * A channel representing the readable end of a {@link Pipe}. + * A channel representing the readable end of a {@link Pipe}. * * @since 1.4 */ @@ -84,7 +84,7 @@ } /** - * A channel representing the writable end of a {@link Pipe}. + * A channel representing the writable end of a {@link Pipe}. * * @since 1.4 */ @@ -120,14 +120,14 @@ protected Pipe() { } /** - * Returns this pipe's source channel. + * Returns this pipe's source channel. * * @return This pipe's source channel */ public abstract SourceChannel source(); /** - * Returns this pipe's sink channel. + * Returns this pipe's sink channel. * * @return This pipe's sink channel */ diff -r c0b32e884b70 -r 68f1bc4eadd4 jdk/src/share/classes/java/nio/channels/SelectableChannel.java --- a/jdk/src/share/classes/java/nio/channels/SelectableChannel.java Tue Jun 11 15:39:20 2013 -0700 +++ b/jdk/src/share/classes/java/nio/channels/SelectableChannel.java Wed Jun 12 08:04:11 2013 +0100 @@ -111,7 +111,7 @@ * identifying this channel's supported operations. The bits that are set * in this integer value denote exactly the operations that are valid for * this channel. This method always returns the same value for a given - * concrete channel class. + * concrete channel class. * * @return The valid-operation set */ @@ -140,7 +140,7 @@ /** * Retrieves the key representing the channel's registration with the given - * selector. + * selector. * * @return The key returned when this channel was last registered with the * given selector, or null if this channel is not @@ -333,7 +333,6 @@ * configureBlocking} and {@link #register register} methods synchronize. * This is often useful in the implementation of adaptors that require a * specific blocking mode to be maintained for a short period of time. - * * * @return The blocking-mode lock object */ diff -r c0b32e884b70 -r 68f1bc4eadd4 jdk/src/share/classes/java/nio/channels/SelectionKey.java --- a/jdk/src/share/classes/java/nio/channels/SelectionKey.java Tue Jun 11 15:39:20 2013 -0700 +++ b/jdk/src/share/classes/java/nio/channels/SelectionKey.java Wed Jun 12 08:04:11 2013 +0100 @@ -119,7 +119,7 @@ /** * Returns the channel for which this key was created. This method will - * continue to return the channel even after the key is cancelled. + * continue to return the channel even after the key is cancelled. * * @return This key's channel */ @@ -127,7 +127,7 @@ /** * Returns the selector for which this key was created. This method will - * continue to return the selector even after the key is cancelled. + * continue to return the selector even after the key is cancelled. * * @return This key's selector */ @@ -228,7 +228,7 @@ public static final int OP_READ = 1 << 0; /** - * Operation-set bit for write operations. + * Operation-set bit for write operations. * * Suppose that a selection key's interest set contains
* OP_WRITE at the start of a
+ * Operation-set bit for socket-connect operations.
*
* Suppose that a selection key's interest set contains
* OP_CONNECT at the start of a
+ * Operation-set bit for socket-accept operations.
*
* Suppose that a selection key's interest set contains
* OP_ACCEPT at the start of a An invocation of this method of the form k.isConnectable()
* behaves in exactly the same way as the expression
*
- * {@code
+ *
*
@@ -389,7 +389,7 @@
}
/**
- * Retrieves the current attachment. {@code
* k.readyOps() & OP_CONNECT != 0
* }
This method invokes the {@link #implOnMalformedInput * implOnMalformedInput} method, passing the new action.
@@ -391,7 +391,6 @@ /** * Returns this $coder$'s current action for unmappable-character errors. - * * * @return The current unmappable-character action, which is never * null @@ -435,7 +434,7 @@ /** * Returns the average number of $otype$s that will be produced for each * $itype$ of input. This heuristic value may be used to estimate the size - * of the output buffer required for a given input sequence. + * of the output buffer required for a given input sequence. * * @return The average number of $otype$s produced * per $itype$ of input @@ -447,7 +446,7 @@ /** * Returns the maximum number of $otype$s that will be produced for each * $itype$ of input. This value may be used to compute the worst-case size - * of the output buffer required for a given input sequence. + * of the output buffer required for a given input sequence. * * @return The maximum number of $otype$s that will be produced per * $itype$ of input diff -r c0b32e884b70 -r 68f1bc4eadd4 jdk/src/share/classes/java/nio/charset/Charset.java --- a/jdk/src/share/classes/java/nio/charset/Charset.java Tue Jun 11 15:39:20 2013 -0700 +++ b/jdk/src/share/classes/java/nio/charset/Charset.java Wed Jun 12 08:04:11 2013 +0100 @@ -490,7 +490,7 @@ } /** - * Tells whether the named charset is supported. + * Tells whether the named charset is supported. * * @param charsetName * The name of the requested charset; may be either @@ -510,7 +510,7 @@ } /** - * Returns a charset object for the named charset. + * Returns a charset object for the named charset. * * @param charsetName * The name of the requested charset; may be either @@ -629,7 +629,7 @@ /** * Initializes a new charset with the given canonical name and alias - * set. + * set. * * @param canonicalName * The canonical name of this charset @@ -650,7 +650,7 @@ } /** - * Returns this charset's canonical name. + * Returns this charset's canonical name. * * @return The canonical name of this charset */ @@ -659,7 +659,7 @@ } /** - * Returns a set containing this charset's aliases. + * Returns a set containing this charset's aliases. * * @return An immutable set of this charset's aliases */ @@ -690,7 +690,7 @@ /** * Tells whether or not this charset is registered in the IANA Charset - * Registry. + * Registry. * * @return true if, and only if, this charset is known by its * implementor to be registered with the IANA @@ -742,14 +742,14 @@ public abstract boolean contains(Charset cs); /** - * Constructs a new decoder for this charset. + * Constructs a new decoder for this charset. * * @return A new decoder for this charset */ public abstract CharsetDecoder newDecoder(); /** - * Constructs a new encoder for this charset. + * Constructs a new encoder for this charset. * * @return A new encoder for this charset * @@ -881,7 +881,7 @@ } /** - * Computes a hashcode for this charset. + * Computes a hashcode for this charset. * * @return An integer hashcode */ @@ -907,7 +907,7 @@ } /** - * Returns a string describing this charset. + * Returns a string describing this charset. * * @return A string describing this charset */ diff -r c0b32e884b70 -r 68f1bc4eadd4 jdk/src/share/classes/java/nio/charset/CoderResult.java --- a/jdk/src/share/classes/java/nio/charset/CoderResult.java Tue Jun 11 15:39:20 2013 -0700 +++ b/jdk/src/share/classes/java/nio/charset/CoderResult.java Wed Jun 12 08:04:11 2013 +0100 @@ -71,7 +71,7 @@ * * * - * For convenience, the {@link #isError() isError} method returns true + *For convenience, the {@link #isError() isError} method returns true * for result objects that describe malformed-input and unmappable-character * errors but false for those that describe underflow or overflow * conditions.
@@ -112,7 +112,7 @@ } /** - * Tells whether or not this object describes an underflow condition. + * Tells whether or not this object describes an underflow condition. * * @return true if, and only if, this object denotes underflow */ @@ -121,7 +121,7 @@ } /** - * Tells whether or not this object describes an overflow condition. + * Tells whether or not this object describes an overflow condition. * * @return true if, and only if, this object denotes overflow */ @@ -130,7 +130,7 @@ } /** - * Tells whether or not this object describes an error condition. + * Tells whether or not this object describes an error condition. * * @return true if, and only if, this object denotes either a * malformed-input error or an unmappable-character error @@ -141,7 +141,6 @@ /** * Tells whether or not this object describes a malformed-input error. - * * * @return true if, and only if, this object denotes a * malformed-input error @@ -152,7 +151,7 @@ /** * Tells whether or not this object describes an unmappable-character - * error. + * error. * * @return true if, and only if, this object denotes an * unmappable-character error @@ -163,7 +162,7 @@ /** * Returns the length of the erroneous input described by this - * object (optional operation). + * object (optional operation). * * @return The length of the erroneous input, a positive integer * @@ -180,14 +179,14 @@ /** * Result object indicating underflow, meaning that either the input buffer * has been completely consumed or, if the input buffer is not yet empty, - * that additional input is required. + * that additional input is required. */ public static final CoderResult UNDERFLOW = new CoderResult(CR_UNDERFLOW, 0); /** * Result object indicating overflow, meaning that there is insufficient - * room in the output buffer. + * room in the output buffer. */ public static final CoderResult OVERFLOW = new CoderResult(CR_OVERFLOW, 0); @@ -226,7 +225,7 @@ /** * Static factory method that returns the unique object describing a - * malformed-input error of the given length. + * malformed-input error of the given length. * * @return The requested coder-result object */ @@ -242,7 +241,7 @@ /** * Static factory method that returns the unique result object describing - * an unmappable-character error of the given length. + * an unmappable-character error of the given length. * * @return The requested coder-result object */ @@ -252,7 +251,6 @@ /** * Throws an exception appropriate to the result described by this object. - * * * @throws BufferUnderflowException * If this object is {@link #UNDERFLOW} diff -r c0b32e884b70 -r 68f1bc4eadd4 jdk/src/share/classes/java/nio/charset/CodingErrorAction.java --- a/jdk/src/share/classes/java/nio/charset/CodingErrorAction.java Tue Jun 11 15:39:20 2013 -0700 +++ b/jdk/src/share/classes/java/nio/charset/CodingErrorAction.java Wed Jun 12 08:04:11 2013 +0100 @@ -50,7 +50,7 @@ /** * Action indicating that a coding error is to be handled by dropping the - * erroneous input and resuming the coding operation. + * erroneous input and resuming the coding operation. */ public static final CodingErrorAction IGNORE = new CodingErrorAction("IGNORE"); @@ -58,7 +58,7 @@ /** * Action indicating that a coding error is to be handled by dropping the * erroneous input, appending the coder's replacement value to the output - * buffer, and resuming the coding operation. + * buffer, and resuming the coding operation. */ public static final CodingErrorAction REPLACE = new CodingErrorAction("REPLACE"); @@ -73,7 +73,7 @@ = new CodingErrorAction("REPORT"); /** - * Returns a string describing this action. + * Returns a string describing this action. * * @return A descriptive string */ diff -r c0b32e884b70 -r 68f1bc4eadd4 jdk/src/share/classes/java/nio/charset/UnmappableCharacterException.java --- a/jdk/src/share/classes/java/nio/charset/UnmappableCharacterException.java Tue Jun 11 15:39:20 2013 -0700 +++ b/jdk/src/share/classes/java/nio/charset/UnmappableCharacterException.java Wed Jun 12 08:04:11 2013 +0100 @@ -29,7 +29,7 @@ /** * Checked exception thrown when an input character (or byte) sequence * is valid but cannot be mapped to an output byte (or character) - * sequence. + * sequence. * * @since 1.4 */ diff -r c0b32e884b70 -r 68f1bc4eadd4 jdk/src/share/classes/java/nio/charset/spi/CharsetProvider.java --- a/jdk/src/share/classes/java/nio/charset/spi/CharsetProvider.java Tue Jun 11 15:39:20 2013 -0700 +++ b/jdk/src/share/classes/java/nio/charset/spi/CharsetProvider.java Wed Jun 12 08:04:11 2013 +0100 @@ -72,7 +72,7 @@ public abstract class CharsetProvider { /** - * Initializes a new charset provider. + * Initializes a new charset provider. * * @throws SecurityException * If a security manager has been installed and it denies @@ -88,14 +88,14 @@ * Creates an iterator that iterates over the charsets supported by this * provider. This method is used in the implementation of the {@link * java.nio.charset.Charset#availableCharsets Charset.availableCharsets} - * method. + * method. * * @return The new iterator */ public abstract Iterator