[commons-compress] branch master updated: Javadoc.

[ggregory]

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-compress.git


The following commit(s) were added to refs/heads/master by this push:
     new 367eeaf  Javadoc.
367eeaf is described below

commit 367eeaf62eaee0cd8826f930c4987e835876673f
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sun Feb 13 10:17:05 2022 -0500

    Javadoc.
---
 .../org/apache/commons/compress/archivers/Lister.java     | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/src/main/java/org/apache/commons/compress/archivers/Lister.java 
b/src/main/java/org/apache/commons/compress/archivers/Lister.java
index dd70d64..2a4c71f 100644
--- a/src/main/java/org/apache/commons/compress/archivers/Lister.java
+++ b/src/main/java/org/apache/commons/compress/archivers/Lister.java
@@ -42,7 +42,20 @@ public final class Lister {
 
     private static final ArchiveStreamFactory FACTORY = 
ArchiveStreamFactory.DEFAULT;
 
-    public static void main(final String[] args) throws Exception {
+    /**
+     * Runs this class from the command line.
+     * <p>
+     * The name of the archive must be given as a command line argument.
+     * </p>
+     * <p>
+     * The optional second argument defines the archive type, in case the 
format is not recognized.
+     * </p>
+     * 
+     * @param args name of the archive and optional argument archive type.
+     * @throws ArchiveException Archiver related Exception.
+     * @throws IOException an I/O exception.
+     */
+    public static void main(final String[] args) throws ArchiveException, 
IOException {
         if (args.length == 0) {
             usage();
             return;