(commons-net) 02/02: 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 403986c7428a3a62ed78fc1833b7a72940a36c92
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sun Jun 16 13:21:19 2024 -0400

    Javadoc
---
 .../java/org/apache/commons/net/nntp/Article.java  | 78 +++++++++++++++++++---
 1 file changed, 67 insertions(+), 11 deletions(-)

diff --git a/src/main/java/org/apache/commons/net/nntp/Article.java 
b/src/main/java/org/apache/commons/net/nntp/Article.java
index a8638247..3e3c688a 100644
--- a/src/main/java/org/apache/commons/net/nntp/Article.java
+++ b/src/main/java/org/apache/commons/net/nntp/Article.java
@@ -24,9 +24,10 @@ import java.util.Collections;
 import org.apache.commons.net.util.NetConstants;
 
 /**
- * This is a class that contains the basic state needed for message retrieval 
and threading. With thanks to Jamie Zawinski (j...@jwz.org)
+ * Basic state needed for message retrieval and threading. With thanks to 
Jamie Zawinski (j...@jwz.org)
  */
 public class Article implements Threadable {
+
     /**
      * Recursive method that traverses a pre-threaded graph (or tree) of 
connected Article objects and prints them out.
      *
@@ -122,23 +123,48 @@ public class Article implements Threadable {
         simplifiedSubject = null;
     }
 
+    /**
+     * Gets the article ID.
+     *
+     * @return the article ID.
+     */
     public String getArticleId() {
         return articleId;
     }
 
+    /**
+     * Gets the article number.
+     *
+     * @return the article number.
+     */
     @Deprecated
     public int getArticleNumber() {
         return (int) articleNumber;
     }
 
+    /**
+     * Gets the article number.
+     *
+     * @return the article number.
+     */
     public long getArticleNumberLong() {
         return articleNumber;
     }
 
+    /**
+     * Gets the article date header.
+     *
+     * @return the article date header.
+     */
     public String getDate() {
         return date;
     }
 
+    /**
+     * Gets the article from header.
+     *
+     * @return the article from header.
+     */
     public String getFrom() {
         return from;
     }
@@ -155,6 +181,11 @@ public class Article implements Threadable {
         return references.toArray(NetConstants.EMPTY_STRING_ARRAY);
     }
 
+    /**
+     * Gets the article subject.
+     *
+     * @return the article subject.
+     */
     public String getSubject() {
         return subject;
     }
@@ -183,13 +214,23 @@ public class Article implements Threadable {
         articleId = string;
     }
 
+    /**
+     * Sets the article number.
+     *
+     * @param articleNumber  the article number.
+     */
     @Deprecated
-    public void setArticleNumber(final int a) {
-        articleNumber = a;
+    public void setArticleNumber(final int articleNumber) {
+        this.articleNumber = articleNumber;
     }
 
-    public void setArticleNumber(final long l) {
-        articleNumber = l;
+    /**
+     * Sets the article number.
+     *
+     * @param articleNumber  the article number.
+     */
+    public void setArticleNumber(final long articleNumber) {
+        this.articleNumber = articleNumber;
     }
 
     @Override
@@ -198,12 +239,22 @@ public class Article implements Threadable {
         flushSubjectCache();
     }
 
-    public void setDate(final String string) {
-        date = string;
+    /**
+     * Sets the article date header.
+     *
+     * @param date  the article date header.
+     */
+    public void setDate(final String date) {
+        this.date = date;
     }
 
-    public void setFrom(final String string) {
-        from = string;
+    /**
+     * Sets the article from header.
+     *
+     * @param from  the article from header.
+     */
+    public void setFrom(final String from) {
+        this.from = from;
     }
 
     @Override
@@ -212,8 +263,13 @@ public class Article implements Threadable {
         flushSubjectCache();
     }
 
-    public void setSubject(final String string) {
-        subject = string;
+    /**
+     * Sets the article subject.
+     *
+     * @param subject  the article subject.
+     */
+    public void setSubject(final String subject) {
+        this.subject = subject;
     }
 
     @Override