Fix Javadoc warnings

Author: garydgregory

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

@@ -25,6 +25,14 @@ Licensed to the Apache Software Foundation (ASF) under one or more
  */
 @Deprecated
 public class BasicParser extends Parser {
+
+    /**
+     * Constructs a new instance.
+     */
+    public BasicParser() {
+        // empty
+    }
+
     /**
      * <p>
      * A simple implementation of {@link Parser}'s abstract {@link Parser#flatten(Options, String[], boolean) flatten}

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

@@ -28,6 +28,14 @@ Licensed to the Apache Software Foundation (ASF) under one or more
  */
 @Deprecated
 public class GnuParser extends Parser {
+
+    /**
+     * Constructs a new instance.
+     */
+    public GnuParser() {
+        // empty
+    }
+
     /**
      * This flatten method does so using the following rules:
      * <ol>

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

@@ -78,6 +78,13 @@ public static class Builder implements Supplier<HelpFormatter> {
         // TODO All other instance HelpFormatter instance variables.
         // Make HelpFormatter immutable for 2.0
 
+        /**
+         * Constructs a new instance.
+         */
+        public Builder() {
+            // empty
+        }
+
         /**
          * A function to convert a description (not null) and a deprecated Option (not null) to help description
          */

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

@@ -28,6 +28,13 @@ Licensed to the Apache Software Foundation (ASF) under one or more
  */
 public class OptionGroup implements Serializable {
 
+    /**
+     * Constructs a new instance.
+     */
+    public OptionGroup() {
+        // empty
+    }
+
     /** The serial version UID. */
     private static final long serialVersionUID = 1L;
 

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

@@ -39,6 +39,14 @@ Licensed to the Apache Software Foundation (ASF) under one or more
  * @see org.apache.commons.cli.CommandLine
  */
 public class Options implements Serializable {
+
+    /**
+     * Constructs new instance.
+     */
+    public Options() {
+        // empty
+    }
+
     /** The serial version UID. */
     private static final long serialVersionUID = 1L;
 

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

@@ -31,6 +31,7 @@ Licensed to the Apache Software Foundation (ASF) under one or more
  */
 @Deprecated
 public abstract class Parser implements CommandLineParser {
+
     /** CommandLine instance */
     protected CommandLine cmd;
 
@@ -40,6 +41,13 @@ public abstract class Parser implements CommandLineParser {
     /** List of required options strings */
     private List requiredOptions;
 
+    /**
+     * Constructs a new instance.
+     */
+    public Parser() {
+        // empty
+    }
+
     /**
      * Throws a {@link MissingOptionException} if all of the required options are not present.
      *

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

@@ -77,7 +77,7 @@ public class PatternOptionBuilder {
     /**
      * Deprecated, only provides static methods.
      *
-     * @deprecated Will be private or class will be final. 
+     * @deprecated Will be private or class will be final.
      */
     @Deprecated
     public PatternOptionBuilder() {

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

@@ -30,6 +30,7 @@ Licensed to the Apache Software Foundation (ASF) under one or more
  */
 @Deprecated
 public class PosixParser extends Parser {
+
     /** Holder for flattened tokens */
     private final List<String> tokens = new ArrayList<>();
 
@@ -42,6 +43,13 @@ public class PosixParser extends Parser {
     /** The command line Options */
     private Options options;
 
+    /**
+     * Constructs a new instance.
+     */
+    public PosixParser() {
+        // empty
+    }
+
     /**
      * Breaks {@code token} into its constituent parts using the following algorithm.
      *

src/main/javadoc/overview.html

@@ -14,18 +14,21 @@
 See the License for the specific language governing permissions and
 limitations under the License.
 -->
+<html>
+<head>
+<title>Apache Commons CLI Overview</title>
+</head>
 <body>
+  <img src="../images/commons-logo.png" alt="Apache Commons CLI">
 
-    <p>Apache Commons CLI.</p>
+    <p>The Commons CLI component parses command-line arguments for your application.</p>
 
-    <p>The commons-cli package aides in parsing command-line arguments.</p>
-
-    <p>Allow command-line arguments to be parsed against a descriptor of
+    <p>Commons CLI parses command-line arguments using a descriptor of
     valid options (long and short), potentially with arguments.</p>
 
-    <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
+    <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
     before a 'command' argument, and command-specific options are

src/site/xdoc/index.xml

@@ -28,8 +28,8 @@
   <body>
     <section name="Apache Commons CLI">
       <p>
-        The Apache Commons CLI library provides an API for parsing command line options passed to programs.
-        It's also able to print help messages detailing the options available for a command line tool.
+        The Apache Commons CLI library provides an API for parsing command-line options passed to an application.
+        It can also print help detailing the options available for that application.
       </p>
       <p>
         Commons CLI supports different types of options: