[commons-cli] branch master updated: 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-cli.git


The following commit(s) were added to refs/heads/master by this push:
     new 3790cec  Javadoc
3790cec is described below

commit 3790cec2dbc27f66f4518dcf311cbd70d9e2140b
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Wed Aug 16 07:20:54 2023 -0400

    Javadoc
---
 src/main/java/org/apache/commons/cli/CommandLine.java |  5 +++++
 src/main/java/org/apache/commons/cli/Parser.java      | 15 +++++++++++++++
 2 files changed, 20 insertions(+)

diff --git a/src/main/java/org/apache/commons/cli/CommandLine.java 
b/src/main/java/org/apache/commons/cli/CommandLine.java
index 0d0b9f5..cea5b93 100644
--- a/src/main/java/org/apache/commons/cli/CommandLine.java
+++ b/src/main/java/org/apache/commons/cli/CommandLine.java
@@ -72,6 +72,11 @@ public class CommandLine implements Serializable {
             return this;
         }
 
+        /**
+         * Returns the new instance.
+         *
+         * @return the new instance.
+         */
         public CommandLine build() {
             return commandLine;
         }
diff --git a/src/main/java/org/apache/commons/cli/Parser.java 
b/src/main/java/org/apache/commons/cli/Parser.java
index 8543d9c..22d9f0a 100644
--- a/src/main/java/org/apache/commons/cli/Parser.java
+++ b/src/main/java/org/apache/commons/cli/Parser.java
@@ -63,10 +63,20 @@ public abstract class Parser implements CommandLineParser {
      */
     protected abstract String[] flatten(Options opts, String[] arguments, 
boolean stopAtNonOption) throws ParseException;
 
+    /**
+     * Gets the options.
+     *
+     * @return the options.
+     */
     protected Options getOptions() {
         return options;
     }
 
+    /**
+     * Gets the required options.
+     *
+     * @return the required options.
+     */
     protected List getRequiredOptions() {
         return requiredOptions;
     }
@@ -326,6 +336,11 @@ public abstract class Parser implements CommandLineParser {
         }
     }
 
+    /**
+     * Sets the options.
+     *
+     * @param options the options.
+     */
     protected void setOptions(final Options options) {
         this.options = options;
         this.requiredOptions = new ArrayList<>(options.getRequiredOptions());