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 81e13f0ad Javadoc
81e13f0ad is described below
commit 81e13f0ad13259b9380a353613b37067ae2cfeca
Author: Gary Gregory <[email protected]>
AuthorDate: Fri Nov 15 20:22:48 2024 -0500
Javadoc
---
.../apache/commons/compress/archivers/ArchiveException.java | 9 +++++----
.../commons/compress/compressors/CompressorException.java | 11 ++++++-----
2 files changed, 11 insertions(+), 9 deletions(-)
diff --git
a/src/main/java/org/apache/commons/compress/archivers/ArchiveException.java
b/src/main/java/org/apache/commons/compress/archivers/ArchiveException.java
index de22b5725..5be299dc4 100644
--- a/src/main/java/org/apache/commons/compress/archivers/ArchiveException.java
+++ b/src/main/java/org/apache/commons/compress/archivers/ArchiveException.java
@@ -19,7 +19,7 @@
package org.apache.commons.compress.archivers;
/**
- * Archiver related Exception.
+ * Signals that an Archive exception of some sort has occurred.
*/
public class ArchiveException extends Exception {
@@ -29,7 +29,7 @@ public class ArchiveException extends Exception {
/**
* Constructs a new exception with the specified detail message. The cause
is not initialized.
*
- * @param message the detail message.
+ * @param message The message (which is saved for later retrieval by the
{@link #getMessage()} method).
*/
public ArchiveException(final String message) {
super(message);
@@ -38,8 +38,9 @@ public class ArchiveException extends Exception {
/**
* Constructs a new exception with the specified detail message and cause.
*
- * @param message the detail message.
- * @param cause the cause.
+ * @param message The message (which is saved for later retrieval by the
{@link #getMessage()} method).
+ * @param cause The cause (which is saved for later retrieval by the
{@link #getCause()} method). A null value indicates that the cause is
nonexistent or
+ * unknown.
*/
public ArchiveException(final String message, final Exception cause) {
super(message, cause);
diff --git
a/src/main/java/org/apache/commons/compress/compressors/CompressorException.java
b/src/main/java/org/apache/commons/compress/compressors/CompressorException.java
index d6635c94f..7b79107a1 100644
---
a/src/main/java/org/apache/commons/compress/compressors/CompressorException.java
+++
b/src/main/java/org/apache/commons/compress/compressors/CompressorException.java
@@ -19,17 +19,17 @@
package org.apache.commons.compress.compressors;
/**
- * Compressor related exception
+ * Signals that an Compressor exception of some sort has occurred.
*/
public class CompressorException extends Exception {
- /** Serial */
+ /** Serial. */
private static final long serialVersionUID = -2932901310255908814L;
/**
* Constructs a new exception with the specified detail message. The cause
is not initialized.
*
- * @param message the detail message
+ * @param message The message (which is saved for later retrieval by the
{@link #getMessage()} method).
*/
public CompressorException(final String message) {
super(message);
@@ -38,8 +38,9 @@ public class CompressorException extends Exception {
/**
* Constructs a new exception with the specified detail message and cause.
*
- * @param message the detail message
- * @param cause the cause
+ * @param message The message (which is saved for later retrieval by the
{@link #getMessage()} method)
+ * @param cause The cause (which is saved for later retrieval by the
{@link #getCause()} method). A null indicates that the cause is nonexistent or
+ * unknown.
*/
public CompressorException(final String message, final Throwable cause) {
super(message, cause);
