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 28f54ac8 Fix Javadoc warnings
28f54ac8 is described below
commit 28f54ac8083a991dd7d785af42b9d37c76a940d9
Author: Gary Gregory <[email protected]>
AuthorDate: Sun Oct 29 07:30:31 2023 -0400
Fix Javadoc warnings
---
.../commons/compress/archivers/jar/JarArchiveEntry.java | 3 ++-
.../archivers/zip/AbstractUnicodeExtraField.java | 17 +++++++++++++----
.../compress/harmony/unpack200/AttributeLayout.java | 2 +-
.../unpack200/bytecode/AnnotationDefaultAttribute.java | 5 +++++
.../commons/compress/utils/InputStreamStatistics.java | 9 +++++++--
5 files changed, 28 insertions(+), 8 deletions(-)
diff --git
a/src/main/java/org/apache/commons/compress/archivers/jar/JarArchiveEntry.java
b/src/main/java/org/apache/commons/compress/archivers/jar/JarArchiveEntry.java
index a2118a6a..5874344c 100644
---
a/src/main/java/org/apache/commons/compress/archivers/jar/JarArchiveEntry.java
+++
b/src/main/java/org/apache/commons/compress/archivers/jar/JarArchiveEntry.java
@@ -28,6 +28,7 @@ import java.util.zip.ZipException;
import org.apache.commons.compress.archivers.zip.ZipArchiveEntry;
/**
+ * JAR archive entry.
*
* @NotThreadSafe (parent is not thread-safe)
*/
@@ -55,7 +56,7 @@ public class JarArchiveEntry extends ZipArchiveEntry {
}
/**
- * Return a copy of the list of certificates or null if there are none.
+ * Gets a copy of the list of certificates or null if there are none.
*
* @return Always returns null in the current implementation
*
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/AbstractUnicodeExtraField.java
b/src/main/java/org/apache/commons/compress/archivers/zip/AbstractUnicodeExtraField.java
index 70f2c471..fdbf7579 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/AbstractUnicodeExtraField.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/AbstractUnicodeExtraField.java
@@ -32,6 +32,9 @@ public abstract class AbstractUnicodeExtraField implements
ZipExtraField {
private byte[] unicodeName;
private byte[] data;
+ /**
+ * Constructs a new instance.
+ */
protected AbstractUnicodeExtraField() {
}
@@ -110,14 +113,17 @@ public abstract class AbstractUnicodeExtraField
implements ZipExtraField {
}
/**
- * @return The CRC32 checksum of the file name or comment as
- * encoded in the central directory of the ZIP file.
+ * Gets the CRC32 checksum of the file name or comment as encoded in the
central directory of the ZIP file.
+ *
+ * @return The CRC32 checksum of the file name or comment as encoded in
the central directory of the ZIP file.
*/
public long getNameCRC32() {
return nameCRC32;
}
/**
+ * Gets The UTF-8 encoded name.
+ *
* @return The UTF-8 encoded name.
*/
public byte[] getUnicodeName() {
@@ -157,8 +163,9 @@ public abstract class AbstractUnicodeExtraField implements
ZipExtraField {
}
/**
- * @param nameCRC32 The CRC32 checksum of the file name as encoded
- * in the central directory of the ZIP file to set.
+ * Gets The CRC32 checksum of the file name as encoded in the central
directory of the ZIP file to set.
+ *
+ * @param nameCRC32 The CRC32 checksum of the file name as encoded in the
central directory of the ZIP file to set.
*/
public void setNameCRC32(final long nameCRC32) {
this.nameCRC32 = nameCRC32;
@@ -166,6 +173,8 @@ public abstract class AbstractUnicodeExtraField implements
ZipExtraField {
}
/**
+ * Gets the UTF-8 encoded name to set.
+ *
* @param unicodeName The UTF-8 encoded name to set.
*/
public void setUnicodeName(final byte[] unicodeName) {
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/AttributeLayout.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/AttributeLayout.java
index dd6fefd3..32b70022 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/AttributeLayout.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/AttributeLayout.java
@@ -210,7 +210,7 @@ public class AttributeLayout implements IMatcher {
public static final int CONTEXT_METHOD = 2;
/**
- * {@value}
+ * Context names.
*/
public static final String[] contextNames = {"Class", "Field", "Method",
//$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
"Code",}; //$NON-NLS-1$
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/AnnotationDefaultAttribute.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/AnnotationDefaultAttribute.java
index a755d817..1ab8ada6 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/AnnotationDefaultAttribute.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/AnnotationDefaultAttribute.java
@@ -34,6 +34,11 @@ public class AnnotationDefaultAttribute extends
AnnotationsAttribute {
private final ElementValue elementValue;
+ /**
+ * Constructs a new instance.
+ *
+ * @param elementValue element value to track.
+ */
public AnnotationDefaultAttribute(final ElementValue elementValue) {
super(attributeName);
this.elementValue = elementValue;
diff --git
a/src/main/java/org/apache/commons/compress/utils/InputStreamStatistics.java
b/src/main/java/org/apache/commons/compress/utils/InputStreamStatistics.java
index 9a3a2ef3..554d53f3 100644
--- a/src/main/java/org/apache/commons/compress/utils/InputStreamStatistics.java
+++ b/src/main/java/org/apache/commons/compress/utils/InputStreamStatistics.java
@@ -25,13 +25,18 @@ package org.apache.commons.compress.utils;
* @since 1.17
*/
public interface InputStreamStatistics {
+
/**
- * @return the amount of raw or compressed bytes read by the stream
+ * Gets the amount of raw or compressed bytes read by the stream.
+ *
+ * @return the amount of raw or compressed bytes read by the stream.
*/
long getCompressedCount();
/**
- * @return the amount of decompressed bytes returned by the stream
+ * Gets the amount of decompressed bytes returned by the stream.
+ *
+ * @return the amount of decompressed bytes returned by the stream.
*/
long getUncompressedCount();
}
