(commons-net) 05/11: Javadoc

[ggregory]

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-net.git

commit 6b3a6f5fdb47e343bb64ae2a11938be0ff7e7a77
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sun Jun 16 18:27:59 2024 -0400

    Javadoc
---
 src/main/java/org/apache/commons/net/ProtocolCommandSupport.java | 6 ++++++
 src/main/java/org/apache/commons/net/ftp/FTPFile.java            | 6 ++++++
 src/main/java/org/apache/commons/net/ntp/TimeStamp.java          | 6 ++++++
 src/main/java/org/apache/commons/net/util/ListenerList.java      | 9 +++++++--
 4 files changed, 25 insertions(+), 2 deletions(-)

diff --git a/src/main/java/org/apache/commons/net/ProtocolCommandSupport.java 
b/src/main/java/org/apache/commons/net/ProtocolCommandSupport.java
index 6d1dd30e..7340befc 100644
--- a/src/main/java/org/apache/commons/net/ProtocolCommandSupport.java
+++ b/src/main/java/org/apache/commons/net/ProtocolCommandSupport.java
@@ -119,6 +119,12 @@ public class ProtocolCommandSupport implements 
Serializable {
         listeners.removeListener(listener);
     }
 
+    /**
+     * Always throws {@link UnsupportedOperationException}.
+     *
+     * @param ignored ignored.
+     * @throws UnsupportedOperationException Always thrown.
+     */
     private void writeObject(final ObjectOutputStream ignored) {
         throw new UnsupportedOperationException("Serialization is not 
supported");
     }
diff --git a/src/main/java/org/apache/commons/net/ftp/FTPFile.java 
b/src/main/java/org/apache/commons/net/ftp/FTPFile.java
index a143e787..25b45499 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPFile.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPFile.java
@@ -478,6 +478,12 @@ public class FTPFile implements Serializable {
         return getRawListing();
     }
 
+    /**
+     * Always throws {@link UnsupportedOperationException}.
+     *
+     * @param ignored ignored.
+     * @throws UnsupportedOperationException Always thrown.
+     */
     private void writeObject(final ObjectOutputStream ignored) {
         throw new UnsupportedOperationException("Serialization is not 
supported");
     }
diff --git a/src/main/java/org/apache/commons/net/ntp/TimeStamp.java 
b/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
index 3ff31089..24286075 100644
--- a/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
+++ b/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
@@ -403,6 +403,12 @@ public class TimeStamp implements Serializable, 
Comparable<TimeStamp> {
         return utcFormatter.format(ntpDate);
     }
 
+    /**
+     * Always throws {@link UnsupportedOperationException}.
+     *
+     * @param ignored ignored.
+     * @throws UnsupportedOperationException Always thrown.
+     */
     private void writeObject(final ObjectOutputStream ignored) {
         throw new UnsupportedOperationException("Serialization is not 
supported");
     }
diff --git a/src/main/java/org/apache/commons/net/util/ListenerList.java 
b/src/main/java/org/apache/commons/net/util/ListenerList.java
index 96cc3e4d..9ac933e2 100644
--- a/src/main/java/org/apache/commons/net/util/ListenerList.java
+++ b/src/main/java/org/apache/commons/net/util/ListenerList.java
@@ -59,14 +59,19 @@ public class ListenerList implements Serializable, 
Iterable<EventListener> {
         throw new UnsupportedOperationException("Serialization is not 
supported");
     }
 
-    /*
+    /**
      * Serialization is unnecessary for this class. Reject attempts to do so 
until such time as the Serializable attribute can be dropped.
      */
-
     public void removeListener(final EventListener listener) {
         listeners.remove(listener);
     }
 
+    /**
+     * Always throws {@link UnsupportedOperationException}.
+     *
+     * @param ignored ignored.
+     * @throws UnsupportedOperationException Always thrown.
+     */
     private void writeObject(final ObjectOutputStream ignored) {
         throw new UnsupportedOperationException("Serialization is not 
supported");
     }