You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2023/12/21 22:19:46 UTC
(commons-compress) 04/04: Javadoc spelling
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
commit 87a96f1c759f492dde8549051eb007a66b8b9653
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Thu Dec 21 17:08:40 2023 -0500
Javadoc spelling
---
.../apache/commons/compress/archivers/zip/AsiExtraField.java | 2 +-
.../commons/compress/archivers/zip/ZipEightByteInteger.java | 12 ++++++------
.../org/apache/commons/compress/archivers/zip/ZipLong.java | 10 +++++-----
.../org/apache/commons/compress/archivers/zip/ZipShort.java | 10 +++++-----
4 files changed, 17 insertions(+), 17 deletions(-)
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/AsiExtraField.java b/src/main/java/org/apache/commons/compress/archivers/zip/AsiExtraField.java
index 0578e42a8..856c4c918 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/AsiExtraField.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/AsiExtraField.java
@@ -49,7 +49,7 @@ import java.util.zip.ZipException;
* </p>
*
* <p>
- * Short is two bytes and Long is four bytes in big endian byte and word order, device numbers are currently not supported.
+ * Short is two bytes and Long is four bytes in big-endian byte and word order, device numbers are currently not supported.
* </p>
*
* @NotThreadSafe
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ZipEightByteInteger.java b/src/main/java/org/apache/commons/compress/archivers/zip/ZipEightByteInteger.java
index 8cd0ab6b3..01190cdb4 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipEightByteInteger.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipEightByteInteger.java
@@ -65,10 +65,10 @@ public final class ZipEightByteInteger implements Serializable {
public static final ZipEightByteInteger ZERO = new ZipEightByteInteger(0);
/**
- * Gets value as eight bytes in big endian byte order.
+ * Gets value as eight bytes in big-endian byte order.
*
* @param value the value to convert
- * @return value as eight bytes in big endian byte order
+ * @return value as eight bytes in big-endian byte order
*/
public static byte[] getBytes(final BigInteger value) {
final byte[] result = new byte[8];
@@ -88,10 +88,10 @@ public final class ZipEightByteInteger implements Serializable {
}
/**
- * Gets value as eight bytes in big endian byte order.
+ * Gets value as eight bytes in big-endian byte order.
*
* @param value the value to convert
- * @return value as eight bytes in big endian byte order
+ * @return value as eight bytes in big-endian byte order
*/
public static byte[] getBytes(final long value) {
return getBytes(BigInteger.valueOf(value));
@@ -202,9 +202,9 @@ public final class ZipEightByteInteger implements Serializable {
}
/**
- * Gets value as eight bytes in big endian byte order.
+ * Gets value as eight bytes in big-endian byte order.
*
- * @return value as eight bytes in big endian order
+ * @return value as eight bytes in big-endian order
*/
public byte[] getBytes() {
return ZipEightByteInteger.getBytes(value);
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ZipLong.java b/src/main/java/org/apache/commons/compress/archivers/zip/ZipLong.java
index 9412ef4aa..7fbdbbea5 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipLong.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipLong.java
@@ -73,10 +73,10 @@ public final class ZipLong implements Cloneable, Serializable {
public static final ZipLong AED_SIG = new ZipLong(0X08064B50L);
/**
- * Gets value as four bytes in big endian byte order.
+ * Gets value as four bytes in big-endian byte order.
*
* @param value the value to convert
- * @return value as four bytes in big endian byte order
+ * @return value as four bytes in big-endian byte order
*/
public static byte[] getBytes(final long value) {
final byte[] result = new byte[WORD];
@@ -106,7 +106,7 @@ public final class ZipLong implements Cloneable, Serializable {
}
/**
- * put the value as four bytes in big endian byte order.
+ * put the value as four bytes in big-endian byte order.
*
* @param value the Java long to convert to bytes
* @param buf the output buffer
@@ -182,9 +182,9 @@ public final class ZipLong implements Cloneable, Serializable {
}
/**
- * Gets value as four bytes in big endian byte order.
+ * Gets value as four bytes in big-endian byte order.
*
- * @return value as four bytes in big endian order
+ * @return value as four bytes in big-endian order
*/
public byte[] getBytes() {
return ZipLong.getBytes(value);
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ZipShort.java b/src/main/java/org/apache/commons/compress/archivers/zip/ZipShort.java
index e103d65e0..e8bb23d95 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipShort.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipShort.java
@@ -36,10 +36,10 @@ public final class ZipShort implements Cloneable, Serializable {
private static final long serialVersionUID = 1L;
/**
- * Gets value as two bytes in big endian byte order.
+ * Gets value as two bytes in big-endian byte order.
*
* @param value the Java int to convert to bytes
- * @return the converted int as a byte array in big endian byte order
+ * @return the converted int as a byte array in big-endian byte order
*/
public static byte[] getBytes(final int value) {
final byte[] result = new byte[2];
@@ -69,7 +69,7 @@ public final class ZipShort implements Cloneable, Serializable {
}
/**
- * put the value as two bytes in big endian byte order.
+ * put the value as two bytes in big-endian byte order.
*
* @param value the Java int to convert to bytes
* @param buf the output buffer
@@ -134,9 +134,9 @@ public final class ZipShort implements Cloneable, Serializable {
}
/**
- * Gets value as two bytes in big endian byte order.
+ * Gets value as two bytes in big-endian byte order.
*
- * @return the value as a two byte array in big endian byte order
+ * @return the value as a two byte array in big-endian byte order
*/
public byte[] getBytes() {
final byte[] result = new byte[2];