This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-io.git
The following commit(s) were added to refs/heads/master by this push:
new c2e18c6d0 Javadoc @since tag should be after @return and @throws
c2e18c6d0 is described below
commit c2e18c6d02f07c7466b29caeb5ac94aa04c4957d
Author: Gary D. Gregory <garydgreg...@gmail.com>
AuthorDate: Sat Mar 22 09:36:59 2025 -0400
Javadoc @since tag should be after @return and @throws
---
src/main/java/org/apache/commons/io/input/ProxyInputStream.java | 2 +-
src/main/java/org/apache/commons/io/input/ProxyReader.java | 4 ++--
src/main/java/org/apache/commons/io/output/ProxyOutputStream.java | 4 ++--
src/main/java/org/apache/commons/io/output/ProxyWriter.java | 4 ++--
4 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
b/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
index e8e3d29f5..85291fd33 100644
--- a/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
@@ -204,9 +204,9 @@ public int available() throws IOException {
* you want to add pre-processing steps also to them.
* </p>
*
- * @since 2.0
* @param n number of bytes that the caller asked to be read.
* @throws IOException if the pre-processing fails in a subclass.
+ * @since 2.0
*/
@SuppressWarnings("unused") // Possibly thrown from subclasses.
protected void beforeRead(final int n) throws IOException {
diff --git a/src/main/java/org/apache/commons/io/input/ProxyReader.java
b/src/main/java/org/apache/commons/io/input/ProxyReader.java
index 8873d2fda..4228a984b 100644
--- a/src/main/java/org/apache/commons/io/input/ProxyReader.java
+++ b/src/main/java/org/apache/commons/io/input/ProxyReader.java
@@ -60,9 +60,9 @@ public ProxyReader(final Reader delegate) {
* {@link #reset()}. You need to explicitly override those methods if
* you want to add post-processing steps also to them.
*
- * @since 2.0
* @param n number of chars read, or -1 if the end of stream was reached
* @throws IOException if the post-processing fails
+ * @since 2.0
*/
@SuppressWarnings("unused") // Possibly thrown from subclasses.
protected void afterRead(final int n) throws IOException {
@@ -83,9 +83,9 @@ protected void afterRead(final int n) throws IOException {
* {@link #reset()}. You need to explicitly override those methods if
* you want to add pre-processing steps also to them.
*
- * @since 2.0
* @param n number of chars that the caller asked to be read
* @throws IOException if the pre-processing fails
+ * @since 2.0
*/
@SuppressWarnings("unused") // Possibly thrown from subclasses.
protected void beforeRead(final int n) throws IOException {
diff --git a/src/main/java/org/apache/commons/io/output/ProxyOutputStream.java
b/src/main/java/org/apache/commons/io/output/ProxyOutputStream.java
index 733421feb..1be01a424 100644
--- a/src/main/java/org/apache/commons/io/output/ProxyOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/ProxyOutputStream.java
@@ -96,9 +96,9 @@ public ProxyOutputStream(final OutputStream delegate) {
* functionality without having to override all the write methods.
* The default implementation does nothing.
*
- * @since 2.0
* @param n number of bytes written
* @throws IOException if the post-processing fails
+ * @since 2.0
*/
@SuppressWarnings("unused") // Possibly thrown from subclasses.
protected void afterWrite(final int n) throws IOException {
@@ -114,9 +114,9 @@ protected void afterWrite(final int n) throws IOException {
* functionality without having to override all the write methods.
* The default implementation does nothing.
*
- * @since 2.0
* @param n number of bytes to be written
* @throws IOException if the pre-processing fails
+ * @since 2.0
*/
@SuppressWarnings("unused") // Possibly thrown from subclasses.
protected void beforeWrite(final int n) throws IOException {
diff --git a/src/main/java/org/apache/commons/io/output/ProxyWriter.java
b/src/main/java/org/apache/commons/io/output/ProxyWriter.java
index 2d56afb68..1a44e50c5 100644
--- a/src/main/java/org/apache/commons/io/output/ProxyWriter.java
+++ b/src/main/java/org/apache/commons/io/output/ProxyWriter.java
@@ -51,9 +51,9 @@ public ProxyWriter(final Writer delegate) {
* The default implementation does nothing.
* </p>
*
- * @since 2.0
* @param n number of chars written
* @throws IOException if the post-processing fails
+ * @since 2.0
*/
@SuppressWarnings("unused") // Possibly thrown from subclasses.
protected void afterWrite(final int n) throws IOException {
@@ -130,9 +130,9 @@ public Writer append(final CharSequence csq, final int
start, final int end) thr
* The default implementation does nothing.
* </p>
*
- * @since 2.0
* @param n number of chars to be written
* @throws IOException if the pre-processing fails
+ * @since 2.0
*/
@SuppressWarnings("unused") // Possibly thrown from subclasses.
protected void beforeWrite(final int n) throws IOException {
