Fix deprecation comments and end sentence with a period

- Add missing comment.
- Close HTML tags.
- Typos

Author: garydgregory

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

@@ -128,10 +128,10 @@ public class ByteOrderMark implements Serializable {
     /**
      * Constructs a new instance.
      *
-     * @param charsetName The name of the charset the BOM represents
-     * @param bytes The BOM's bytes
-     * @throws IllegalArgumentException if the charsetName is zero length
-     * @throws IllegalArgumentException if the bytes are zero length
+     * @param charsetName The name of the charset the BOM represents.
+     * @param bytes The BOM's bytes.
+     * @throws IllegalArgumentException if the charsetName is zero length.
+     * @throws IllegalArgumentException if the bytes are zero length.
      */
     public ByteOrderMark(final String charsetName, final int... bytes) {
         Objects.requireNonNull(charsetName, "charsetName");
@@ -149,9 +149,9 @@ public ByteOrderMark(final String charsetName, final int... bytes) {
     /**
      * Indicates if this instance's bytes equals another.
      *
-     * @param obj The object to compare to
+     * @param obj The object to compare to.
      * @return true if the bom's bytes are equal, otherwise
-     * false
+     * false.
      */
     @Override
     public boolean equals(final Object obj) {
@@ -173,8 +173,8 @@ public boolean equals(final Object obj) {
     /**
      * Gets the byte at the specified position.
      *
-     * @param pos The position
-     * @return The specified byte
+     * @param pos The position.
+     * @return The specified byte.
      */
     public int get(final int pos) {
         return bytes[pos];
@@ -183,7 +183,7 @@ public int get(final int pos) {
     /**
      * Gets a copy of the BOM's bytes.
      *
-     * @return a copy of the BOM's bytes
+     * @return a copy of the BOM's bytes.
      */
     public byte[] getBytes() {
         final byte[] copy = IOUtils.byteArray(bytes.length);
@@ -196,7 +196,7 @@ public byte[] getBytes() {
     /**
      * Gets the name of the {@link java.nio.charset.Charset} the BOM represents.
      *
-     * @return the character set name
+     * @return the character set name.
      */
     public String getCharsetName() {
         return charsetName;
@@ -224,7 +224,7 @@ public int hashCode() {
     /**
      * Gets the length of the BOM's bytes.
      *
-     * @return the length of the BOM's bytes
+     * @return the length of the BOM's bytes.
      */
     public int length() {
         return bytes.length;
@@ -260,7 +260,7 @@ public boolean matches(final int[] test) {
     /**
      * Converts this instance to a String representation of the BOM.
      *
-     * @return the length of the BOM's bytes
+     * @return the length of the BOM's bytes.
      */
     @Override
     public String toString() {

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

@@ -41,8 +41,8 @@ public final class ByteOrderParser {
      * </ul>
      *
      * @param value
-     *            the {@link String} containing the ByteOrder representation to be parsed
-     * @return the ByteOrder represented by the string argument
+     *            the {@link String} containing the ByteOrder representation to be parsed.
+     * @return the ByteOrder represented by the string argument.
      * @throws IllegalArgumentException
      *             if the {@link String} containing the ByteOrder representation to be parsed is unknown.
      */

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

@@ -210,7 +210,7 @@ public static SortedMap<String, Charset> requiredCharsets() {
      *
      * @param charset
      *            A charset or null.
-     * @return the given Charset or the default Charset if the given Charset is null
+     * @return the given Charset or the default Charset if the given Charset is null.
      * @see Charset#defaultCharset()
      */
     public static Charset toCharset(final Charset charset) {
@@ -277,7 +277,7 @@ public static Charset toCharsetDefault(final String charsetName, final Charset d
     /**
      * Construct a new instance.
      *
-     * @deprecated Will be private in 4.0
+     * @deprecated Will be private in 3.0.
      */
     @Deprecated
     public Charsets() {

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

@@ -117,9 +117,9 @@ public class CopyUtils {
 
     /**
      * Copies bytes from a {@code byte[]} to an {@link OutputStream}.
-     * @param input the byte array to read from
-     * @param output the {@link OutputStream} to write to
-     * @throws IOException In case of an I/O problem
+     * @param input the byte array to read from.
+     * @param output the {@link OutputStream} to write to.
+     * @throws IOException In case of an I/O problem.
      */
     public static void copy(final byte[] input, final OutputStream output) throws IOException {
         output.write(input);
@@ -130,10 +130,10 @@ public static void copy(final byte[] input, final OutputStream output) throws IO
      * {@link Writer}.
      * The platform's default encoding is used for the byte-to-char conversion.
      *
-     * @param input the byte array to read from
-     * @param output the {@link Writer} to write to
-     * @throws IOException In case of an I/O problem
-     * @deprecated Use {@link #copy(byte[], Writer, String)} instead
+     * @param input the byte array to read from.
+     * @param output the {@link Writer} to write to.
+     * @throws IOException In case of an I/O problem.
+     * @deprecated Use {@link #copy(byte[], Writer, String)} instead.
      */
     @Deprecated
     public static void copy(final byte[] input, final Writer output) throws IOException {
@@ -145,12 +145,12 @@ public static void copy(final byte[] input, final Writer output) throws IOExcept
      * Copies and convert bytes from a {@code byte[]} to chars on a
      * {@link Writer}, using the specified encoding.
      *
-     * @param input the byte array to read from
-     * @param output the {@link Writer} to write to
+     * @param input the byte array to read from.
+     * @param output the {@link Writer} to write to.
      * @param encoding The name of a supported character encoding. See the
      * <a href="https://www.iana.org/assignments/character-sets">IANA
      * Charset Registry</a> for a list of valid encoding types.
-     * @throws IOException In case of an I/O problem
+     * @throws IOException In case of an I/O problem.
      */
     public static void copy(final byte[] input, final Writer output, final String encoding) throws IOException {
         final ByteArrayInputStream inputStream = new ByteArrayInputStream(input);
@@ -161,10 +161,10 @@ public static void copy(final byte[] input, final Writer output, final String en
      * Copies bytes from an {@link InputStream} to an
      * {@link OutputStream}.
      *
-     * @param input the {@link InputStream} to read from
-     * @param output the {@link OutputStream} to write to
-     * @return the number of bytes copied
-     * @throws IOException In case of an I/O problem
+     * @param input the {@link InputStream} to read from.
+     * @param output the {@link OutputStream} to write to.
+     * @return the number of bytes copied.
+     * @throws IOException In case of an I/O problem.
      */
     public static int copy(final InputStream input, final OutputStream output) throws IOException {
         final byte[] buffer = IOUtils.byteArray();
@@ -184,10 +184,10 @@ public static int copy(final InputStream input, final OutputStream output) throw
      * This method uses the virtual machine's {@linkplain Charset#defaultCharset() default charset} for byte-to-char conversion.
      * </p>
      *
-     * @param input the {@link InputStream} to read from
-     * @param output the {@link Writer} to write to
-     * @throws IOException In case of an I/O problem
-     * @deprecated Use {@link #copy(InputStream, Writer, String)} instead
+     * @param input the {@link InputStream} to read from.
+     * @param output the {@link Writer} to write to.
+     * @throws IOException In case of an I/O problem.
+     * @deprecated Use {@link #copy(InputStream, Writer, String)} instead.
      */
     @Deprecated
     public static void copy(
@@ -203,12 +203,12 @@ public static void copy(
      * Copies and convert bytes from an {@link InputStream} to chars on a
      * {@link Writer}, using the specified encoding.
      *
-     * @param input the {@link InputStream} to read from
-     * @param output the {@link Writer} to write to
+     * @param input the {@link InputStream} to read from.
+     * @param output the {@link Writer} to write to.
      * @param encoding The name of a supported character encoding. See the
      * <a href="https://www.iana.org/assignments/character-sets">IANA
      * Charset Registry</a> for a list of valid encoding types.
-     * @throws IOException In case of an I/O problem
+     * @throws IOException In case of an I/O problem.
      */
     public static void copy(
             final InputStream input,
@@ -226,10 +226,10 @@ public static void copy(
      * This method uses the virtual machine's {@linkplain Charset#defaultCharset() default charset} for byte-to-char conversion.
      * </p>
      *
-     * @param input the {@link Reader} to read from
-     * @param output the {@link OutputStream} to write to
-     * @throws IOException In case of an I/O problem
-     * @deprecated Use {@link #copy(Reader, OutputStream, String)} instead
+     * @param input the {@link Reader} to read from.
+     * @param output the {@link OutputStream} to write to.
+     * @throws IOException In case of an I/O problem.
+     * @deprecated Use {@link #copy(Reader, OutputStream, String)} instead.
      */
     @Deprecated
     public static void copy(
@@ -248,12 +248,12 @@ public static void copy(
      * Serialize chars from a {@link Reader} to bytes on an
      * {@link OutputStream}, and flush the {@link OutputStream}.
      *
-     * @param input the {@link Reader} to read from
-     * @param output the {@link OutputStream} to write to
+     * @param input the {@link Reader} to read from.
+     * @param output the {@link OutputStream} to write to.
      * @param encoding The name of a supported character encoding. See the
      * <a href="https://www.iana.org/assignments/character-sets">IANA
      * Charset Registry</a> for a list of valid encoding types.
-     * @throws IOException In case of an I/O problem
+     * @throws IOException In case of an I/O problem.
      * @since 2.5
      */
     public static void copy(
@@ -271,10 +271,10 @@ public static void copy(
     /**
      * Copies chars from a {@link Reader} to a {@link Writer}.
      *
-     * @param input the {@link Reader} to read from
-     * @param output the {@link Writer} to write to
-     * @return the number of characters copied
-     * @throws IOException In case of an I/O problem
+     * @param input the {@link Reader} to read from.
+     * @param output the {@link Writer} to write to.
+     * @return the number of characters copied.
+     * @throws IOException In case of an I/O problem.
      */
     public static int copy(
             final Reader input,
@@ -300,10 +300,10 @@ public static int copy(
      * This method uses the virtual machine's {@linkplain Charset#defaultCharset() default charset} for byte-to-char conversion.
      * </p>
      *
-     * @param input the {@link String} to read from
-     * @param output the {@link OutputStream} to write to
-     * @throws IOException In case of an I/O problem
-     * @deprecated Use {@link #copy(String, OutputStream, String)} instead
+     * @param input the {@link String} to read from.
+     * @param output the {@link OutputStream} to write to.
+     * @throws IOException In case of an I/O problem.
+     * @deprecated Use {@link #copy(String, OutputStream, String)} instead.
      */
     @Deprecated
     public static void copy(
@@ -324,12 +324,12 @@ public static void copy(
      * {@link OutputStream}, and
      * flush the {@link OutputStream}.
      *
-     * @param input the {@link String} to read from
-     * @param output the {@link OutputStream} to write to
+     * @param input the {@link String} to read from.
+     * @param output the {@link OutputStream} to write to.
      * @param encoding The name of a supported character encoding. See the
      * <a href="https://www.iana.org/assignments/character-sets">IANA
      * Charset Registry</a> for a list of valid encoding types.
-     * @throws IOException In case of an I/O problem
+     * @throws IOException In case of an I/O problem.
      * @since 2.5
      */
     public static void copy(
@@ -348,9 +348,9 @@ public static void copy(
     /**
      * Copies chars from a {@link String} to a {@link Writer}.
      *
-     * @param input the {@link String} to read from
-     * @param output the {@link Writer} to write to
-     * @throws IOException In case of an I/O problem
+     * @param input the {@link String} to read from.
+     * @param output the {@link Writer} to write to.
+     * @throws IOException In case of an I/O problem.
      */
     public static void copy(final String input, final Writer output)
                 throws IOException {