Javadoc improvements

Author: garydgregory

src/main/java/org/apache/commons/io/ByteOrderMark.java

@@ -193,10 +193,6 @@ public byte[] getBytes() {
         return copy;
     }
 
-    int[] getRawBytes() {
-        return bytes;
-    }
-
     /**
      * Gets the name of the {@link java.nio.charset.Charset} the BOM represents.
      *
@@ -206,6 +202,10 @@ public String getCharsetName() {
         return charsetName;
     }
 
+    int[] getRawBytes() {
+        return bytes;
+    }
+
     /**
      * Computes the hash code for this BOM.
      *

src/main/java/org/apache/commons/io/input/AutoCloseInputStream.java

@@ -78,13 +78,13 @@ public Builder() {
          * This builder uses the following aspects:
          * </p>
          * <ul>
-         * <li>{@link #getInputStream()}</li>
+         * <li>{@link #getInputStream()} gets the target aspect.</li>
          * </ul>
          *
          * @return a new instance.
          * @throws IllegalStateException         if the {@code origin} is {@code null}.
          * @throws UnsupportedOperationException if the origin cannot be converted to an {@link InputStream}.
-         * @throws IOException                   if an I/O error occurs.
+         * @throws IOException                   if an I/O error occurs converting to an {@link InputStream} using {@link #getInputStream()}.
          * @see #getInputStream()
          * @see #getUnchecked()
          */

src/main/java/org/apache/commons/io/input/BOMInputStream.java

@@ -168,7 +168,7 @@ public Builder() {
          * @return a new instance.
          * @throws IllegalStateException         if the {@code origin} is {@code null}.
          * @throws UnsupportedOperationException if the origin cannot be converted to an {@link InputStream}.
-         * @throws IOException                   if an I/O error occurs.
+         * @throws IOException                   if an I/O error occurs converting to an {@link InputStream} using {@link #getInputStream()}.
          * @see #getInputStream()
          * @see #getUnchecked()
          */

src/main/java/org/apache/commons/io/input/BoundedInputStream.java

@@ -261,7 +261,7 @@ public Builder() {
          * This builder uses the following aspects:
          * </p>
          * <ul>
-         * <li>{@link #getInputStream()} (the target aspect)</li>
+         * <li>{@link #getInputStream()} gets the target aspect.</li>
          * <li>{@link #getAfterRead()}</li>
          * <li>{@link #getCount()}</li>
          * <li>{@link #getMaxCount()}</li>

src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java

@@ -91,14 +91,15 @@ public Builder() {
          * This builder uses the following aspects:
          * </p>
          * <ul>
-         * <li>{@link #getInputStream()}</li>
+         * <li>{@link FileChannel} takes precedence is set. </li>
+         * <li>{@link #getPath()} if the file channel is not set.</li>
          * <li>{@link #getBufferSize()}</li>
          * </ul>
          *
          * @return a new instance.
          * @throws IllegalStateException         if the {@code origin} is {@code null}.
          * @throws UnsupportedOperationException if the origin cannot be converted to a {@link Path}.
-         * @throws IOException If an I/O error occurs
+         * @throws IOException                   if an I/O error occurs converting to an {@link Path} using {@link #getPath()}.
          * @see #getPath()
          * @see #getBufferSize()
          * @see #getUnchecked()

src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java

@@ -101,7 +101,7 @@ public Builder() {
          * This builder uses the following aspects:
          * </p>
          * <ul>
-         * <li>{@link #getCharSequence()}</li>
+         * <li>{@link #getCharSequence()} gets the target aspect.</li>
          * <li>{@link #getBufferSize()}</li>
          * <li>{@link CharsetEncoder}</li>
          * </ul>

src/main/java/org/apache/commons/io/input/ChecksumInputStream.java

@@ -134,7 +134,7 @@ public Builder() {
          * This builder uses the following aspects:
          * </p>
          * <ul>
-         * <li>{@link #getInputStream()}</li>
+         * <li>{@link #getInputStream()} gets the target aspect.</li>
          * <li>{@link Checksum}</li>
          * <li>expectedChecksumValue</li>
          * <li>countThreshold</li>
@@ -143,7 +143,7 @@ public Builder() {
          * @return a new instance.
          * @throws IllegalStateException         if the {@code origin} is {@code null}.
          * @throws UnsupportedOperationException if the origin cannot be converted to an {@link InputStream}.
-         * @throws IOException                   if an I/O error occurs.
+         * @throws IOException                   if an I/O error occurs converting to an {@link InputStream} using {@link #getInputStream()}.
          * @see #getInputStream()
          * @see #getUnchecked()
          */

src/main/java/org/apache/commons/io/input/MessageDigestCalculatingInputStream.java

@@ -92,15 +92,15 @@ public Builder() {
          * This builder uses the following aspects:
          * </p>
          * <ul>
-         * <li>{@link #getPath()}</li>
+         * <li>{@link #getInputStream()} gets the target aspect.</li>
          * <li>{@link MessageDigest}</li>
          * </ul>
          *
          * @return a new instance.
          * @throws NullPointerException if messageDigest is null.
          * @throws IllegalStateException         if the {@code origin} is {@code null}.
          * @throws UnsupportedOperationException if the origin cannot be converted to an {@link InputStream}.
-         * @throws IOException                   if an I/O error occurs.
+         * @throws IOException                   if an I/O error occurs converting to an {@link InputStream} using {@link #getInputStream()}.
          * @see #getInputStream()
          * @see #getUnchecked()
          */

src/main/java/org/apache/commons/io/input/MessageDigestInputStream.java

@@ -91,15 +91,15 @@ public Builder() {
          * This builder uses the following aspects:
          * </p>
          * <ul>
-         * <li>{@link #getPath()}</li>
+         * <li>{@link #getInputStream()} gets the target aspect.</li>
          * <li>{@link MessageDigest}</li>
          * </ul>
          *
          * @return a new instance.
          * @throws NullPointerException if messageDigest is null.
          * @throws IllegalStateException         if the {@code origin} is {@code null}.
          * @throws UnsupportedOperationException if the origin cannot be converted to an {@link InputStream}.
-         * @throws IOException                   if an I/O error occurs.
+         * @throws IOException                   if an I/O error occurs converting to an {@link InputStream} using {@link #getInputStream()}.
          * @see #getInputStream()
          * @see #getUnchecked()
          */

src/main/java/org/apache/commons/io/input/ThrottledInputStream.java

@@ -95,14 +95,14 @@ public Builder() {
          * This builder uses the following aspects:
          * </p>
          * <ul>
-         * <li>{@link #getInputStream()}</li>
+         * <li>{@link #getInputStream()} gets the target aspect.</li>
          * <li>maxBytesPerSecond</li>
          * </ul>
          *
          * @return a new instance.
          * @throws IllegalStateException         if the {@code origin} is {@code null}.
          * @throws UnsupportedOperationException if the origin cannot be converted to an {@link InputStream}.
-         * @throws IOException                   if an I/O error occurs.
+         * @throws IOException                   if an I/O error occurs converting to an {@link InputStream} using {@link #getInputStream()}.
          * @see #getInputStream()
          * @see #getUnchecked()
          */