svn commit: r1552758 - /commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveInputStream.java

[ggregory]

Author: ggregory
Date: Fri Dec 20 17:41:01 2013
New Revision: 1552758

URL: http://svn.apache.org/r1552758
Log:
Javadoc.

Modified:
    
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveInputStream.java

Modified: 
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveInputStream.java
URL: 
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveInputStream.java?rev=1552758&r1=1552757&r2=1552758&view=diff
==============================================================================
--- 
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveInputStream.java
 (original)
+++ 
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveInputStream.java
 Fri Dec 20 17:41:01 2013
@@ -137,15 +137,18 @@ public abstract class ArchiveInputStream
 
     /**
      * Whether this stream is able to read the given entry.
-     *
-     * <p>Some archive formats support variants or details that are
-     * not supported (yet).</p>
-     *
-     * <p>This implementation always returns true.
-     *
+     * 
+     * <p>
+     * Some archive formats support variants or details that are not supported 
(yet).
+     * </p>
+     * 
+     * @param archiveEntry
+     *            the entry to test
+     * @return This implementation always returns true.
+     * 
      * @since 1.1
      */
-    public boolean canReadEntryData(ArchiveEntry ae) {
+    public boolean canReadEntryData(ArchiveEntry archiveEntry) {
         return true;
     }