Javadoc: Empty Javadoc line before the 1st tag.

garydgregory · garydgregory · commit 66528578e202 · 2025-12-31T17:50:38.000-05:00
diff --git a/src/main/java/org/apache/commons/io/CopyUtils.java b/src/main/java/org/apache/commons/io/CopyUtils.java
@@ -117,6 +117,7 @@ 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.
diff --git a/src/main/java/org/apache/commons/io/EndianUtils.java b/src/main/java/org/apache/commons/io/EndianUtils.java
@@ -50,6 +50,7 @@ public class EndianUtils {
 
     /**
      * Reads the next byte from the input stream.
+     *
      * @param input  the stream.
      * @return the byte.
      * @throws IOException if the end of file is reached.
diff --git a/src/main/java/org/apache/commons/io/FileCleaner.java b/src/main/java/org/apache/commons/io/FileCleaner.java
@@ -63,6 +63,7 @@ public class FileCleaner {
      * in the resource cleanup code, such as
      * {@code javax.servlet.ServletContextListener.contextDestroyed(javax.servlet.ServletContextEvent)}.
      * One called, no new objects can be tracked by the file cleaner.
+     *
      * @deprecated Use {@link FileCleaningTracker#exitWhenFinished()}.
      */
     @Deprecated
diff --git a/src/main/java/org/apache/commons/io/FilenameUtils.java b/src/main/java/org/apache/commons/io/FilenameUtils.java
@@ -143,12 +143,14 @@ public class FilenameUtils {
 
     /**
      * The extension separator character.
+     *
      * @since 1.4
      */
     public static final char EXTENSION_SEPARATOR = '.';
 
     /**
      * The extension separator String.
+     *
      * @since 1.4
      */
     public static final String EXTENSION_SEPARATOR_STR = Character.toString(EXTENSION_SEPARATOR);
diff --git a/src/main/java/org/apache/commons/io/IOUtils.java b/src/main/java/org/apache/commons/io/IOUtils.java
@@ -708,6 +708,7 @@ static void checkFromToIndex(final int fromIndex, final int toIndex, final int l
      * <li>Removes the current thread's value for thread-local variables.</li>
      * <li>Sets static scratch arrays to 0s.</li>
      * </ul>
+     *
      * @see IO#clear()
      */
     static void clear() {
@@ -902,6 +903,7 @@ public static <T extends Throwable> T closeQuietly(final Closeable closeable, fi
      * <p>
      * Also consider using a try-with-resources statement where appropriate.
      * </p>
+     *
      * @param closeables the objects to close, may be null or already closed.
      * @see #closeQuietly(Closeable)
      * @since 2.5
diff --git a/src/main/java/org/apache/commons/io/LineIterator.java b/src/main/java/org/apache/commons/io/LineIterator.java
@@ -142,6 +142,7 @@ public boolean hasNext() {
     /**
      * Overridable method to validate each line that is returned.
      * This implementation always returns true.
+     *
      * @param line  the line that is to be validated.
      * @return true if valid, false to remove from the iterator.
      */
diff --git a/src/main/java/org/apache/commons/io/UncheckedIOExceptions.java b/src/main/java/org/apache/commons/io/UncheckedIOExceptions.java
@@ -47,6 +47,7 @@ public static UncheckedIOException create(final Object message) {
      * <p>
      * This method exists because there is no String constructor in {@link UncheckedIOException}.
      * </p>
+     *
      * @param e cause the {@link IOException}.
      * @param message the detail message.
      * @return a new {@link UncheckedIOException}.
diff --git a/src/main/java/org/apache/commons/io/comparator/PathFileComparator.java b/src/main/java/org/apache/commons/io/comparator/PathFileComparator.java
@@ -51,6 +51,7 @@
  * <p>
  * <em>Serialization is deprecated and will be removed in 3.0.</em>
  * </p>
+ *
  * @since 1.4
  */
 public class PathFileComparator extends AbstractFileComparator implements Serializable {
diff --git a/src/main/java/org/apache/commons/io/filefilter/AndFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/AndFileFilter.java
@@ -129,6 +129,7 @@ public boolean accept(final File file, final String name) {
 
     /**
      * {@inheritDoc}
+     *
      * @since 2.9.0
      */
     @Override
diff --git a/src/main/java/org/apache/commons/io/filefilter/FileFilterUtils.java b/src/main/java/org/apache/commons/io/filefilter/FileFilterUtils.java
@@ -226,13 +226,13 @@ public static IOFileFilter fileFileFilter() {
      * Set&lt;File&gt; javaFiles = FileFilterUtils.filterSet(allFiles,
      *     FileFilterUtils.suffixFileFilter(".java"));
      * </pre>
+     *
      * @param filter the filter to apply to the set of files.
      * @param files the array of files to apply the filter to.
      * @return a subset of {@code files} that is accepted by the
      *         file filter.
      * @throws NullPointerException if the filter is {@code null}
      *         or {@code files} contains a {@code null} value.
-     *
      * @since 2.0
      */
     public static File[] filter(final IOFileFilter filter, final File... files) {
@@ -259,13 +259,13 @@ public static File[] filter(final IOFileFilter filter, final File... files) {
      * Set&lt;File&gt; javaFiles = FileFilterUtils.filterSet(allFiles,
      *     FileFilterUtils.suffixFileFilter(".java"));
      * </pre>
+     *
      * @param filter the filter to apply to the set of files.
      * @param files the array of files to apply the filter to.
      * @return a subset of {@code files} that is accepted by the
      *         file filter.
      * @throws IllegalArgumentException if the filter is {@code null}
      *         or {@code files} contains a {@code null} value.
-     *
      * @since 2.0
      */
     public static File[] filter(final IOFileFilter filter, final Iterable<File> files) {
@@ -311,6 +311,7 @@ private static <R, A> R filterFiles(final IOFileFilter filter, final Stream<File
      * List&lt;File&gt; directories = FileFilterUtils.filterList(filesAndDirectories,
      *     FileFilterUtils.directoryFileFilter());
      * </pre>
+     *
      * @param filter the filter to apply to each files in the list.
      * @param files the collection of files to apply the filter to.
      * @return a subset of {@code files} that is accepted by the
@@ -339,6 +340,7 @@ public static List<File> filterList(final IOFileFilter filter, final File... fil
      * List&lt;File&gt; directories = FileFilterUtils.filterList(filesAndDirectories,
      *     FileFilterUtils.directoryFileFilter());
      * </pre>
+     *
      * @param filter the filter to apply to each files in the list.
      * @param files the collection of files to apply the filter to.
      * @return a subset of {@code files} that is accepted by the
@@ -369,6 +371,7 @@ public static List<File> filterList(final IOFileFilter filter, final Iterable<Fi
      * Set&lt;File&gt; javaFiles = FileFilterUtils.filterSet(allFiles,
      *     FileFilterUtils.suffixFileFilter(".java"));
      * </pre>
+     *
      * @param filter the filter to apply to the set of files.
      * @param files the collection of files to apply the filter to.
      * @return a subset of {@code files} that is accepted by the
@@ -398,6 +401,7 @@ public static Set<File> filterSet(final IOFileFilter filter, final File... files
      * Set&lt;File&gt; javaFiles = FileFilterUtils.filterSet(allFiles,
      *     FileFilterUtils.suffixFileFilter(".java"));
      * </pre>
+     *
      * @param filter the filter to apply to the set of files.
      * @param files the collection of files to apply the filter to.
      * @return a subset of {@code files} that is accepted by the
diff --git a/src/main/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java
@@ -270,6 +270,7 @@ public boolean accept(final File file) {
      * be rejected.
      *
      * </p>
+     *
      * @param file the file to accept or reject.
      * @param attributes the path's basic attributes (may be null).
      * @return {@code true} if the file contains the filter's magic number
diff --git a/src/main/java/org/apache/commons/io/filefilter/OrFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/OrFileFilter.java
@@ -76,6 +76,7 @@ private OrFileFilter(final int initialCapacity) {
 
     /**
      * Constructs a new instance for the give filters.
+     *
      * @param fileFilters filters to OR.
      * @since 2.9.0
      */
diff --git a/src/main/java/org/apache/commons/io/function/IOIterable.java b/src/main/java/org/apache/commons/io/function/IOIterable.java
@@ -75,6 +75,7 @@ default IOSpliterator<T> spliterator() {
      * <p>
      * Implementations may not have anything to unwrap and that behavior is undefined for now.
      * </p>
+     *
      * @return the underlying Iterable.
      */
     Iterable<T> unwrap();
diff --git a/src/main/java/org/apache/commons/io/function/IOIterator.java b/src/main/java/org/apache/commons/io/function/IOIterator.java
@@ -110,6 +110,7 @@ default void remove() throws IOException {
      * <p>
      * Implementations may not have anything to unwrap and that behavior is undefined for now.
      * </p>
+     *
      * @return the underlying Iterator.
      */
     Iterator<E> unwrap();
diff --git a/src/main/java/org/apache/commons/io/input/BoundedInputStream.java b/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
@@ -82,6 +82,7 @@
  *   .get();
  * }
  * </pre>
+ *
  * @see Builder
  * @since 2.0
  */
diff --git a/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java b/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
@@ -281,6 +281,7 @@ CharsetEncoder getCharsetEncoder() {
 
     /**
      * {@inheritDoc}
+     *
      * @param readLimit max read limit (ignored).
      */
     @Override
diff --git a/src/main/java/org/apache/commons/io/input/ProxyReader.java b/src/main/java/org/apache/commons/io/input/ProxyReader.java
@@ -94,6 +94,7 @@ protected void beforeRead(final int n) throws IOException {
 
     /**
      * Invokes the delegate's {@code close()} method.
+     *
      * @throws IOException if an I/O error occurs.
      */
     @Override
@@ -122,6 +123,7 @@ protected void handleIOException(final IOException e) throws IOException {
 
     /**
      * Invokes the delegate's {@code mark(int)} method.
+     *
      * @param readAheadLimit read ahead limit.
      * @throws IOException if an I/O error occurs.
      */
@@ -136,6 +138,7 @@ public synchronized void mark(final int readAheadLimit) throws IOException {
 
     /**
      * Invokes the delegate's {@code markSupported()} method.
+     *
      * @return true if mark is supported, otherwise false.
      */
     @Override
@@ -145,6 +148,7 @@ public boolean markSupported() {
 
     /**
      * Invokes the delegate's {@code read()} method.
+     *
      * @return the character read or -1 if the end of stream.
      * @throws IOException if an I/O error occurs.
      */
@@ -163,6 +167,7 @@ public int read() throws IOException {
 
     /**
      * Invokes the delegate's {@code read(char[])} method.
+     *
      * @param chr the buffer to read the characters into.
      * @return the number of characters read or -1 if the end of stream.
      * @throws IOException if an I/O error occurs.
@@ -182,6 +187,7 @@ public int read(final char[] chr) throws IOException {
 
     /**
      * Invokes the delegate's {@code read(char[], int, int)} method.
+     *
      * @param chr the buffer to read the characters into.
      * @param st The start offset.
      * @param len The number of bytes to read.
@@ -203,6 +209,7 @@ public int read(final char[] chr, final int st, final int len) throws IOExceptio
 
     /**
      * Invokes the delegate's {@code read(CharBuffer)} method.
+     *
      * @param target the char buffer to read the characters into.
      * @return the number of characters read or -1 if the end of stream.
      * @throws IOException if an I/O error occurs.
@@ -223,6 +230,7 @@ public int read(final CharBuffer target) throws IOException {
 
     /**
      * Invokes the delegate's {@code ready()} method.
+     *
      * @return true if the stream is ready to be read.
      * @throws IOException if an I/O error occurs.
      */
@@ -238,6 +246,7 @@ public boolean ready() throws IOException {
 
     /**
      * Invokes the delegate's {@code reset()} method.
+     *
      * @throws IOException if an I/O error occurs.
      */
     @Override
@@ -251,6 +260,7 @@ public synchronized void reset() throws IOException {
 
     /**
      * Invokes the delegate's {@code skip(long)} method.
+     *
      * @param ln the number of bytes to skip.
      * @return the number of bytes to skipped or EOF if the end of stream.
      * @throws IOException if an I/O error occurs.
diff --git a/src/main/java/org/apache/commons/io/input/UnixLineEndingInputStream.java b/src/main/java/org/apache/commons/io/input/UnixLineEndingInputStream.java
@@ -53,6 +53,7 @@ public UnixLineEndingInputStream(final InputStream inputStream, final boolean en
 
     /**
      * Closes the stream. Also closes the underlying stream.
+     *
      * @throws IOException If an I/O error occurs.
      */
     @Override
@@ -112,6 +113,7 @@ public synchronized int read() throws IOException {
 
     /**
      * Reads the next item from the target, updating internal flags in the process
+     *
      * @return the next int read from the target stream.
      * @throws IOException If an I/O error occurs.
      */
diff --git a/src/main/java/org/apache/commons/io/input/XmlStreamReader.java b/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
@@ -695,6 +695,7 @@ public XmlStreamReader(final URLConnection urlConnection, final String defaultEn
 
     /**
      * Calculates the HTTP encoding.
+     *
      * @param bomEnc          BOM encoding.
      * @param xmlGuessEnc     XML Guess encoding.
      * @param xmlEnc          XML encoding.
diff --git a/src/main/java/org/apache/commons/io/monitor/FileEntry.java b/src/main/java/org/apache/commons/io/monitor/FileEntry.java
@@ -48,6 +48,7 @@
  * <p>
  * <em>Serialization is deprecated and will be removed in 3.0.</em>
  * </p>
+ *
  * @see FileAlterationObserver
  * @since 2.0
  */
diff --git a/src/main/java/org/apache/commons/io/output/ProxyWriter.java b/src/main/java/org/apache/commons/io/output/ProxyWriter.java
@@ -144,6 +144,7 @@ protected void beforeWrite(final int n) throws IOException {
 
     /**
      * Invokes the delegate's {@code close()} method.
+     *
      * @throws IOException if an I/O error occurs.
      */
     @Override
@@ -153,6 +154,7 @@ public void close() throws IOException {
 
     /**
      * Invokes the delegate's {@code flush()} method.
+     *
      * @throws IOException if an I/O error occurs.
      */
     @Override
diff --git a/src/main/java/org/apache/commons/io/output/UnsynchronizedByteArrayOutputStream.java b/src/main/java/org/apache/commons/io/output/UnsynchronizedByteArrayOutputStream.java
@@ -157,6 +157,7 @@ public static InputStream toBufferedInputStream(final InputStream input, final i
      * Constructs a new byte array output stream. The buffer capacity is initially.
      *
      * {@value AbstractByteArrayOutputStream#DEFAULT_SIZE} bytes, though its size increases if necessary.
+     *
      * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
      */
     @Deprecated
