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 9539506 Javadoc: Use @code instead of HTML tags.
9539506 is described below
commit 9539506e87648d753c44b68b3dfbdd1938c09315
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sun Oct 3 17:32:12 2021 -0400
Javadoc: Use @code instead of HTML tags.
---
.../commons/cli/AlreadySelectedException.java | 4 +--
.../java/org/apache/commons/cli/BasicParser.java | 4 +--
.../java/org/apache/commons/cli/CommandLine.java | 32 ++++++++---------
.../org/apache/commons/cli/CommandLineParser.java | 10 +++---
.../java/org/apache/commons/cli/DefaultParser.java | 24 ++++++-------
.../java/org/apache/commons/cli/GnuParser.java | 4 +--
.../java/org/apache/commons/cli/HelpFormatter.java | 24 ++++++-------
.../commons/cli/MissingArgumentException.java | 4 +--
.../apache/commons/cli/MissingOptionException.java | 4 +--
src/main/java/org/apache/commons/cli/Option.java | 24 ++++++-------
.../java/org/apache/commons/cli/OptionBuilder.java | 26 +++++++-------
.../java/org/apache/commons/cli/OptionGroup.java | 8 ++---
.../org/apache/commons/cli/OptionValidator.java | 10 +++---
src/main/java/org/apache/commons/cli/Options.java | 4 +--
.../org/apache/commons/cli/ParseException.java | 2 +-
src/main/java/org/apache/commons/cli/Parser.java | 40 +++++++++++-----------
.../apache/commons/cli/PatternOptionBuilder.java | 10 +++---
.../java/org/apache/commons/cli/PosixParser.java | 36 +++++++++----------
.../java/org/apache/commons/cli/TypeHandler.java | 36 +++++++++----------
.../commons/cli/UnrecognizedOptionException.java | 4 +--
src/main/java/org/apache/commons/cli/Util.java | 4 +--
src/main/java/org/apache/commons/cli/overview.html | 4 +--
22 files changed, 159 insertions(+), 159 deletions(-)
diff --git a/src/main/java/org/apache/commons/cli/AlreadySelectedException.java
b/src/main/java/org/apache/commons/cli/AlreadySelectedException.java
index 5a42fb4..b6ac51a 100644
--- a/src/main/java/org/apache/commons/cli/AlreadySelectedException.java
+++ b/src/main/java/org/apache/commons/cli/AlreadySelectedException.java
@@ -33,7 +33,7 @@ public class AlreadySelectedException extends ParseException {
private Option option;
/**
- * Construct a new <code>AlreadySelectedException</code> for the specified
option group.
+ * Construct a new {@code AlreadySelectedException} for the specified
option group.
*
* @param group the option group already selected
* @param option the option that triggered the exception
@@ -46,7 +46,7 @@ public class AlreadySelectedException extends ParseException {
}
/**
- * Construct a new <code>AlreadySelectedException</code> with the
specified detail message.
+ * Construct a new {@code AlreadySelectedException} with the specified
detail message.
*
* @param message the detail message
*/
diff --git a/src/main/java/org/apache/commons/cli/BasicParser.java
b/src/main/java/org/apache/commons/cli/BasicParser.java
index 57d4f65..212e2f6 100644
--- a/src/main/java/org/apache/commons/cli/BasicParser.java
+++ b/src/main/java/org/apache/commons/cli/BasicParser.java
@@ -32,13 +32,13 @@ public class BasicParser extends Parser {
* </p>
*
* <p>
- * <b>Note:</b> <code>options</code> and <code>stopAtNonOption</code> are
not used in this <code>flatten</code> method.
+ * <b>Note:</b> {@code options} and {@code stopAtNonOption} are not used
in this {@code flatten} method.
* </p>
*
* @param options The command line {@link Options}
* @param arguments The command line arguments to be parsed
* @param stopAtNonOption Specifies whether to stop flattening when an non
option is found.
- * @return The <code>arguments</code> String array.
+ * @return The {@code arguments} String array.
*/
@Override
protected String[] flatten(@SuppressWarnings("unused") final Options
options, final String[] arguments,
diff --git a/src/main/java/org/apache/commons/cli/CommandLine.java
b/src/main/java/org/apache/commons/cli/CommandLine.java
index 28148b5..1e44e5d 100644
--- a/src/main/java/org/apache/commons/cli/CommandLine.java
+++ b/src/main/java/org/apache/commons/cli/CommandLine.java
@@ -35,7 +35,7 @@ import java.util.Properties;
*/
public class CommandLine implements Serializable {
/**
- * A nested builder class to create <code>CommandLine</code> instance
using descriptive methods.
+ * A nested builder class to create {@code CommandLine} instance using
descriptive methods.
*
* @since 1.4
*/
@@ -111,7 +111,7 @@ public class CommandLine implements Serializable {
/**
* Retrieve any left-over non-recognized options and arguments
*
- * @return remaining items passed in but not parsed as a <code>List</code>.
+ * @return remaining items passed in but not parsed as a {@code List}.
*/
public List<String> getArgList() {
return args;
@@ -131,7 +131,7 @@ public class CommandLine implements Serializable {
}
/**
- * Return the <code>Object</code> type of this <code>Option</code>.
+ * Return the {@code Object} type of this {@code Option}.
*
* @deprecated due to System.err message. Instead use
getParsedOptionValue(char)
* @param opt the name of the option.
@@ -143,10 +143,10 @@ public class CommandLine implements Serializable {
}
/**
- * Return the <code>Object</code> type of this <code>Option</code>.
+ * Return the {@code Object} type of this {@code Option}.
*
* @param opt the name of the option.
- * @return the type of this <code>Option</code>.
+ * @return the type of this {@code Option}.
* @deprecated due to System.err message. Instead use
getParsedOptionValue(String)
*/
@Deprecated
@@ -163,10 +163,10 @@ public class CommandLine implements Serializable {
* Retrieve the map of values associated to the option. This is convenient
for options specifying Java properties like
* <code>-Dparam1=value1
* -Dparam2=value2</code>. The first argument of the option is the key,
and the 2nd argument is the value. If the option
- * has only one argument (<code>-Dfoo</code>) it is considered as a
boolean flag and the value is <code>"true"</code>.
+ * has only one argument ({@code -Dfoo}) it is considered as a boolean
flag and the value is {@code "true"}.
*
* @param option name of the option.
- * @return The Properties mapped by the option, never <code>null</code>
even if the option doesn't exists.
+ * @return The Properties mapped by the option, never {@code null} even if
the option doesn't exists.
* @since 1.5
*/
public Properties getOptionProperties(final Option option) {
@@ -192,10 +192,10 @@ public class CommandLine implements Serializable {
* Retrieve the map of values associated to the option. This is convenient
for options specifying Java properties like
* <code>-Dparam1=value1
* -Dparam2=value2</code>. The first argument of the option is the key,
and the 2nd argument is the value. If the option
- * has only one argument (<code>-Dfoo</code>) it is considered as a
boolean flag and the value is <code>"true"</code>.
+ * has only one argument ({@code -Dfoo}) it is considered as a boolean
flag and the value is {@code "true"}.
*
* @param opt name of the option.
- * @return The Properties mapped by the option, never <code>null</code>
even if the option doesn't exists.
+ * @return The Properties mapped by the option, never {@code null} even if
the option doesn't exists.
* @since 1.2
*/
public Properties getOptionProperties(final String opt) {
@@ -247,7 +247,7 @@ public class CommandLine implements Serializable {
*
* @param opt character name of the option
* @param defaultValue is the default value to be returned if the option
is not specified.
- * @return Value of the argument if option is set, and has an argument,
otherwise <code>defaultValue</code>.
+ * @return Value of the argument if option is set, and has an argument,
otherwise {@code defaultValue}.
*/
public String getOptionValue(final char opt, final String defaultValue) {
return getOptionValue(String.valueOf(opt), defaultValue);
@@ -273,7 +273,7 @@ public class CommandLine implements Serializable {
*
* @param option name of the option.
* @param defaultValue is the default value to be returned if the option
is not specified.
- * @return Value of the argument if option is set, and has an argument,
otherwise <code>defaultValue</code>.
+ * @return Value of the argument if option is set, and has an argument,
otherwise {@code defaultValue}.
* @since 1.5
*/
public String getOptionValue(final Option option, final String
defaultValue) {
@@ -296,7 +296,7 @@ public class CommandLine implements Serializable {
*
* @param opt name of the option.
* @param defaultValue is the default value to be returned if the option
is not specified.
- * @return Value of the argument if option is set, and has an argument,
otherwise <code>defaultValue</code>.
+ * @return Value of the argument if option is set, and has an argument,
otherwise {@code defaultValue}.
*/
public String getOptionValue(final String opt, final String defaultValue) {
return getOptionValue(resolveOption(opt), defaultValue);
@@ -342,7 +342,7 @@ public class CommandLine implements Serializable {
}
/**
- * Return a version of this <code>Option</code> converted to a particular
type.
+ * Return a version of this {@code Option} converted to a particular type.
*
* @param opt the name of the option.
* @return the value parsed into a particular object.
@@ -355,7 +355,7 @@ public class CommandLine implements Serializable {
}
/**
- * Return a version of this <code>Option</code> converted to a particular
type.
+ * Return a version of this {@code Option} converted to a particular type.
*
* @param option the name of the option.
* @return the value parsed into a particular object.
@@ -375,7 +375,7 @@ public class CommandLine implements Serializable {
}
/**
- * Return a version of this <code>Option</code> converted to a particular
type.
+ * Return a version of this {@code Option} converted to a particular type.
*
* @param opt the name of the option.
* @return the value parsed into a particular object.
@@ -439,7 +439,7 @@ public class CommandLine implements Serializable {
/**
* Returns an iterator over the Option members of CommandLine.
*
- * @return an <code>Iterator</code> over the processed {@link Option}
members of this {@link CommandLine}.
+ * @return an {@code Iterator} over the processed {@link Option} members
of this {@link CommandLine}.
*/
public Iterator<Option> iterator() {
return options.iterator();
diff --git a/src/main/java/org/apache/commons/cli/CommandLineParser.java
b/src/main/java/org/apache/commons/cli/CommandLineParser.java
index c087bbe..7794089 100644
--- a/src/main/java/org/apache/commons/cli/CommandLineParser.java
+++ b/src/main/java/org/apache/commons/cli/CommandLineParser.java
@@ -18,7 +18,7 @@
package org.apache.commons.cli;
/**
- * A class that implements the <code>CommandLineParser</code> interface can
parse a String array according to the
+ * A class that implements the {@code CommandLineParser} interface can parse a
String array according to the
* {@link Options} specified and return a {@link CommandLine}.
*/
public interface CommandLineParser {
@@ -54,8 +54,8 @@ public interface CommandLineParser {
*
* @param options the specified Options
* @param arguments the command line arguments
- * @param stopAtNonOption if <code>true</code> an unrecognized argument
stops the parsing and the remaining arguments
- * are added to the {@link CommandLine}s args list. If
<code>false</code> an unrecognized argument triggers a
+ * @param stopAtNonOption if {@code true} an unrecognized argument stops
the parsing and the remaining arguments
+ * are added to the {@link CommandLine}s args list. If {@code
false} an unrecognized argument triggers a
* ParseException.
*
* @return the list of atomic option and value tokens
@@ -69,8 +69,8 @@ public interface CommandLineParser {
* @param options the specified Options
* @param arguments the command line arguments
* @param properties command line option name-value pairs
- * @param stopAtNonOption if <code>true</code> an unrecognized argument
stops the parsing and the remaining arguments
- * are added to the {@link CommandLine}s args list. If
<code>false</code> an unrecognized argument triggers a
+ * @param stopAtNonOption if {@code true} an unrecognized argument stops
the parsing and the remaining arguments
+ * are added to the {@link CommandLine}s args list. If {@code
false} an unrecognized argument triggers a
* ParseException.
*
* @return the list of atomic option and value tokens
diff --git a/src/main/java/org/apache/commons/cli/DefaultParser.java
b/src/main/java/org/apache/commons/cli/DefaultParser.java
index 7ccebd7..13773da 100644
--- a/src/main/java/org/apache/commons/cli/DefaultParser.java
+++ b/src/main/java/org/apache/commons/cli/DefaultParser.java
@@ -35,8 +35,8 @@ public class DefaultParser implements CommandLineParser {
protected Options options;
/**
- * Flag indicating how unrecognized tokens are handled. <code>true</code>
to stop the parsing and add the remaining
- * tokens to the args list. <code>false</code> to throw an exception.
+ * Flag indicating how unrecognized tokens are handled. {@code true} to
stop the parsing and add the remaining
+ * tokens to the args list. {@code false} to throw an exception.
*/
protected boolean stopAtNonOption;
@@ -70,8 +70,8 @@ public class DefaultParser implements CommandLineParser {
* }
* </pre>
*
- * with "partial matching" turned on, <code>-de</code> only matches the
<code>"debug"</code> option. However, with
- * "partial matching" disabled, <code>-de</code> would enable both
<code>debug</code> as well as <code>extract</code>
+ * with "partial matching" turned on, {@code -de} only matches the {@code
"debug"} option. However, with
+ * "partial matching" disabled, {@code -de} would enable both {@code
debug} as well as {@code extract}
* options.
*/
public DefaultParser() {
@@ -93,8 +93,8 @@ public class DefaultParser implements CommandLineParser {
* }
* </pre>
*
- * with "partial matching" turned on, <code>-de</code> only matches the
<code>"debug"</code> option. However, with
- * "partial matching" disabled, <code>-de</code> would enable both
<code>debug</code> as well as <code>extract</code>
+ * with "partial matching" turned on, {@code -de} only matches the {@code
"debug"} option. However, with
+ * "partial matching" disabled, {@code -de} would enable both {@code
debug} as well as {@code extract}
* options.
*
* @param allowPartialMatching if partial matching of long options shall
be enabled
@@ -165,7 +165,7 @@ public class DefaultParser implements CommandLineParser {
}
/**
- * Breaks <code>token</code> into its constituent parts using the
following algorithm.
+ * Breaks {@code token} into its constituent parts using the following
algorithm.
*
* <ul>
* <li>ignore the first character ("<b>-</b>")</li>
@@ -174,10 +174,10 @@ public class DefaultParser implements CommandLineParser {
* tokens.</li>
* <li>if the {@link Option} can have an argument value and there are
remaining characters in the token then add the
* remaining characters as a token to the list of processed tokens.</li>
- * <li>if an {@link Option} does <b>NOT</b> exist <b>AND</b>
<code>stopAtNonOption</code> <b>IS</b> set then add the
+ * <li>if an {@link Option} does <b>NOT</b> exist <b>AND</b> {@code
stopAtNonOption} <b>IS</b> set then add the
* special token "<b>--</b>" followed by the remaining characters and also
the remaining tokens directly to the
* processed tokens list.</li>
- * <li>if an {@link Option} does <b>NOT</b> exist <b>AND</b>
<code>stopAtNonOption</code> <b>IS NOT</b> set then add
+ * <li>if an {@link Option} does <b>NOT</b> exist <b>AND</b> {@code
stopAtNonOption} <b>IS NOT</b> set then add
* that character prepended with "<b>-</b>".</li>
* </ul>
*
@@ -287,7 +287,7 @@ public class DefaultParser implements CommandLineParser {
}
/**
- * Sets the values of Options using the values in <code>properties</code>.
+ * Sets the values of Options using the values in {@code properties}.
*
* @param properties The value properties to be processed.
*/
@@ -565,8 +565,8 @@ public class DefaultParser implements CommandLineParser {
* @param options the specified Options
* @param arguments the command line arguments
* @param properties command line option name-value pairs
- * @param stopAtNonOption if <code>true</code> an unrecognized argument
stops the parsing and the remaining arguments
- * are added to the {@link CommandLine}s args list. If
<code>false</code> an unrecognized argument triggers a
+ * @param stopAtNonOption if {@code true} an unrecognized argument stops
the parsing and the remaining arguments
+ * are added to the {@link CommandLine}s args list. If {@code
false} an unrecognized argument triggers a
* ParseException.
*
* @return the list of atomic option and value tokens
diff --git a/src/main/java/org/apache/commons/cli/GnuParser.java
b/src/main/java/org/apache/commons/cli/GnuParser.java
index bc80646..7088c55 100644
--- a/src/main/java/org/apache/commons/cli/GnuParser.java
+++ b/src/main/java/org/apache/commons/cli/GnuParser.java
@@ -31,8 +31,8 @@ public class GnuParser extends Parser {
/**
* This flatten method does so using the following rules:
* <ol>
- * <li>If an {@link Option} exists for the first character of the
<code>arguments</code> entry <b>AND</b> an
- * {@link Option} does not exist for the whole <code>argument</code> then
add the first character as an option to the
+ * <li>If an {@link Option} exists for the first character of the {@code
arguments} entry <b>AND</b> an
+ * {@link Option} does not exist for the whole {@code argument} then add
the first character as an option to the
* processed tokens list e.g. "-D" and add the rest of the entry to the
also.</li>
* <li>Otherwise just add the token to the processed tokens list.</li>
* </ol>
diff --git a/src/main/java/org/apache/commons/cli/HelpFormatter.java
b/src/main/java/org/apache/commons/cli/HelpFormatter.java
index 4deffec..bb8e51d 100644
--- a/src/main/java/org/apache/commons/cli/HelpFormatter.java
+++ b/src/main/java/org/apache/commons/cli/HelpFormatter.java
@@ -67,7 +67,7 @@ public class HelpFormatter {
// ---------------------------------------------------------------
Constants
/**
- * This class implements the <code>Comparator</code> interface for
comparing Options.
+ * This class implements the {@code Comparator} interface for comparing
Options.
*/
private static class OptionComparator implements Comparator<Option>,
Serializable {
/** The serial version UID. */
@@ -253,7 +253,7 @@ public class HelpFormatter {
}
/**
- * Return a String of padding of length <code>len</code>.
+ * Return a String of padding of length {@code len}.
*
* @param len The length of the String of padding to create.
*
@@ -267,8 +267,8 @@ public class HelpFormatter {
}
/**
- * Finds the next text wrap position after <code>startPos</code> for the
text in <code>text</code> with the column width
- * <code>width</code>. The wrap point is the last position before
startPos+width having a whitespace character (space,
+ * Finds the next text wrap position after {@code startPos} for the text
in {@code text} with the column width
+ * {@code width}. The wrap point is the last position before
startPos+width having a whitespace character (space,
* \n, \r). If there is no whitespace character before startPos+width, it
will return startPos+width.
*
* @param text The text being searched for the wrap position
@@ -405,7 +405,7 @@ public class HelpFormatter {
}
/**
- * Print the help for <code>options</code> with the specified command line
syntax. This method prints help information
+ * Print the help for {@code options} with the specified command line
syntax. This method prints help information
* to System.out.
*
* @param width the number of characters to be displayed on each line
@@ -419,7 +419,7 @@ public class HelpFormatter {
}
/**
- * Print the help for <code>options</code> with the specified command line
syntax. This method prints help information
+ * Print the help for {@code options} with the specified command line
syntax. This method prints help information
* to System.out.
*
* @param width the number of characters to be displayed on each line
@@ -438,7 +438,7 @@ public class HelpFormatter {
}
/**
- * Print the help for <code>options</code> with the specified command line
syntax.
+ * Print the help for {@code options} with the specified command line
syntax.
*
* @param pw the writer to which the help will be written
* @param width the number of characters to be displayed on each line
@@ -457,7 +457,7 @@ public class HelpFormatter {
}
/**
- * Print the help for <code>options</code> with the specified command line
syntax.
+ * Print the help for {@code options} with the specified command line
syntax.
*
* @param pw the writer to which the help will be written
* @param width the number of characters to be displayed on each line
@@ -495,7 +495,7 @@ public class HelpFormatter {
}
/**
- * Print the help for <code>options</code> with the specified command line
syntax. This method prints help information
+ * Print the help for {@code options} with the specified command line
syntax. This method prints help information
* to System.out.
*
* @param cmdLineSyntax the syntax for this application
@@ -506,7 +506,7 @@ public class HelpFormatter {
}
/**
- * Print the help for <code>options</code> with the specified command line
syntax. This method prints help information
+ * Print the help for {@code options} with the specified command line
syntax. This method prints help information
* to System.out.
*
* @param cmdLineSyntax the syntax for this application
@@ -518,7 +518,7 @@ public class HelpFormatter {
}
/**
- * Print the help for <code>options</code> with the specified command line
syntax. This method prints help information
+ * Print the help for {@code options} with the specified command line
syntax. This method prints help information
* to System.out.
*
* @param cmdLineSyntax the syntax for this application
@@ -531,7 +531,7 @@ public class HelpFormatter {
}
/**
- * Print the help for <code>options</code> with the specified command line
syntax. This method prints help information
+ * Print the help for {@code options} with the specified command line
syntax. This method prints help information
* to System.out.
*
* @param cmdLineSyntax the syntax for this application
diff --git a/src/main/java/org/apache/commons/cli/MissingArgumentException.java
b/src/main/java/org/apache/commons/cli/MissingArgumentException.java
index a03e3f3..87609d8 100644
--- a/src/main/java/org/apache/commons/cli/MissingArgumentException.java
+++ b/src/main/java/org/apache/commons/cli/MissingArgumentException.java
@@ -30,7 +30,7 @@ public class MissingArgumentException extends ParseException {
private Option option;
/**
- * Construct a new <code>MissingArgumentException</code> with the
specified detail message.
+ * Construct a new {@code MissingArgumentException} with the specified
detail message.
*
* @param option the option requiring an argument
* @since 1.2
@@ -41,7 +41,7 @@ public class MissingArgumentException extends ParseException {
}
/**
- * Construct a new <code>MissingArgumentException</code> with the
specified detail message.
+ * Construct a new {@code MissingArgumentException} with the specified
detail message.
*
* @param message the detail message
*/
diff --git a/src/main/java/org/apache/commons/cli/MissingOptionException.java
b/src/main/java/org/apache/commons/cli/MissingOptionException.java
index fb1c434..900b9fe 100644
--- a/src/main/java/org/apache/commons/cli/MissingOptionException.java
+++ b/src/main/java/org/apache/commons/cli/MissingOptionException.java
@@ -53,7 +53,7 @@ public class MissingOptionException extends ParseException {
private List missingOptions;
/**
- * Constructs a new <code>MissingSelectedException</code> with the
specified list of missing options.
+ * Constructs a new {@code MissingSelectedException} with the specified
list of missing options.
*
* @param missingOptions the list of missing options and groups
* @since 1.2
@@ -64,7 +64,7 @@ public class MissingOptionException extends ParseException {
}
/**
- * Construct a new <code>MissingSelectedException</code> with the
specified detail message.
+ * Construct a new {@code MissingSelectedException} with the specified
detail message.
*
* @param message the detail message
*/
diff --git a/src/main/java/org/apache/commons/cli/Option.java
b/src/main/java/org/apache/commons/cli/Option.java
index 3774349..2ffc20c 100644
--- a/src/main/java/org/apache/commons/cli/Option.java
+++ b/src/main/java/org/apache/commons/cli/Option.java
@@ -37,7 +37,7 @@ import java.util.List;
*/
public class Option implements Cloneable, Serializable {
/**
- * A nested builder class to create <code>Option</code> instances using
descriptive methods.
+ * A nested builder class to create {@code Option} instances using
descriptive methods.
* <p>
* Example usage:
*
@@ -76,7 +76,7 @@ public class Option implements Cloneable, Serializable {
private char valuesep;
/**
- * Constructs a new <code>Builder</code> with the minimum required
parameters for an <code>Option</code> instance.
+ * Constructs a new {@code Builder} with the minimum required
parameters for an {@code Option} instance.
*
* @param opt short representation of the option
* @throws IllegalArgumentException if there are any non valid Option
characters in {@code opt}
@@ -226,7 +226,7 @@ public class Option implements Cloneable, Serializable {
}
/**
- * The Option will use <code>sep</code> as a means to separate
argument values.
+ * The Option will use {@code sep} as a means to separate argument
values.
* <p>
* <b>Example:</b>
*
@@ -335,7 +335,7 @@ public class Option implements Cloneable, Serializable {
* @param hasArg specifies whether the Option takes an argument or not
* @param description describes the function of the option
*
- * @throws IllegalArgumentException if there are any non valid Option
characters in <code>opt</code>.
+ * @throws IllegalArgumentException if there are any non valid Option
characters in {@code opt}.
*/
public Option(final String opt, final boolean hasArg, final String
description) throws IllegalArgumentException {
this(opt, null, hasArg, description);
@@ -347,7 +347,7 @@ public class Option implements Cloneable, Serializable {
* @param opt short representation of the option
* @param description describes the function of the option
*
- * @throws IllegalArgumentException if there are any non valid Option
characters in <code>opt</code>.
+ * @throws IllegalArgumentException if there are any non valid Option
characters in {@code opt}.
*/
public Option(final String opt, final String description) throws
IllegalArgumentException {
this(opt, null, false, description);
@@ -361,7 +361,7 @@ public class Option implements Cloneable, Serializable {
* @param hasArg specifies whether the Option takes an argument or not
* @param description describes the function of the option
*
- * @throws IllegalArgumentException if there are any non valid Option
characters in <code>opt</code>.
+ * @throws IllegalArgumentException if there are any non valid Option
characters in {@code opt}.
*/
public Option(final String opt, final String longOpt, final boolean
hasArg, final String description) throws IllegalArgumentException {
// ensure that the option is valid
@@ -569,20 +569,20 @@ public class Option implements Cloneable, Serializable {
}
/**
- * Returns the specified value of this Option or <code>null</code> if
there is no value.
+ * Returns 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</code> if
there is no value.
+ * @return the value/first value of this Option or {@code null} if there
is no value.
*/
public String getValue() {
return hasNoValues() ? null : values.get(0);
}
/**
- * Returns the specified value of this Option or <code>null</code> if
there is no value.
+ * Returns the specified value of this Option or {@code null} if there is
no value.
*
* @param index The index of the value to be returned.
*
- * @return the specified value of this Option or <code>null</code> if
there is no value.
+ * @return the specified value of this Option or {@code null} if there is
no value.
*
* @throws IndexOutOfBoundsException if index is less than 1 or greater
than the number of the values for this Option.
*/
@@ -591,11 +591,11 @@ public class Option implements Cloneable, Serializable {
}
/**
- * Returns the value/first value of this Option or the
<code>defaultValue</code> if there is no value.
+ * Returns 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.
*
- * @return the value/first value of this Option or the
<code>defaultValue</code> if there are no values.
+ * @return the value/first value of this Option or the {@code
defaultValue} if there are no values.
*/
public String getValue(final String defaultValue) {
final String value = getValue();
diff --git a/src/main/java/org/apache/commons/cli/OptionBuilder.java
b/src/main/java/org/apache/commons/cli/OptionBuilder.java
index b6ee9df..7aa4803 100644
--- a/src/main/java/org/apache/commons/cli/OptionBuilder.java
+++ b/src/main/java/org/apache/commons/cli/OptionBuilder.java
@@ -66,7 +66,7 @@ public final class OptionBuilder {
* Create an Option using the current settings
*
* @return the Option instance
- * @throws IllegalArgumentException if <code>longOpt</code> has not been
set.
+ * @throws IllegalArgumentException if {@code longOpt} has not been set.
*/
public static Option create() throws IllegalArgumentException {
if (longopt == null) {
@@ -78,22 +78,22 @@ public final class OptionBuilder {
}
/**
- * Create an Option using the current settings and with the specified
Option <code>char</code>.
+ * Create an Option using the current settings and with the specified
Option {@code char}.
*
* @param opt the character representation of the Option
* @return the Option instance
- * @throws IllegalArgumentException if <code>opt</code> is not a valid
character. See Option.
+ * @throws IllegalArgumentException if {@code opt} is not a valid
character. See Option.
*/
public static Option create(final char opt) throws
IllegalArgumentException {
return create(String.valueOf(opt));
}
/**
- * Create an Option using the current settings and with the specified
Option <code>char</code>.
+ * Create an Option using the current settings and with the specified
Option {@code char}.
*
- * @param opt the <code>java.lang.String</code> representation of the
Option
+ * @param opt the {@code java.lang.String} representation of the Option
* @return the Option instance
- * @throws IllegalArgumentException if <code>opt</code> is not a valid
character. See Option.
+ * @throws IllegalArgumentException if {@code opt} is not a valid
character. See Option.
*/
public static Option create(final String opt) throws
IllegalArgumentException {
Option option = null;
@@ -130,7 +130,7 @@ public final class OptionBuilder {
}
/**
- * The next Option created will require an argument value if
<code>hasArg</code> is true.
+ * The next Option created will require an argument value if {@code
hasArg} is true.
*
* @param hasArg if true then the Option has an argument value
* @return the OptionBuilder instance
@@ -153,7 +153,7 @@ public final class OptionBuilder {
}
/**
- * The next Option created can have <code>num</code> argument values.
+ * The next Option created can have {@code num} argument values.
*
* @param num the number of args that the option can have
* @return the OptionBuilder instance
@@ -213,7 +213,7 @@ public final class OptionBuilder {
}
/**
- * The next Option created will be required if <code>required</code> is
true.
+ * The next Option created will be required if {@code required} is true.
*
* @param newRequired if true then the Option is required
* @return the OptionBuilder instance
@@ -275,7 +275,7 @@ public final class OptionBuilder {
}
/**
- * The next Option created will have a value that will be an instance of
<code>type</code>.
+ * The next Option created will have a value that will be an instance of
{@code type}.
*
* @param newType the type of the Options argument value
* @return the OptionBuilder instance
@@ -288,7 +288,7 @@ public final class OptionBuilder {
}
/**
- * The next Option created will have a value that will be an instance of
<code>type</code>.
+ * The next Option created will have a value that will be an instance of
{@code type}.
* <p>
* <b>Note:</b> this method is kept for binary compatibility and the input
type is supposed to be a {@link Class}
* object.
@@ -303,7 +303,7 @@ public final class OptionBuilder {
}
/**
- * The next Option created uses '<code>=</code>' as a means to separate
argument values.
+ * The next Option created uses '{@code =}' as a means to separate
argument values.
*
* <b>Example:</b>
*
@@ -324,7 +324,7 @@ public final class OptionBuilder {
}
/**
- * The next Option created uses <code>sep</code> as a means to separate
argument values.
+ * The next Option created uses {@code sep} as a means to separate
argument values.
* <p>
* <b>Example:</b>
*
diff --git a/src/main/java/org/apache/commons/cli/OptionGroup.java
b/src/main/java/org/apache/commons/cli/OptionGroup.java
index 93ca192..a015ab9 100644
--- a/src/main/java/org/apache/commons/cli/OptionGroup.java
+++ b/src/main/java/org/apache/commons/cli/OptionGroup.java
@@ -40,7 +40,7 @@ public class OptionGroup implements Serializable {
private boolean required;
/**
- * Add the specified <code>Option</code> to this group.
+ * Add the specified {@code Option} to this group.
*
* @param option the option to add to this group
* @return this option group with the option added
@@ -54,7 +54,7 @@ public class OptionGroup implements Serializable {
}
/**
- * @return the names of the options in this group as a
<code>Collection</code>
+ * @return the names of the options in this group as a {@code Collection}
*/
public Collection<String> getNames() {
// the key set is the collection of names
@@ -62,7 +62,7 @@ public class OptionGroup implements Serializable {
}
/**
- * @return the options in this group as a <code>Collection</code>
+ * @return the options in this group as a {@code Collection}
*/
public Collection<Option> getOptions() {
// the values are the collection of options
@@ -93,7 +93,7 @@ public class OptionGroup implements Serializable {
}
/**
- * Set the selected option of this group to <code>name</code>.
+ * Set the selected option of this group to {@code name}.
*
* @param option the option that is selected
* @throws AlreadySelectedException if an option from this group has
already been selected.
diff --git a/src/main/java/org/apache/commons/cli/OptionValidator.java
b/src/main/java/org/apache/commons/cli/OptionValidator.java
index 35f9f44..4fea227 100644
--- a/src/main/java/org/apache/commons/cli/OptionValidator.java
+++ b/src/main/java/org/apache/commons/cli/OptionValidator.java
@@ -27,7 +27,7 @@ final class OptionValidator {
* Returns whether the specified character is a valid character.
*
* @param c the character to validate
- * @return true if <code>c</code> is a letter.
+ * @return true if {@code c} is a letter.
*/
private static boolean isValidChar(final char c) {
return Character.isJavaIdentifierPart(c);
@@ -37,19 +37,19 @@ final class OptionValidator {
* Returns whether the specified character is a valid Option.
*
* @param c the option to validate
- * @return true if <code>c</code> is a letter, '?' or '@', otherwise false.
+ * @return true if {@code c} is a letter, '?' or '@', otherwise false.
*/
private static boolean isValidOpt(final char c) {
return isValidChar(c) || c == '?' || c == '@';
}
/**
- * Validates whether <code>opt</code> is a permissible Option shortOpt.
The rules that specify if the <code>opt</code>
+ * Validates whether {@code opt} is a permissible Option shortOpt. The
rules that specify if the {@code opt}
* is valid are:
*
* <ul>
- * <li>a single character <code>opt</code> that is either ' '(special
case), '?', '@' or a letter</li>
- * <li>a multi character <code>opt</code> that only contains letters.</li>
+ * <li>a single character {@code opt} that is either ' '(special case),
'?', '@' or a letter</li>
+ * <li>a multi character {@code opt} that only contains letters.</li>
* </ul>
* <p>
* In case {@code opt} is {@code null} no further validation is performed.
diff --git a/src/main/java/org/apache/commons/cli/Options.java
b/src/main/java/org/apache/commons/cli/Options.java
index e4ccb70..fc1ba71 100644
--- a/src/main/java/org/apache/commons/cli/Options.java
+++ b/src/main/java/org/apache/commons/cli/Options.java
@@ -233,10 +233,10 @@ public class Options implements Serializable {
}
/**
- * Returns the OptionGroup the <code>opt</code> belongs to.
+ * Returns the OptionGroup the {@code opt} belongs to.
*
* @param opt the option whose OptionGroup is being queried.
- * @return the OptionGroup if <code>opt</code> is part of an OptionGroup,
otherwise return null
+ * @return the OptionGroup if {@code opt} is part of an OptionGroup,
otherwise return null
*/
public OptionGroup getOptionGroup(final Option opt) {
return optionGroups.get(opt.getKey());
diff --git a/src/main/java/org/apache/commons/cli/ParseException.java
b/src/main/java/org/apache/commons/cli/ParseException.java
index 93843e6..5d3acc6 100644
--- a/src/main/java/org/apache/commons/cli/ParseException.java
+++ b/src/main/java/org/apache/commons/cli/ParseException.java
@@ -27,7 +27,7 @@ public class ParseException extends Exception {
private static final long serialVersionUID = 9112808380089253192L;
/**
- * Construct a new <code>ParseException</code> with the specified detail
message.
+ * Construct a new {@code ParseException} with the specified detail
message.
*
* @param message the detail message
*/
diff --git a/src/main/java/org/apache/commons/cli/Parser.java
b/src/main/java/org/apache/commons/cli/Parser.java
index 8881ae0..b43c50f 100644
--- a/src/main/java/org/apache/commons/cli/Parser.java
+++ b/src/main/java/org/apache/commons/cli/Parser.java
@@ -25,7 +25,7 @@ import java.util.ListIterator;
import java.util.Properties;
/**
- * <code>Parser</code> creates {@link CommandLine}s.
+ * {@code Parser} creates {@link CommandLine}s.
*
* @deprecated since 1.3, the two-pass parsing with the flatten method is not
enough flexible to handle complex cases
*/
@@ -53,7 +53,7 @@ public abstract class Parser implements CommandLineParser {
}
/**
- * Subclasses must implement this method to reduce the
<code>arguments</code> that have been passed to the parse method.
+ * Subclasses must implement this method to reduce the {@code arguments}
that have been passed to the parse method.
*
* @param opts The Options to parse the arguments by.
* @param arguments The arguments that have to be flattened.
@@ -72,11 +72,11 @@ public abstract class Parser implements CommandLineParser {
}
/**
- * Parses the specified <code>arguments</code> based on the specified
{@link Options}.
+ * Parses the specified {@code arguments} based on the specified {@link
Options}.
*
- * @param options the <code>Options</code>
- * @param arguments the <code>arguments</code>
- * @return the <code>CommandLine</code>
+ * @param options the {@code Options}
+ * @param arguments the {@code arguments}
+ * @return the {@code CommandLine}
* @throws ParseException if there are any problems encountered while
parsing the command line tokens.
*/
@Override
@@ -85,14 +85,14 @@ public abstract class Parser implements CommandLineParser {
}
/**
- * Parses the specified <code>arguments</code> based on the specified
{@link Options}.
+ * Parses the specified {@code arguments} based on the specified {@link
Options}.
*
- * @param options the <code>Options</code>
- * @param arguments the <code>arguments</code>
- * @param stopAtNonOption if <code>true</code> an unrecognized argument
stops the parsing and the remaining arguments
- * are added to the {@link CommandLine}s args list. If
<code>false</code> an unrecognized argument triggers a
+ * @param options the {@code Options}
+ * @param arguments the {@code arguments}
+ * @param stopAtNonOption if {@code true} an unrecognized argument stops
the parsing and the remaining arguments
+ * are added to the {@link CommandLine}s args list. If {@code
false} an unrecognized argument triggers a
* ParseException.
- * @return the <code>CommandLine</code>
+ * @return the {@code CommandLine}
* @throws ParseException if an error occurs when parsing the arguments.
*/
@Override
@@ -121,8 +121,8 @@ public abstract class Parser implements CommandLineParser {
* @param options the specified Options
* @param arguments the command line arguments
* @param properties command line option name-value pairs
- * @param stopAtNonOption if <code>true</code> an unrecognized argument
stops the parsing and the remaining arguments
- * are added to the {@link CommandLine}s args list. If
<code>false</code> an unrecognized argument triggers a
+ * @param stopAtNonOption if {@code true} an unrecognized argument stops
the parsing and the remaining arguments
+ * are added to the {@link CommandLine}s args list. If {@code
false} an unrecognized argument triggers a
* ParseException.
*
* @return the list of atomic option and value tokens
@@ -214,8 +214,8 @@ public abstract class Parser implements CommandLineParser {
}
/**
- * Process the argument values for the specified Option <code>opt</code>
using the values retrieved from the specified
- * iterator <code>iter</code>.
+ * Process the argument values for the specified Option {@code opt} using
the values retrieved from the specified
+ * iterator {@code iter}.
*
* @param opt The current Option
* @param iter The iterator over the flattened command line Options.
@@ -248,13 +248,13 @@ public abstract class Parser implements CommandLineParser
{
}
/**
- * Process the Option specified by <code>arg</code> using the values
retrieved from the specified iterator
- * <code>iter</code>.
+ * Process the Option specified by {@code arg} using the values retrieved
from the specified iterator
+ * {@code iter}.
*
* @param arg The String value representing an Option
* @param iter The iterator over the flattened command line arguments.
*
- * @throws ParseException if <code>arg</code> does not represent an Option
+ * @throws ParseException if {@code arg} does not represent an Option
*/
protected void processOption(final String arg, final ListIterator<String>
iter) throws ParseException {
final boolean hasOption = getOptions().hasOption(arg);
@@ -280,7 +280,7 @@ public abstract class Parser implements CommandLineParser {
}
/**
- * Sets the values of Options using the values in <code>properties</code>.
+ * Sets the values of Options using the values in {@code properties}.
*
* @param properties The value properties to be processed.
* @throws ParseException if there are any problems encountered while
processing the properties.
diff --git a/src/main/java/org/apache/commons/cli/PatternOptionBuilder.java
b/src/main/java/org/apache/commons/cli/PatternOptionBuilder.java
index 81b637f..bc203fe 100644
--- a/src/main/java/org/apache/commons/cli/PatternOptionBuilder.java
+++ b/src/main/java/org/apache/commons/cli/PatternOptionBuilder.java
@@ -104,10 +104,10 @@ public class PatternOptionBuilder {
public static final Class<URL> URL_VALUE = URL.class;
/**
- * Retrieve the class that <code>ch</code> represents.
+ * Retrieve the class that {@code ch} represents.
*
* @param ch the specified character
- * @return The class that <code>ch</code> represents
+ * @return The class that {@code ch} represents
*/
public static Object getValueClass(final char ch) {
switch (ch) {
@@ -135,17 +135,17 @@ public class PatternOptionBuilder {
}
/**
- * Returns whether <code>ch</code> is a value code, i.e. whether it
represents a class in a pattern.
+ * Returns whether {@code ch} is a value code, i.e. whether it represents
a class in a pattern.
*
* @param ch the specified character
- * @return true if <code>ch</code> is a value code, otherwise false.
+ * @return true if {@code ch} is a value code, otherwise false.
*/
public static boolean isValueCode(final char ch) {
return ch == '@' || ch == ':' || ch == '%' || ch == '+' || ch == '#'
|| ch == '<' || ch == '>' || ch == '*' || ch == '/' || ch == '!';
}
/**
- * Returns the {@link Options} instance represented by
<code>pattern</code>.
+ * Returns the {@link Options} instance represented by {@code pattern}.
*
* @param pattern the pattern string
* @return The {@link Options} instance
diff --git a/src/main/java/org/apache/commons/cli/PosixParser.java
b/src/main/java/org/apache/commons/cli/PosixParser.java
index 8dd736f..f4e004f 100644
--- a/src/main/java/org/apache/commons/cli/PosixParser.java
+++ b/src/main/java/org/apache/commons/cli/PosixParser.java
@@ -43,7 +43,7 @@ public class PosixParser extends Parser {
private Options options;
/**
- * Breaks <code>token</code> into its constituent parts using the
following algorithm.
+ * Breaks {@code token} into its constituent parts using the following
algorithm.
*
* <ul>
* <li>ignore the first character ("<b>-</b>")</li>
@@ -52,10 +52,10 @@ public class PosixParser extends Parser {
* tokens.</li>
* <li>if the {@link Option} can have an argument value and there are
remaining characters in the token then add the
* remaining characters as a token to the list of processed tokens.</li>
- * <li>if an {@link Option} does <b>NOT</b> exist <b>AND</b>
<code>stopAtNonOption</code> <b>IS</b> set then add the
+ * <li>if an {@link Option} does <b>NOT</b> exist <b>AND</b> {@code
stopAtNonOption} <b>IS</b> set then add the
* special token "<b>--</b>" followed by the remaining characters and also
the remaining tokens directly to the
* processed tokens list.</li>
- * <li>if an {@link Option} does <b>NOT</b> exist <b>AND</b>
<code>stopAtNonOption</code> <b>IS NOT</b> set then add
+ * <li>if an {@link Option} does <b>NOT</b> exist <b>AND</b> {@code
stopAtNonOption} <b>IS NOT</b> set then add
* that character prepended with "<b>-</b>".</li>
* </ul>
*
@@ -94,26 +94,26 @@ public class PosixParser extends Parser {
* The following are the rules used by this flatten method.
* </p>
* <ol>
- * <li>if <code>stopAtNonOption</code> is <b>true</b> then do not burst
anymore of <code>arguments</code> entries, just
- * add each successive entry without further processing. Otherwise, ignore
<code>stopAtNonOption</code>.</li>
- * <li>if the current <code>arguments</code> entry is "<b>--</b>" just add
the entry to the list of processed
+ * <li>if {@code stopAtNonOption} is <b>true</b> then do not burst anymore
of {@code arguments} entries, just
+ * add each successive entry without further processing. Otherwise, ignore
{@code stopAtNonOption}.</li>
+ * <li>if the current {@code arguments} entry is "<b>--</b>" just add the
entry to the list of processed
* tokens</li>
- * <li>if the current <code>arguments</code> entry is "<b>-</b>" just add
the entry to the list of processed tokens</li>
- * <li>if the current <code>arguments</code> entry is two characters in
length and the first character is "<b>-</b>"
+ * <li>if the current {@code arguments} entry is "<b>-</b>" just add the
entry to the list of processed tokens</li>
+ * <li>if the current {@code arguments} entry is two characters in length
and the first character is "<b>-</b>"
* then check if this is a valid {@link Option} id. If it is a valid id,
then add the entry to the list of processed
- * tokens and set the current {@link Option} member. If it is not a valid
id and <code>stopAtNonOption</code> is true,
+ * tokens and set the current {@link Option} member. If it is not a valid
id and {@code stopAtNonOption} is true,
* then the remaining entries are copied to the list of processed tokens.
Otherwise, the current entry is ignored.</li>
- * <li>if the current <code>arguments</code> entry is more than two
characters in length and the first character is
+ * <li>if the current {@code arguments} entry is more than two characters
in length and the first character is
* "<b>-</b>" then we need to burst the entry to determine its
constituents. For more information on the bursting
* algorithm see {@link PosixParser#burstToken(String, boolean)
burstToken}.</li>
- * <li>if the current <code>arguments</code> entry is not handled by any
of the previous rules, then the entry is added
+ * <li>if the current {@code arguments} entry is not handled by any of the
previous rules, then the entry is added
* to the list of processed tokens.</li>
* </ol>
*
* @param options The command line {@link Options}
* @param arguments The command line arguments to be parsed
* @param stopAtNonOption Specifies whether to stop flattening when an non
option is found.
- * @return The flattened <code>arguments</code> String array.
+ * @return The flattened {@code arguments} String array.
*/
@Override
protected String[] flatten(final Options options, final String[]
arguments, final boolean stopAtNonOption) throws ParseException {
@@ -193,8 +193,8 @@ public class PosixParser extends Parser {
}
/**
- * Resets the members to their original state i.e. remove all of
<code>tokens</code> entries and set
- * <code>eatTheRest</code> to false.
+ * Resets the members to their original state i.e. remove all of {@code
tokens} entries and set
+ * {@code eatTheRest} to false.
*/
private void init() {
eatTheRest = false;
@@ -202,8 +202,8 @@ public class PosixParser extends Parser {
}
/**
- * Add the special token "<b>--</b>" and the current <code>value</code> to
the processed tokens list. Then add all the
- * remaining <code>argument</code> values to the processed tokens list.
+ * Add the special token "<b>--</b>" and the current {@code value} to the
processed tokens list. Then add all the
+ * remaining {@code argument} values to the processed tokens list.
*
* @param value The current token
*/
@@ -218,11 +218,11 @@ public class PosixParser extends Parser {
/**
* <p>
- * If an {@link Option} exists for <code>token</code> then add the token
to the processed list.
+ * If an {@link Option} exists for {@code token} then add the token to the
processed list.
* </p>
*
* <p>
- * If an {@link Option} does not exist and <code>stopAtNonOption</code> is
set then add the remaining tokens to the
+ * If an {@link Option} does not exist and {@code stopAtNonOption} is set
then add the remaining tokens to the
* processed tokens list directly.
* </p>
*
diff --git a/src/main/java/org/apache/commons/cli/TypeHandler.java
b/src/main/java/org/apache/commons/cli/TypeHandler.java
index 9865d9b..abb7016 100644
--- a/src/main/java/org/apache/commons/cli/TypeHandler.java
+++ b/src/main/java/org/apache/commons/cli/TypeHandler.java
@@ -30,7 +30,7 @@ import java.util.Date;
*/
public class TypeHandler {
/**
- * Returns the class whose name is <code>classname</code>.
+ * Returns the class whose name is {@code classname}.
*
* @param classname the class name
* @return The class if it is found
@@ -45,12 +45,12 @@ public class TypeHandler {
}
/**
- * Returns the date represented by <code>str</code>.
+ * Returns the date represented by {@code str}.
* <p>
* This method is not yet implemented and always throws an {@link
UnsupportedOperationException}.
*
* @param str the date string
- * @return The date if <code>str</code> is a valid date string, otherwise
return null.
+ * @return The date if {@code str} is a valid date string, otherwise
return null.
* @throws UnsupportedOperationException always
*/
public static Date createDate(final String str) {
@@ -58,22 +58,22 @@ public class TypeHandler {
}
/**
- * Returns the File represented by <code>str</code>.
+ * Returns the File represented by {@code str}.
*
* @param str the File location
- * @return The file represented by <code>str</code>.
+ * @return The file represented by {@code str}.
*/
public static File createFile(final String str) {
return new File(str);
}
/**
- * Returns the File[] represented by <code>str</code>.
+ * Returns the File[] represented by {@code str}.
* <p>
* This method is not yet implemented and always throws an {@link
UnsupportedOperationException}.
*
* @param str the paths to the files
- * @return The File[] represented by <code>str</code>.
+ * @return The File[] represented by {@code str}.
* @throws UnsupportedOperationException always
*/
public static File[] createFiles(final String str) {
@@ -86,8 +86,8 @@ public class TypeHandler {
* Create a number from a String. If a . is present, it creates a Double,
otherwise a Long.
*
* @param str the value
- * @return the number represented by <code>str</code>
- * @throws ParseException if <code>str</code> is not a number
+ * @return the number represented by {@code str}
+ * @throws ParseException if {@code str} is not a number
*/
public static Number createNumber(final String str) throws ParseException {
try {
@@ -124,11 +124,11 @@ public class TypeHandler {
}
/**
- * Returns the URL represented by <code>str</code>.
+ * Returns the URL represented by {@code str}.
*
* @param str the URL string
- * @return The URL in <code>str</code> is well-formed
- * @throws ParseException if the URL in <code>str</code> is not well-formed
+ * @return The URL in {@code str} is well-formed
+ * @throws ParseException if the URL in {@code str} is not well-formed
*/
public static URL createURL(final String str) throws ParseException {
try {
@@ -139,12 +139,12 @@ public class TypeHandler {
}
/**
- * Returns the <code>Object</code> of type <code>clazz</code> with the
value of <code>str</code>.
+ * Returns the {@code Object} of type {@code clazz} with the value of
{@code str}.
*
* @param str the command line value
* @param clazz the class representing the type of argument
* @param <T> type of argument
- * @return The instance of <code>clazz</code> initialized with the value
of <code>str</code>.
+ * @return The instance of {@code clazz} initialized with the value of
{@code str}.
* @throws ParseException if the value creation for the given class failed
*/
@SuppressWarnings("unchecked") // returned value will have type T because
it is fixed by clazz
@@ -180,11 +180,11 @@ public class TypeHandler {
}
/**
- * Returns the <code>Object</code> of type <code>obj</code> with the value
of <code>str</code>.
+ * Returns the {@code Object} of type {@code obj} with the value of {@code
str}.
*
* @param str the command line value
* @param obj the type of argument
- * @return The instance of <code>obj</code> initialized with the value of
<code>str</code>.
+ * @return The instance of {@code obj} initialized with the value of
{@code str}.
* @throws ParseException if the value creation for the given object type
failed
*/
public static Object createValue(final String str, final Object obj)
throws ParseException {
@@ -192,10 +192,10 @@ public class TypeHandler {
}
/**
- * Returns the opened FileInputStream represented by <code>str</code>.
+ * Returns the opened FileInputStream represented by {@code str}.
*
* @param str the file location
- * @return The file input stream represented by <code>str</code>.
+ * @return The file input stream represented by {@code str}.
* @throws ParseException if the file is not exist or not readable
*/
public static FileInputStream openFile(final String str) throws
ParseException {
diff --git
a/src/main/java/org/apache/commons/cli/UnrecognizedOptionException.java
b/src/main/java/org/apache/commons/cli/UnrecognizedOptionException.java
index fbb0657..df9bdf8 100644
--- a/src/main/java/org/apache/commons/cli/UnrecognizedOptionException.java
+++ b/src/main/java/org/apache/commons/cli/UnrecognizedOptionException.java
@@ -31,7 +31,7 @@ public class UnrecognizedOptionException extends
ParseException {
private final String option;
/**
- * Constructs a new <code>UnrecognizedArgumentException</code> with the
specified detail message.
+ * Constructs a new {@code UnrecognizedArgumentException} with the
specified detail message.
*
* @param message the detail message
*/
@@ -40,7 +40,7 @@ public class UnrecognizedOptionException extends
ParseException {
}
/**
- * Constructs a new <code>UnrecognizedArgumentException</code> with the
specified option and detail message.
+ * Constructs a new {@code UnrecognizedArgumentException} with the
specified option and detail message.
*
* @param message the detail message
* @param option the unrecognized option
diff --git a/src/main/java/org/apache/commons/cli/Util.java
b/src/main/java/org/apache/commons/cli/Util.java
index 2d53e4f..7e44fbb 100644
--- a/src/main/java/org/apache/commons/cli/Util.java
+++ b/src/main/java/org/apache/commons/cli/Util.java
@@ -22,7 +22,7 @@ package org.apache.commons.cli;
*/
final class Util {
/**
- * Remove the leading and trailing quotes from <code>str</code>. E.g. if
str is '"one two"', then 'one two' is returned.
+ * Remove the leading and trailing quotes from {@code str}. E.g. if str is
'"one two"', then 'one two' is returned.
*
* @param str The string from which the leading and trailing quotes should
be removed.
*
@@ -38,7 +38,7 @@ final class Util {
}
/**
- * Remove the hyphens from the beginning of <code>str</code> and return
the new String.
+ * Remove the hyphens from the beginning of {@code str} and return the new
String.
*
* @param str The string from which the hyphens should be removed.
*
diff --git a/src/main/java/org/apache/commons/cli/overview.html
b/src/main/java/org/apache/commons/cli/overview.html
index 86bbcc9..5c6e4dd 100644
--- a/src/main/java/org/apache/commons/cli/overview.html
+++ b/src/main/java/org/apache/commons/cli/overview.html
@@ -23,8 +23,8 @@ limitations under the License.
<p>Allow command-line arguments to be parsed against a descriptor of
valid options (long and short), potentially with arguments.</p>
- <p>command-line arguments may be of the typical <code>String[]</code>
- form, but also may be a <code>java.util.List</code>. Indexes allow
+ <p>command-line arguments may be of the typical {@code String[]}
+ form, but also may be a {@code java.util.List}. Indexes allow
for parsing only a portion of the command-line. Also, functionality
for parsing the command-line in phases is built in, allowing for
'cvs-style' command-lines, where some global options are specified
