Javadoc: English, not Latin

Author: garydgregory

src/main/java/org/apache/commons/codec/binary/Base32.java

@@ -385,7 +385,7 @@ private Base32(final int lineLength, final byte[] lineSeparator, final byte[] en
      * 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>

src/main/java/org/apache/commons/codec/binary/Base32InputStream.java

@@ -90,7 +90,7 @@ public Base32InputStream(final InputStream inputStream, final boolean doEncode)
      *            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 Base32InputStream(final InputStream inputStream, final boolean doEncode,
      *            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.

src/main/java/org/apache/commons/codec/binary/Base32OutputStream.java

@@ -94,7 +94,7 @@ public Base32OutputStream(final OutputStream outputStream, final boolean doEncod
      *            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 Base32OutputStream(final OutputStream outputStream, final boolean doEncod
      *            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

src/main/java/org/apache/commons/codec/binary/Base64.java

@@ -721,7 +721,7 @@ private byte[] calculateDecodeTable(final byte[] encodeTable) {
      * 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>

src/main/java/org/apache/commons/codec/binary/Base64InputStream.java

@@ -94,7 +94,7 @@ public Base64InputStream(final InputStream inputStream, final boolean doEncode)
      *            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 Base64InputStream(final InputStream inputStream, final boolean doEncode,
      *            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

src/main/java/org/apache/commons/codec/binary/Base64OutputStream.java

@@ -98,7 +98,7 @@ public Base64OutputStream(final OutputStream outputStream, final boolean doEncod
      *            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 Base64OutputStream(final OutputStream outputStream, final boolean doEncod
      *            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

src/main/java/org/apache/commons/codec/binary/BaseNCodec.java

@@ -394,10 +394,10 @@ static int toLength(final byte[] array) {
     /** 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 @@ static int toLength(final byte[] array) {
      * 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 &gt; 0, use chunking with a length {@code lineLength}
      * @param chunkSeparatorLength the chunk separator length, if relevant
      */
@@ -456,8 +456,8 @@ protected BaseNCodec(final int unencodedBlockSize, final int encodedBlockSize, f
      * 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 &gt; 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 @@ protected BaseNCodec(final int unencodedBlockSize, final int encodedBlockSize, f
      * 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 &gt; 0, use chunking with a length {@code lineLength}
      * @param chunkSeparatorLength the chunk separator length, if relevant
      * @param pad byte used as padding byte.

src/main/java/org/apache/commons/codec/digest/Crypt.java

@@ -126,7 +126,7 @@ public static String crypt(final String key) {
      * </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 static String crypt(final String key) {
      * </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."

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 static byte[] digest(final MessageDigest messageDigest, final byte[] data
     /**
      * 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 static byte[] digest(final MessageDigest messageDigest, final ByteBuffer
     /**
      * 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 static byte[] digest(final MessageDigest messageDigest, final File data)
     /**
      * 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 static byte[] digest(final MessageDigest messageDigest, final InputStream
     /**
      * 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 static byte[] digest(final MessageDigest messageDigest, final Path data,
     /**
      * 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 static MessageDigest updateDigest(final MessageDigest messageDigest, fina
     /**
      * 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 static MessageDigest updateDigest(final MessageDigest digest, final File
      *
      * 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 @@ private static MessageDigest updateDigest(final MessageDigest digest, final File
     /**
      * 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 static MessageDigest updateDigest(final MessageDigest digest, final Input
     /**
      * 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 static MessageDigest updateDigest(final MessageDigest digest, final Path
     /**
      * 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

src/main/java/org/apache/commons/codec/language/DaitchMokotoffSoundex.java

@@ -332,7 +332,7 @@ public DaitchMokotoffSoundex() {
     /**
      * 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
      * è -&gt; e.
      * </p>
      *