Normalize Javadoc for getters.

Author: garydgregory

src/main/java/org/apache/commons/cli/AmbiguousOptionException.java

@@ -72,7 +72,7 @@ public AmbiguousOptionException(final String option, final Collection<String> ma
     }
 
     /**
-     * Returns the options matching the partial name.
+     * Gets the options matching the partial name.
      *
      * @return a collection of options matching the name
      */

src/main/java/org/apache/commons/cli/CommandLine.java

@@ -218,7 +218,7 @@ public Properties getOptionProperties(final String opt) {
     }
 
     /**
-     * Returns an array of the processed {@link Option}s.
+     * Gets an array of the processed {@link Option}s.
      *
      * @return an array of the processed {@link Option}s.
      */

src/main/java/org/apache/commons/cli/DefaultParser.java

@@ -146,7 +146,7 @@ private String getLongPrefix(final String token) {
     }
 
     /**
-     * Returns a list of matching option strings for the given token, depending on the selected partial matching policy.
+     * Gets a list of matching option strings for the given token, depending on the selected partial matching policy.
      *
      * @param token the token (may contain leading dashes)
      * @return the list of matching option strings or an empty list if no matching option could be found

src/main/java/org/apache/commons/cli/HelpFormatter.java

@@ -312,7 +312,7 @@ protected int findWrapPos(final String text, final int width, final int startPos
     }
 
     /**
-     * Returns the 'argName'.
+     * Gets the 'argName'.
      *
      * @return the 'argName'
      */
@@ -321,7 +321,7 @@ public String getArgName() {
     }
 
     /**
-     * Returns the 'descPadding'.
+     * Gets the 'descPadding'.
      *
      * @return the 'descPadding'
      */
@@ -330,7 +330,7 @@ public int getDescPadding() {
     }
 
     /**
-     * Returns the 'leftPadding'.
+     * Gets the 'leftPadding'.
      *
      * @return the 'leftPadding'
      */
@@ -339,7 +339,7 @@ public int getLeftPadding() {
     }
 
     /**
-     * Returns the 'longOptPrefix'.
+     * Gets the 'longOptPrefix'.
      *
      * @return the 'longOptPrefix'
      */
@@ -348,7 +348,7 @@ public String getLongOptPrefix() {
     }
 
     /**
-     * Returns the separator displayed between a long option and its value.
+     * Gets the separator displayed between a long option and its value.
      *
      * @return the separator
      * @since 1.3
@@ -358,7 +358,7 @@ public String getLongOptSeparator() {
     }
 
     /**
-     * Returns the 'newLine'.
+     * Gets the 'newLine'.
      *
      * @return the 'newLine'
      */
@@ -378,7 +378,7 @@ public Comparator<Option> getOptionComparator() {
     }
 
     /**
-     * Returns the 'optPrefix'.
+     * Gets the 'optPrefix'.
      *
      * @return the 'optPrefix'
      */
@@ -387,7 +387,7 @@ public String getOptPrefix() {
     }
 
     /**
-     * Returns the 'syntaxPrefix'.
+     * Gets the 'syntaxPrefix'.
      *
      * @return the 'syntaxPrefix'
      */
@@ -396,7 +396,7 @@ public String getSyntaxPrefix() {
     }
 
     /**
-     * Returns the 'width'.
+     * Gets the 'width'.
      *
      * @return the 'width'
      */

src/main/java/org/apache/commons/cli/MissingOptionException.java

@@ -73,7 +73,7 @@ public MissingOptionException(final String message) {
     }
 
     /**
-     * Returns the list of options or option groups missing in the command line parsed.
+     * Gets the list of options or option groups missing in the command line parsed.
      *
      * @return the missing options, consisting of String instances for simple options, and OptionGroup instances for
      *         required option groups.

src/main/java/org/apache/commons/cli/Option.java

@@ -493,7 +493,7 @@ public String getArgName() {
     }
 
     /**
-     * Returns the number of argument values this Option can take.
+     * Gets the number of argument values this Option can take.
      *
      * <p>
      * A value equal to the constant {@link #UNINITIALIZED} (= -1) indicates the number of arguments has not been specified.
@@ -510,7 +510,7 @@ public int getArgs() {
     }
 
     /**
-     * Retrieve the self-documenting description of this Option
+     * Gets the self-documenting description of this Option
      *
      * @return The string description of this option
      */
@@ -519,7 +519,7 @@ public String getDescription() {
     }
 
     /**
-     * Returns the id of this Option. This is only set when the Option shortOpt is a single character. This is used for
+     * Gets the id of this Option. This is only set when the Option shortOpt is a single character. This is used for
      * switch statements.
      *
      * @return the id of this Option
@@ -529,7 +529,7 @@ public int getId() {
     }
 
     /**
-     * Returns the 'unique' Option identifier.
+     * Gets the 'unique' Option identifier.
      *
      * @return the 'unique' Option identifier
      */
