Javadoc

Author: garydgregory

src/main/java/org/apache/commons/codec/binary/Base16.java

@@ -36,6 +36,8 @@
  * alphabet.
  * </p>
  *
+ * @see Base16InputStream
+ * @see Base16OutputStream
  * @see <a href="https://tools.ietf.org/html/rfc4648#section-8">RFC 4648 - 8. Base 16 Encoding</a>
  * @since 1.15
  */

src/main/java/org/apache/commons/codec/binary/Base16InputStream.java

@@ -28,6 +28,7 @@
  * {@link Base16OutputStream} is to ENCODE, but this behavior can be overridden by using a different constructor.
  * </p>
  *
+ * @see Base16
  * @since 1.15
  */
 public class Base16InputStream extends BaseNCodecInputStream {

src/main/java/org/apache/commons/codec/binary/Base16OutputStream.java

@@ -28,6 +28,7 @@
  * {@link Base16InputStream} is to DECODE. But this behavior can be overridden by using a different constructor.
  * </p>
  *
+ * @see Base16
  * @since 1.15
  */
 public class Base16OutputStream extends BaseNCodecOutputStream {

src/main/java/org/apache/commons/codec/binary/Base32.java

@@ -51,6 +51,8 @@
  *   .get()
  * </pre>
  *
+ * @see Base32InputStream
+ * @see Base32OutputStream
  * @see <a href="http://www.ietf.org/rfc/rfc4648.txt">RFC 4648</a>
  * @since 1.5
  */

src/main/java/org/apache/commons/codec/binary/Base32InputStream.java

@@ -49,6 +49,8 @@
  * the original, i.e. no changes occur on the final character. This requires that the input bytes use the same padding
  * and alphabet as the encoder.
  * </p>
+ *
+ * @see Base32
  * @see <a href="http://www.ietf.org/rfc/rfc4648.txt">RFC 4648</a>
  * @since 1.5
  */

src/main/java/org/apache/commons/codec/binary/Base32OutputStream.java

@@ -53,6 +53,8 @@
  * the original, i.e. no changes occur on the final character. This requires that the input bytes use the same padding
  * and alphabet as the encoder.
  * </p>
+ *
+ * @see Base32
  * @see <a href="http://www.ietf.org/rfc/rfc4648.txt">RFC 4648</a>
  * @since 1.5
  */

src/main/java/org/apache/commons/codec/binary/Base64.java

@@ -64,6 +64,8 @@
  *   .get()
  * </pre>
  *
+ * @see Base64InputStream
+ * @see Base64OutputStream
  * @see <a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a>
  * @since 1.0
  */

src/main/java/org/apache/commons/codec/binary/Base64InputStream.java

@@ -53,6 +53,8 @@
  * the original, i.e. no changes occur on the final character. This requires that the input bytes use the same padding
  * and alphabet as the encoder.
  * </p>
+ *
+ * @see Base64
  * @see <a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a>
  * @since 1.4
  */

src/main/java/org/apache/commons/codec/binary/Base64OutputStream.java

@@ -57,6 +57,8 @@
  * the original, i.e. no changes occur on the final character. This requires that the input bytes use the same padding
  * and alphabet as the encoder.
  * </p>
+ *
+ * @see Base64
  * @see <a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a>
  * @since 1.4
  */

src/main/java/org/apache/commons/codec/binary/BaseNCodecInputStream.java

@@ -46,9 +46,9 @@ public class BaseNCodecInputStream extends FilterInputStream {
     /**
      * Constructs a new instance.
      *
-     * @param inputStream the input stream
-     * @param baseNCodec the codec
-     * @param doEncode set to true to perform encoding, else decoding
+     * @param inputStream the input stream.
+     * @param baseNCodec the codec.
+     * @param doEncode set to true to perform encoding, else decoding.
      */
     protected BaseNCodecInputStream(final InputStream inputStream, final BaseNCodec baseNCodec, final boolean doEncode) {
         super(inputStream);
@@ -60,8 +60,7 @@ protected BaseNCodecInputStream(final InputStream inputStream, final BaseNCodec
     /**
      * {@inheritDoc}
      *
-     * @return {@code 0} if the {@link InputStream} has reached {@code EOF},
-     * {@code 1} otherwise
+     * @return {@code 0} if the {@link InputStream} has reached {@code EOF}, {@code 1} otherwise.
      * @since 1.7
      */
     @Override
@@ -82,7 +81,7 @@ public int available() throws IOException {
      * into 8-bit bytes and discard the remainder.
      * </p>
      *
-     * @return true if using strict decoding
+     * @return true if using strict decoding.
      * @since 1.15
      */
     public boolean isStrictDecoding() {
@@ -118,8 +117,7 @@ public boolean markSupported() {
      * Reads one {@code byte} from this input stream.
      *
      * @return the byte as an integer in the range 0 to 255. Returns -1 if EOF has been reached.
-     * @throws IOException
-     *             if an I/O error occurs.
+     * @throws IOException if an I/O error occurs.
      */
     @Override
     public int read() throws IOException {
@@ -135,23 +133,15 @@ public int read() throws IOException {
     }
 
     /**
-     * Attempts to read {@code len} bytes into the specified {@code b} array starting at {@code offset}
-     * from this InputStream.
+     * Attempts to read {@code len} bytes into the specified {@code b} array starting at {@code offset} from this InputStream.
      *
-     * @param array
-     *            destination byte array
-     * @param offset
-     *            where to start writing the bytes
-     * @param len
-     *            maximum number of bytes to read
-     *
-     * @return number of bytes read
-     * @throws IOException
-     *             if an I/O error occurs.
-     * @throws NullPointerException
-     *             if the byte array parameter is null
-     * @throws IndexOutOfBoundsException
-     *             if offset, len or buffer size are invalid
+     * @param array  destination byte array.
+     * @param offset where to start writing the bytes.
+     * @param len    maximum number of bytes to read.
+     * @return number of bytes read.
+     * @throws IOException               if an I/O error occurs.
+     * @throws NullPointerException      if the byte array parameter is null.
+     * @throws IndexOutOfBoundsException if offset, len or buffer size are invalid.
      */
     @Override
     public int read(final byte[] array, final int offset, final int len) throws IOException {
@@ -207,7 +197,7 @@ public int read(final byte[] array, final int offset, final int len) throws IOEx
      * The {@link #reset} method of {@link BaseNCodecInputStream} does nothing except throw an {@link IOException}.
      * </p>
      *
-     * @throws IOException if this method is invoked
+     * @throws IOException if this method is invoked.
      * @since 1.7
      */
     @Override
@@ -218,7 +208,7 @@ public synchronized void reset() throws IOException {
     /**
      * {@inheritDoc}
      *
-     * @throws IllegalArgumentException if the provided skip length is negative
+     * @throws IllegalArgumentException if the provided skip length is negative.
      * @since 1.7
      */
     @Override