Make doclint happy

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/cli/trunk@1677406 13f79535-47bb-0310-9956-ffa450edef68

Author: britter

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

@@ -664,6 +664,8 @@ private void updateRequiredOptions(Option option) throws AlreadySelectedExceptio
      *
      * @param token The current token to be <b>burst</b>
      * at the first non-Option encountered.
+     * @throws ParseException if there are any problems encountered
+     *                        while parsing the command line token.
      */
     protected void handleConcatenatedOptions(String token) throws ParseException
     {

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

@@ -58,10 +58,10 @@
  * This produces the following output:
  * 
  * <pre>
- * usage: myapp -f <FILE> [-h] [-v]
+ * usage: myapp -f &lt;FILE&gt; [-h] [-v]
  * Do something useful with an input file
  * 
- *  -f,--file &lt;FILE>   The file to be processed
+ *  -f,--file &lt;FILE&gt;   The file to be processed
  *  -h,--help
  *  -v,--version       Print the version of the application
  * 

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

@@ -666,7 +666,7 @@ public int hashCode()
      *
      * @return a clone of this Option instance
      * @throws RuntimeException if a {@link CloneNotSupportedException} has been thrown
-     * by {@link super#clone()}
+     * by {@code super.clone()}
      */
     @Override
     public Object clone()

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

@@ -67,6 +67,8 @@ protected List getRequiredOptions()
      * @param stopAtNonOption specifies whether to stop
      * flattening when a non option has been encountered
      * @return a String array of the flattened arguments
+     * @throws ParseException if there are any problems encountered
+     *                        while parsing the command line tokens.
      */
     protected abstract String[] flatten(Options opts, String[] arguments, boolean stopAtNonOption)
             throws ParseException;
@@ -78,8 +80,8 @@ protected abstract String[] flatten(Options opts, String[] arguments, boolean st
      * @param options the <code>Options</code>
      * @param arguments the <code>arguments</code>
      * @return the <code>CommandLine</code>
-     * @throws ParseException if an error occurs when parsing the
-     * arguments.
+     * @throws ParseException if there are any problems encountered
+     *                        while parsing the command line tokens.
      */
     public CommandLine parse(Options options, String[] arguments) throws ParseException
     {
@@ -246,6 +248,8 @@ else if (t.startsWith("-"))
      * Sets the values of Options using the values in <code>properties</code>.
      *
      * @param properties The value properties to be processed.
+     * @throws ParseException if there are any problems encountered
+     *                        while processing the properties.
      */
     protected void processProperties(Properties properties) throws ParseException
     {

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

@@ -23,29 +23,34 @@
 import java.util.Date;
 
 /**
- * Allows Options to be created from a single String.
+ * <p>Allows Options to be created from a single String.
  * The pattern contains various single character flags and via
  * an optional punctuation character, their expected type.
- * <p>
+ * </p>
+ * 
  * <table border="1">
- * <tr><td>a</td><td>-a flag</td></tr>
- * <tr><td>b@</td><td>-b [classname]</td></tr>
- * <tr><td>c&gt;</td><td>-c [filename]</td></tr>
- * <tr><td>d+</td><td>-d [classname] (creates object via empty constructor)</td></tr>
- * <tr><td>e%</td><td>-e [number] (creates Double/Long instance depending on existing of a '.')</td></tr>
- * <tr><td>f/</td><td>-f [url]</td></tr>
- * <tr><td>g:</td><td>-g [string]</td></tr>
+ *   <caption>Overview of PatternOptionBuilder patterns</caption>
+ *   <tr><td>a</td><td>-a flag</td></tr>
+ *   <tr><td>b@</td><td>-b [classname]</td></tr>
+ *   <tr><td>c&gt;</td><td>-c [filename]</td></tr>
+ *   <tr><td>d+</td><td>-d [classname] (creates object via empty constructor)</td></tr>
+ *   <tr><td>e%</td><td>-e [number] (creates Double/Long instance depending on existing of a '.')</td></tr>
+ *   <tr><td>f/</td><td>-f [url]</td></tr>
+ *   <tr><td>g:</td><td>-g [string]</td></tr>
  * </table>
+ * 
  * <p>
  * For example, the following allows command line flags of '-v -p string-value -f /dir/file'.
  * The exclamation mark precede a mandatory option.
+ * </p>
  *
  * <pre>
  *     Options options = PatternOptionBuilder.parsePattern("vp:!f/");
  * </pre>
  *
  * <p>
- * TODO These need to break out to OptionType and also to be pluggable.
+ * TODO: These need to break out to OptionType and also to be pluggable.
+ * </p>
  *
  * @version $Id$
  */

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

@@ -59,7 +59,7 @@ private void init()
      * <p>An implementation of {@link Parser}'s abstract
      * {@link Parser#flatten(Options,String[],boolean) flatten} method.</p>
      *
-     * <p>The following are the rules used by this flatten method.
+     * <p>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
@@ -85,7 +85,6 @@ private void init()
      *  by any of the previous rules, then the entry is added to the list
      *  of processed tokens.</li>
      * </ol>
-     * </p>
      *
      * @param options The command line {@link Options}
      * @param arguments The command line arguments to be parsed