@@ -539,7 +539,7 @@ String getKey() {
     }
 
     /**
-     * Retrieve the long name of this Option.
+     * Gets the long name of this Option.
      *
      * @return Long name of this option, or null, if there is no long name
      */
@@ -548,7 +548,7 @@ public String getLongOpt() {
     }
 
     /**
-     * Retrieve the name of this Option.
+     * Gets the name of this Option.
      *
      * It is this String which can be used with {@link CommandLine#hasOption(String opt)} and
      * {@link CommandLine#getOptionValue(String opt)} to check for existence and argument.
@@ -560,7 +560,7 @@ public String getOpt() {
     }
 
     /**
-     * Retrieve the type of this Option.
+     * Gets the type of this Option.
      *
      * @return The type of this option
      */
@@ -569,7 +569,7 @@ public Object getType() {
     }
 
     /**
-     * Returns the specified value of this Option or {@code null} if there is no value.
+     * Gets the specified value of this Option or {@code null} if there is no value.
      *
      * @return the value/first value of this Option or {@code null} if there is no value.
      */
@@ -578,7 +578,7 @@ public String getValue() {
     }
 
     /**
-     * Returns the specified value of this Option or {@code null} if there is no value.
+     * Gets the specified value of this Option or {@code null} if there is no value.
      *
      * @param index The index of the value to be returned.
      *
@@ -591,7 +591,7 @@ public String getValue(final int index) throws IndexOutOfBoundsException {
     }
 
     /**
-     * Returns the value/first value of this Option or the {@code defaultValue} if there is no value.
+     * Gets the value/first value of this Option or the {@code defaultValue} if there is no value.
      *
      * @param defaultValue The value to be returned if there is no value.
      *
@@ -604,7 +604,7 @@ public String getValue(final String defaultValue) {
     }
 
     /**
-     * Return the values of this Option as a String array or null if there are no values
+     * Gets the values of this Option as a String array or null if there are no values
      *
      * @return the values of this Option as a String array or null if there are no values
      */
@@ -613,7 +613,7 @@ public String[] getValues() {
     }
 
     /**
-     * Returns the value separator character.
+     * Gets the value separator character.
      *
      * @return the value separator character.
      */
@@ -622,6 +622,8 @@ public char getValueSeparator() {
     }
 
     /**
+     * Gets the values of this Option as a List or null if there are no values.
+     *
      * @return the values of this Option as a List or null if there are no values
      */
     public List<String> getValuesList() {

src/main/java/org/apache/commons/cli/OptionGroup.java

@@ -77,7 +77,7 @@ public String getSelected() {
     }
 
     /**
-     * Returns whether this option group is required.
+     * Tests whether this option group is required.
      *
      * @return whether this option group is required
      */

src/main/java/org/apache/commons/cli/Options.java

@@ -187,7 +187,7 @@ public Options addRequiredOption(final String opt, final String longOpt, final b
     }
 
     /**
-     * Returns the options with a long name starting with the name specified.
+     * Gets the options with a long name starting with the name specified.
      *
      * @param opt the partial name of the option
      * @return the options matching the partial name specified, or an empty list if none matches
@@ -213,7 +213,7 @@ public List<String> getMatchingOptions(String opt) {
     }
 
     /**
-     * Retrieve the {@link Option} matching the long or short name specified.
+     * Gets the {@link Option} matching the long or short name specified.
      *
      * <p>
      * The leading hyphens in the name are ignored (up to 2).
@@ -233,7 +233,7 @@ public Option getOption(String opt) {
     }
 
     /**
-     * Returns the OptionGroup the {@code opt} belongs to.
+     * Gets the OptionGroup the {@code opt} belongs to.
      *
      * @param opt the option whose OptionGroup is being queried.
      * @return the OptionGroup if {@code opt} is part of an OptionGroup, otherwise return null
@@ -243,7 +243,7 @@ public OptionGroup getOptionGroup(final Option opt) {
     }
 
     /**
-     * Lists the OptionGroups that are members of this Options instance.
+     * Gets the OptionGroups that are members of this Options instance.
      *
      * @return a Collection of OptionGroup instances.
      */
@@ -252,7 +252,7 @@ Collection<OptionGroup> getOptionGroups() {
     }
 
     /**
-     * Retrieve a read-only list of options in this set
+     * Gets a read-only list of options in this set
      *
      * @return read-only Collection of {@link Option} objects in this descriptor
      */
@@ -261,7 +261,7 @@ public Collection<Option> getOptions() {
     }
 
     /**
-     * Returns the required options.
+     * Gets the required options.
      *
      * @return read-only List of required options
      */