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:45 UTC
(commons-compress) 03/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 de471d6e7601b905065ee5e6489678b70c40c4f7
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Thu Dec 21 17:06:58 2023 -0500
Javadoc spelling
---
.../commons/compress/archivers/zip/X7875_NewUnix.java | 4 ++--
.../compress/archivers/zip/ZipEightByteInteger.java | 2 +-
.../apache/commons/compress/archivers/zip/ZipLong.java | 2 +-
.../commons/compress/archivers/zip/ZipShort.java | 2 +-
.../org/apache/commons/compress/utils/ByteUtils.java | 18 +++++++++---------
5 files changed, 14 insertions(+), 14 deletions(-)
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/X7875_NewUnix.java b/src/main/java/org/apache/commons/compress/archivers/zip/X7875_NewUnix.java
index 3b50009d4..742fed087 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/X7875_NewUnix.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/X7875_NewUnix.java
@@ -42,9 +42,9 @@ import org.apache.commons.compress.utils.ByteUtils;
* TSize Short total data size for this block
* Version 1 byte version of this extra field, currently 1
* UIDSize 1 byte Size of UID field
- * UID Variable UID for this entry (little endian)
+ * UID Variable UID for this entry (little-endian)
* GIDSize 1 byte Size of GID field
- * GID Variable GID for this entry (little endian)
+ * GID Variable GID for this entry (little-endian)
*
* Central-header version:
*
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 2abb62f74..8cd0ab6b3 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
@@ -22,7 +22,7 @@ import java.io.Serializable;
import java.math.BigInteger;
/**
- * Utility class that represents an eight byte integer with conversion rules for the little endian byte order of ZIP files.
+ * Utility class that represents an eight byte integer with conversion rules for the little-endian byte order of ZIP files.
*
* @Immutable
*
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 068dbb453..9412ef4aa 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
@@ -23,7 +23,7 @@ import java.io.Serializable;
import org.apache.commons.compress.utils.ByteUtils;
/**
- * Utility class that represents a four byte integer with conversion rules for the little endian byte order of ZIP files.
+ * Utility class that represents a four byte integer with conversion rules for the little-endian byte order of ZIP files.
*
* @Immutable
*/
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 bd92de031..e103d65e0 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
@@ -21,7 +21,7 @@ import java.io.Serializable;
import org.apache.commons.compress.utils.ByteUtils;
/**
- * Utility class that represents a two byte integer with conversion rules for the little endian byte order of ZIP files.
+ * Utility class that represents a two byte integer with conversion rules for the little-endian byte order of ZIP files.
*
* @Immutable
*/
diff --git a/src/main/java/org/apache/commons/compress/utils/ByteUtils.java b/src/main/java/org/apache/commons/compress/utils/ByteUtils.java
index 0cde53df4..816f3a345 100644
--- a/src/main/java/org/apache/commons/compress/utils/ByteUtils.java
+++ b/src/main/java/org/apache/commons/compress/utils/ByteUtils.java
@@ -110,7 +110,7 @@ public final class ByteUtils {
}
/**
- * Reads the given byte array as a little endian long.
+ * Reads the given byte array as a little-endian long.
*
* @param bytes the byte array to convert
* @return the number read
@@ -120,7 +120,7 @@ public final class ByteUtils {
}
/**
- * Reads the given byte array as a little endian long.
+ * Reads the given byte array as a little-endian long.
*
* @param bytes the byte array to convert
* @param off the offset into the array that starts the value
@@ -138,7 +138,7 @@ public final class ByteUtils {
}
/**
- * Reads the given number of bytes from the given supplier as a little endian long.
+ * Reads the given number of bytes from the given supplier as a little-endian long.
*
* <p>
* Typically used by our InputStreams that need to count the bytes read as well.
@@ -164,7 +164,7 @@ public final class ByteUtils {
}
/**
- * Reads the given number of bytes from the given input as little endian long.
+ * Reads the given number of bytes from the given input as little-endian long.
*
* @param in the input to read from
* @param length the number of bytes representing the value
@@ -184,7 +184,7 @@ public final class ByteUtils {
}
/**
- * Reads the given number of bytes from the given stream as a little endian long.
+ * Reads the given number of bytes from the given stream as a little-endian long.
*
* @param in the stream to read from
* @param length the number of bytes representing the value
@@ -207,7 +207,7 @@ public final class ByteUtils {
}
/**
- * Inserts the given value into the array as a little endian sequence of the given length starting at the given offset.
+ * Inserts the given value into the array as a little-endian sequence of the given length starting at the given offset.
*
* @param b the array to write into
* @param value the value to insert
@@ -223,7 +223,7 @@ public final class ByteUtils {
}
/**
- * Provides the given value to the given consumer as a little endian sequence of the given length.
+ * Provides the given value to the given consumer as a little-endian sequence of the given length.
*
* @param consumer the consumer to provide the bytes to
* @param value the value to provide
@@ -239,7 +239,7 @@ public final class ByteUtils {
}
/**
- * Writes the given value to the given stream as a little endian array of the given length.
+ * Writes the given value to the given stream as a little-endian array of the given length.
*
* @param out the output to write to
* @param value the value to write
@@ -256,7 +256,7 @@ public final class ByteUtils {
}
/**
- * Writes the given value to the given stream as a little endian array of the given length.
+ * Writes the given value to the given stream as a little-endian array of the given length.
*
* @param out the stream to write to
* @param value the value to write