improved javadoc info describing how to use PatternOptionBuilder

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

Author: hen

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

@@ -16,10 +16,30 @@
 package org.apache.commons.cli;
 
 /** 
+ * <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>
  *
+ * <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 contructor)</td></tr>
+ * <tr><td>e%</td><td>-e [number] (creates Number instance)</td></tr>
+ * <tr><td>f/</td><td>-f [url]</td></tr>
+ * </table>
+ *
+ * <p>
+ * For example, the following allows command line flags of '-v -p string-value -f /dir/file'.
+ * </p>
+ * <code>Options options = PatternOptionBuilder.parsePattern("vp:f/");</code>
+ *
+ * <p>
  * TODO These need to break out to OptionType and also 
  * to be pluggable.
+ * </p>
  *
  * @author Henri Yandell (bayard @ generationjava.com)
  * @version $Revision: 1.2 $
@@ -185,4 +205,4 @@ else if (ch == '!')
 
         return options;
     }
-}
+}