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-codec.git
The following commit(s) were added to refs/heads/master by this push:
new fd375f62 Javadoc: English, not Latin
new 8d97b0e6 Merge branch 'master' of
https://github.com/apache/commons-codec.git
fd375f62 is described below
commit fd375f62d280f852ae034ee84baee36c24d0771a
Author: Gary D. Gregory <garydgreg...@gmail.com>
AuthorDate: Tue Dec 31 08:35:48 2024 -0500
Javadoc: English, not Latin
---
.../org/apache/commons/codec/binary/Base32.java | 2 +-
.../commons/codec/binary/Base32InputStream.java | 4 ++--
.../commons/codec/binary/Base32OutputStream.java | 4 ++--
.../org/apache/commons/codec/binary/Base64.java | 2 +-
.../commons/codec/binary/Base64InputStream.java | 4 ++--
.../commons/codec/binary/Base64OutputStream.java | 4 ++--
.../apache/commons/codec/binary/BaseNCodec.java | 16 ++++++++--------
.../org/apache/commons/codec/digest/Crypt.java | 4 ++--
.../apache/commons/codec/digest/DigestUtils.java | 22 +++++++++++-----------
.../codec/language/DaitchMokotoffSoundex.java | 2 +-
.../commons/codec/language/DoubleMetaphone.java | 12 ++++++------
11 files changed, 38 insertions(+), 38 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/binary/Base32.java
b/src/main/java/org/apache/commons/codec/binary/Base32.java
index c771b40f..9f88c2a3 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base32.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base32.java
@@ -385,7 +385,7 @@ public class Base32 extends BaseNCodec {
* inAvail set to "-1" to alert decoder that EOF has been reached. The
"-1" call is not necessary when decoding, but it doesn't hurt, either.
* </p>
* <p>
- * Ignores all non-Base32 characters. This is how chunked (e.g. 76
character) data is handled, since CR and LF are silently ignored, but has
implications
+ * Ignores all non-Base32 characters. This is how chunked (for example 76
character) data is handled, since CR and LF are silently ignored, but has
implications
* for other bytes, too. This method subscribes to the garbage-in,
garbage-out philosophy: it will not check the provided data for validity.
* </p>
* <p>
diff --git
a/src/main/java/org/apache/commons/codec/binary/Base32InputStream.java
b/src/main/java/org/apache/commons/codec/binary/Base32InputStream.java
index c6f8e5b8..49a23af4 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base32InputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base32InputStream.java
@@ -90,7 +90,7 @@ public class Base32InputStream extends BaseNCodecInputStream {
* the nearest multiple of 4). If lineLength <= 0, the
encoded data is not divided into lines. If
* doEncode is false, lineLength is ignored.
* @param lineSeparator
- * If doEncode is true, each line of encoded data will be
terminated with this byte sequence (e.g. \r\n).
+ * If doEncode is true, each line of encoded data will be
terminated with this byte sequence (for example \r\n).
* If lineLength <= 0, the lineSeparator is not used. If
doEncode is false lineSeparator is ignored.
*/
public Base32InputStream(final InputStream inputStream, final boolean
doEncode, final int lineLength, final byte[] lineSeparator) {
@@ -110,7 +110,7 @@ public class Base32InputStream extends
BaseNCodecInputStream {
* the nearest multiple of 4). If lineLength <= 0, the
encoded data is not divided into lines. If
* doEncode is false, lineLength is ignored.
* @param lineSeparator
- * If doEncode is true, each line of encoded data will be
terminated with this byte sequence (e.g. \r\n).
+ * If doEncode is true, each line of encoded data will be
terminated with this byte sequence (for example \r\n).
* If lineLength <= 0, the lineSeparator is not used. If
doEncode is false lineSeparator is ignored.
* @param decodingPolicy
* The decoding policy.
diff --git
a/src/main/java/org/apache/commons/codec/binary/Base32OutputStream.java
b/src/main/java/org/apache/commons/codec/binary/Base32OutputStream.java
index 06367bad..87a6bc38 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base32OutputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base32OutputStream.java
@@ -94,7 +94,7 @@ public class Base32OutputStream extends
BaseNCodecOutputStream {
* the nearest multiple of 4). If lineLength <= 0, the
encoded data is not divided into lines. If
* doEncode is false, lineLength is ignored.
* @param lineSeparator
- * If doEncode is true, each line of encoded data will be
terminated with this byte sequence (e.g. \r\n).
+ * If doEncode is true, each line of encoded data will be
terminated with this byte sequence (for example \r\n).
* If lineLength <= 0, the lineSeparator is not used. If
doEncode is false lineSeparator is ignored.
*/
public Base32OutputStream(final OutputStream outputStream, final boolean
doEncode, final int lineLength, final byte[] lineSeparator) {
@@ -114,7 +114,7 @@ public class Base32OutputStream extends
BaseNCodecOutputStream {
* the nearest multiple of 4). If lineLength <= 0, the
encoded data is not divided into lines. If
* doEncode is false, lineLength is ignored.
* @param lineSeparator
- * If doEncode is true, each line of encoded data will be
terminated with this byte sequence (e.g. \r\n).
+ * If doEncode is true, each line of encoded data will be
terminated with this byte sequence (for example \r\n).
* If lineLength <= 0, the lineSeparator is not used. If
doEncode is false lineSeparator is ignored.
* @param decodingPolicy The decoding policy.
* @since 1.15
diff --git a/src/main/java/org/apache/commons/codec/binary/Base64.java
b/src/main/java/org/apache/commons/codec/binary/Base64.java
index b406c62f..730df757 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64.java
@@ -721,7 +721,7 @@ public class Base64 extends BaseNCodec {
* call is not necessary when decoding, but it doesn't hurt, either.
* </p>
* <p>
- * Ignores all non-base64 characters. This is how chunked (e.g. 76
character) data is handled, since CR and LF are
+ * Ignores all non-base64 characters. This is how chunked (for example 76
character) data is handled, since CR and LF are
* silently ignored, but has implications for other bytes, too. This
method subscribes to the garbage-in,
* garbage-out philosophy: it will not check the provided data for
validity.
* </p>
diff --git
a/src/main/java/org/apache/commons/codec/binary/Base64InputStream.java
b/src/main/java/org/apache/commons/codec/binary/Base64InputStream.java
index 059f66e1..d7b47fe1 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64InputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64InputStream.java
@@ -94,7 +94,7 @@ public class Base64InputStream extends BaseNCodecInputStream {
* the nearest multiple of 4). If lineLength <= 0, the
encoded data is not divided into lines. If
* doEncode is false, lineLength is ignored.
* @param lineSeparator
- * If doEncode is true, each line of encoded data will be
terminated with this byte sequence (e.g. \r\n).
+ * If doEncode is true, each line of encoded data will be
terminated with this byte sequence (for example \r\n).
* If lineLength <= 0, the lineSeparator is not used. If
doEncode is false lineSeparator is ignored.
*/
public Base64InputStream(final InputStream inputStream, final boolean
doEncode, final int lineLength, final byte[] lineSeparator) {
@@ -114,7 +114,7 @@ public class Base64InputStream extends
BaseNCodecInputStream {
* the nearest multiple of 4). If lineLength <= 0, the
encoded data is not divided into lines. If
* doEncode is false, lineLength is ignored.
* @param lineSeparator
- * If doEncode is true, each line of encoded data will be
terminated with this byte sequence (e.g. \r\n).
+ * If doEncode is true, each line of encoded data will be
terminated with this byte sequence (for example \r\n).
* If lineLength <= 0, the lineSeparator is not used. If
doEncode is false lineSeparator is ignored.
* @param decodingPolicy The decoding policy.
* @since 1.15
diff --git
a/src/main/java/org/apache/commons/codec/binary/Base64OutputStream.java
b/src/main/java/org/apache/commons/codec/binary/Base64OutputStream.java
index 43103b55..745860d9 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64OutputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64OutputStream.java
@@ -98,7 +98,7 @@ public class Base64OutputStream extends
BaseNCodecOutputStream {
* the nearest multiple of 4). If lineLength <= 0, the
encoded data is not divided into lines. If
* doEncode is false, lineLength is ignored.
* @param lineSeparator
- * If doEncode is true, each line of encoded data will be
terminated with this byte sequence (e.g. \r\n).
+ * If doEncode is true, each line of encoded data will be
terminated with this byte sequence (for example \r\n).
* If lineLength <= 0, the lineSeparator is not used. If
doEncode is false lineSeparator is ignored.
*/
public Base64OutputStream(final OutputStream outputStream, final boolean
doEncode, final int lineLength, final byte[] lineSeparator) {
@@ -118,7 +118,7 @@ public class Base64OutputStream extends
BaseNCodecOutputStream {
* the nearest multiple of 4). If lineLength <= 0, the
encoded data is not divided into lines. If
* doEncode is false, lineLength is ignored.
* @param lineSeparator
- * If doEncode is true, each line of encoded data will be
terminated with this byte sequence (e.g. \r\n).
+ * If doEncode is true, each line of encoded data will be
terminated with this byte sequence (for example \r\n).
* If lineLength <= 0, the lineSeparator is not used. If
doEncode is false lineSeparator is ignored.
* @param decodingPolicy The decoding policy.
* @since 1.15
diff --git a/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
b/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
index f2c11c90..9779b2a2 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
@@ -394,10 +394,10 @@ public abstract class BaseNCodec implements
BinaryEncoder, BinaryDecoder {
/** Pad byte. Instance variable just in case it needs to vary later. */
protected final byte pad;
- /** Number of bytes in each full block of unencoded data, e.g. 4 for
Base64 and 5 for Base32 */
+ /** Number of bytes in each full block of unencoded data, for example 4
for Base64 and 5 for Base32 */
private final int unencodedBlockSize;
- /** Number of bytes in each full block of encoded data, e.g. 3 for Base64
and 8 for Base32 */
+ /** Number of bytes in each full block of encoded data, for example 3 for
Base64 and 8 for Base32 */
private final int encodedBlockSize;
/**
@@ -440,8 +440,8 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
* If {@code chunkSeparatorLength} is zero, then chunking is disabled.
* </p>
*
- * @param unencodedBlockSize the size of an unencoded block (e.g. Base64 =
3)
- * @param encodedBlockSize the size of an encoded block (e.g. Base64 = 4)
+ * @param unencodedBlockSize the size of an unencoded block (for example
Base64 = 3)
+ * @param encodedBlockSize the size of an encoded block (for example
Base64 = 4)
* @param lineLength if > 0, use chunking with a length {@code
lineLength}
* @param chunkSeparatorLength the chunk separator length, if relevant
*/
@@ -456,8 +456,8 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
* If {@code chunkSeparatorLength} is zero, then chunking is disabled.
* </p>
*
- * @param unencodedBlockSize the size of an unencoded block (e.g. Base64 =
3)
- * @param encodedBlockSize the size of an encoded block (e.g. Base64 = 4)
+ * @param unencodedBlockSize the size of an unencoded block (for example
Base64 = 3)
+ * @param encodedBlockSize the size of an encoded block (for example
Base64 = 4)
* @param lineLength if > 0, use chunking with a length {@code
lineLength}
* @param chunkSeparatorLength the chunk separator length, if relevant
* @param pad byte used as padding byte.
@@ -473,8 +473,8 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
* If {@code chunkSeparatorLength} is zero, then chunking is disabled.
* </p>
*
- * @param unencodedBlockSize the size of an unencoded block (e.g. Base64 =
3)
- * @param encodedBlockSize the size of an encoded block (e.g. Base64 = 4)
+ * @param unencodedBlockSize the size of an unencoded block (for example
Base64 = 3)
+ * @param encodedBlockSize the size of an encoded block (for example
Base64 = 4)
* @param lineLength if > 0, use chunking with a length {@code
lineLength}
* @param chunkSeparatorLength the chunk separator length, if relevant
* @param pad byte used as padding byte.
diff --git a/src/main/java/org/apache/commons/codec/digest/Crypt.java
b/src/main/java/org/apache/commons/codec/digest/Crypt.java
index ec658d49..dfeddcaf 100644
--- a/src/main/java/org/apache/commons/codec/digest/Crypt.java
+++ b/src/main/java/org/apache/commons/codec/digest/Crypt.java
@@ -126,7 +126,7 @@ public class Crypt {
* </p>
* <p>
* The rest of the salt string is drawn from the set {@code [a-zA-Z0-9./]}
and is cut at the maximum length or if a
- * {@code "$"} sign is encountered. It is therefore valid to enter a
complete hash value as salt to e.g. verify a
+ * {@code "$"} sign is encountered. It is therefore valid to enter a
complete hash value as salt to for example verify a
* password with:
* </p>
* <pre>
@@ -154,7 +154,7 @@ public class Crypt {
* </pre>
* <p>
* This method comes in a variation that accepts a byte[] array to support
input strings that are not encoded in
- * UTF-8 but e.g. in ISO-8859-1 where equal characters result in different
byte values.
+ * UTF-8 but for example in ISO-8859-1 where equal characters result in
different byte values.
* </p>
*
* @see "The man page of the libc crypt (3) function."
diff --git a/src/main/java/org/apache/commons/codec/digest/DigestUtils.java
b/src/main/java/org/apache/commons/codec/digest/DigestUtils.java
index 67abe9bb..a5d09648 100644
--- a/src/main/java/org/apache/commons/codec/digest/DigestUtils.java
+++ b/src/main/java/org/apache/commons/codec/digest/DigestUtils.java
@@ -65,7 +65,7 @@ public class DigestUtils {
/**
* Reads through a byte array and returns the digest for the data.
Provided for symmetry with other methods.
*
- * @param messageDigest The MessageDigest to use (e.g. MD5)
+ * @param messageDigest The MessageDigest to use (for example MD5)
* @param data Data to digest
* @return the digest
* @since 1.11
@@ -77,7 +77,7 @@ public class DigestUtils {
/**
* Reads through a ByteBuffer and returns the digest for the data
*
- * @param messageDigest The MessageDigest to use (e.g. MD5)
+ * @param messageDigest The MessageDigest to use (for example MD5)
* @param data Data to digest
* @return the digest
* @since 1.11
@@ -90,7 +90,7 @@ public class DigestUtils {
/**
* Reads through a File and returns the digest for the data
*
- * @param messageDigest The MessageDigest to use (e.g. MD5)
+ * @param messageDigest The MessageDigest to use (for example MD5)
* @param data Data to digest
* @return the digest
* @throws IOException On error reading from the stream
@@ -103,7 +103,7 @@ public class DigestUtils {
/**
* Reads through an InputStream and returns the digest for the data
*
- * @param messageDigest The MessageDigest to use (e.g. MD5)
+ * @param messageDigest The MessageDigest to use (for example MD5)
* @param data Data to digest
* @return the digest
* @throws IOException On error reading from the stream
@@ -116,7 +116,7 @@ public class DigestUtils {
/**
* Reads through a File and returns the digest for the data
*
- * @param messageDigest The MessageDigest to use (e.g. MD5)
+ * @param messageDigest The MessageDigest to use (for example MD5)
* @param data Data to digest
* @param options options How to open the file
* @return the digest
@@ -130,7 +130,7 @@ public class DigestUtils {
/**
* Reads through a RandomAccessFile using non-blocking-io (NIO) and
returns the digest for the data
*
- * @param messageDigest The MessageDigest to use (e.g. MD5)
+ * @param messageDigest The MessageDigest to use (for example MD5)
* @param data Data to digest
* @return the digest
* @throws IOException On error reading from the stream
@@ -1269,7 +1269,7 @@ public class DigestUtils {
/**
* Reads through a File and updates the digest for the data
*
- * @param digest The MessageDigest to use (e.g. MD5)
+ * @param digest The MessageDigest to use (for example MD5)
* @param data Data to digest
* @return the digest
* @throws IOException On error reading from the stream
@@ -1286,7 +1286,7 @@ public class DigestUtils {
*
* TODO Decide if this should be public.
*
- * @param digest The MessageDigest to use (e.g. MD5)
+ * @param digest The MessageDigest to use (for example MD5)
* @param data Data to digest
* @return the digest
* @throws IOException On error reading from the stream
@@ -1305,7 +1305,7 @@ public class DigestUtils {
/**
* Reads through an InputStream and updates the digest for the data
*
- * @param digest The MessageDigest to use (e.g. MD5)
+ * @param digest The MessageDigest to use (for example MD5)
* @param inputStream Data to digest
* @return the digest
* @throws IOException On error reading from the stream
@@ -1326,7 +1326,7 @@ public class DigestUtils {
/**
* Reads through a Path and updates the digest for the data
*
- * @param digest The MessageDigest to use (e.g. MD5)
+ * @param digest The MessageDigest to use (for example MD5)
* @param path Data to digest
* @param options options How to open the file
* @return the digest
@@ -1342,7 +1342,7 @@ public class DigestUtils {
/**
* Reads through a RandomAccessFile and updates the digest for the data
using non-blocking-io (NIO)
*
- * @param digest The MessageDigest to use (e.g. MD5)
+ * @param digest The MessageDigest to use (for example MD5)
* @param data Data to digest
* @return the digest
* @throws IOException On error reading from the stream
diff --git
a/src/main/java/org/apache/commons/codec/language/DaitchMokotoffSoundex.java
b/src/main/java/org/apache/commons/codec/language/DaitchMokotoffSoundex.java
index 4daa082f..a2cf6a2f 100644
--- a/src/main/java/org/apache/commons/codec/language/DaitchMokotoffSoundex.java
+++ b/src/main/java/org/apache/commons/codec/language/DaitchMokotoffSoundex.java
@@ -332,7 +332,7 @@ public class DaitchMokotoffSoundex implements StringEncoder
{
/**
* Creates a new instance.
* <p>
- * With ASCII-folding enabled, certain accented characters will be
transformed to equivalent ASCII characters, e.g.
+ * With ASCII-folding enabled, certain accented characters will be
transformed to equivalent ASCII characters, for example
* รจ -> e.
* </p>
*
diff --git
a/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
b/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
index e784ec16..3ee8882e 100644
--- a/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
+++ b/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
@@ -844,7 +844,7 @@ public class DoubleMetaphone implements StringEncoder {
index += 3;
} else if (index == 0 && contains(value, index + 1, 1, "M", "N", "L",
"W") ||
contains(value, index + 1, 1, "Z")) {
- //-- german & anglicisations, e.g. "smith" match "schmidt" //
+ //-- german & anglicisations, for example "smith" match "schmidt"
//
// "snider" match "schneider" --//
//-- also, -sz- in slavic language although in hungarian it //
// is pronounced "s" --//
@@ -854,7 +854,7 @@ public class DoubleMetaphone implements StringEncoder {
index = handleSC(value, result, index);
} else {
if (index == value.length() - 1 && contains(value, index - 2, 2,
"AI", "OI")) {
- //-- french e.g. "resnais", "artois" --//
+ //-- french for example "resnais", "artois" --//
result.appendAlternate('S');
} else {
result.append('S');
@@ -871,7 +871,7 @@ public class DoubleMetaphone implements StringEncoder {
if (charAt(value, index + 2) == 'H') {
//-- Schlesinger's rule --//
if (contains(value, index + 3, 2, "OO", "ER", "EN", "UY", "ED",
"EM")) {
- //-- Dutch origin, e.g. "school", "schooner" --//
+ //-- Dutch origin, for example "school", "schooner" --//
if (contains(value, index + 3, 2, "ER", "EN")) {
//-- "schermerhorn", "schenker" --//
result.append("X", "SK");
@@ -940,7 +940,7 @@ public class DoubleMetaphone implements StringEncoder {
result.appendAlternate('F');
index++;
} else if (contains(value, index, 4, "WICZ", "WITZ")) {
- //-- Polish e.g. "filipowicz" --//
+ //-- Polish for example "filipowicz" --//
result.append("TS", "FX");
index += 4;
} else {
@@ -960,7 +960,7 @@ public class DoubleMetaphone implements StringEncoder {
if (!(index == value.length() - 1 &&
(contains(value, index - 3, 3, "IAU", "EAU") ||
contains(value, index - 2, 2, "AU", "OU")))) {
- //-- French e.g. breaux --//
+ //-- French for example breaux --//
result.append("KS");
}
index = contains(value, index + 1, 1, "C", "X") ? index + 2 :
index + 1;
@@ -976,7 +976,7 @@ public class DoubleMetaphone implements StringEncoder {
private int handleZ(final String value, final DoubleMetaphoneResult
result, int index,
final boolean slavoGermanic) {
if (charAt(value, index + 1) == 'H') {
- //-- Chinese pinyin e.g. "zhao" or Angelina "Zhang" --//
+ //-- Chinese pinyin for example "zhao" or Angelina "Zhang" --//
result.append('J');
index += 2;
} else {
