Javadoc: Use @code instead of HTML tags.

Author: garydgregory

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 AlreadySelectedException(final OptionGroup group, final Option option) {
     }
 
     /**
-     * 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
      */

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,

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

@@ -35,7 +35,7 @@ Licensed to the Apache Software Foundation (ASF) under one or more
  */
 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 @@ protected void addOption(final Option opt) {
     /**
      * 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 String[] getArgs() {
     }
 
     /**
-     * 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 Object getOptionObject(final char opt) {
     }
 
     /**
-     * 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 Object getOptionObject(final String opt) {
      * 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 Properties getOptionProperties(final Option option) {
      * 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 String getOptionValue(final char opt) {
      *
      * @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 String getOptionValue(final Option option) {
      *
      * @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 String getOptionValue(final String opt) {
      *
      * @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 String[] getOptionValues(final String opt) {
     }
 
     /**
-     * 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 Object getParsedOptionValue(final char opt) throws ParseException {
     }
 
     /**
-     * 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 Object getParsedOptionValue(final Option option) throws ParseException {
     }
 
     /**
-     * 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 boolean hasOption(final String opt) {
     /**
      * 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();

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

@@ -18,7 +18,7 @@ Licensed to the Apache Software Foundation (ASF) under one or more
 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

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 DefaultParser() {
      * }
      * </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 @@ private List<String> getMatchingLongOptions(final String token) {
     }
 
     /**
-     * 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 @@ private List<String> getMatchingLongOptions(final String token) {
      * 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 @@ private void handleOption(Option option) throws ParseException {
     }
 
     /**
-     * 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 CommandLine parse(final Options options, final String[] arguments, final
      * @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

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>