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 2024/08/02 18:46:27 UTC
(commons-codec) branch master updated (b7ad8d21 -> 83e80d71)
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/commons-codec.git
from b7ad8d21 Bump ossf/scorecard-action from 2.3.3 to 2.4.0 (#304)
new a6f7a537 Javadoc: Grammar
new c3188fdb Merge branch 'master' of https://gitbox.apache.org/repos/asf/commons-codec
new 83e80d71 Javadoc: Grammar
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
src/main/java/org/apache/commons/codec/binary/Base64.java | 14 +++++++-------
.../apache/commons/codec/binary/BaseNCodecInputStream.java | 2 +-
.../java/org/apache/commons/codec/digest/DigestUtils.java | 2 +-
.../java/org/apache/commons/codec/digest/XXHash32.java | 2 +-
.../commons/codec/language/DaitchMokotoffSoundex.java | 2 +-
.../java/org/apache/commons/codec/language/Soundex.java | 2 +-
6 files changed, 12 insertions(+), 12 deletions(-)
(commons-codec) 03/03: Javadoc: Grammar
Posted by gg...@apache.org.
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
commit 83e80d714a58d5c49591d694d6bf030380f36fa9
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Aug 2 14:46:22 2024 -0400
Javadoc: Grammar
---
.../java/org/apache/commons/codec/binary/BaseNCodecInputStream.java | 2 +-
src/main/java/org/apache/commons/codec/digest/DigestUtils.java | 2 +-
src/main/java/org/apache/commons/codec/digest/XXHash32.java | 2 +-
.../java/org/apache/commons/codec/language/DaitchMokotoffSoundex.java | 2 +-
src/main/java/org/apache/commons/codec/language/Soundex.java | 2 +-
5 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/binary/BaseNCodecInputStream.java b/src/main/java/org/apache/commons/codec/binary/BaseNCodecInputStream.java
index 1a4c72c4..74bfb07f 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodecInputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodecInputStream.java
@@ -66,7 +66,7 @@ public class BaseNCodecInputStream extends FilterInputStream {
*/
@Override
public int available() throws IOException {
- // Note: the logic is similar to the InflaterInputStream:
+ // Note: The logic is similar to the InflaterInputStream:
// as long as we have not reached EOF, indicate that there is more
// data available. As we do not know for sure how much data is left,
// just return 1 as a safe guess.
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 2e157b6a..3b43f571 100644
--- a/src/main/java/org/apache/commons/codec/digest/DigestUtils.java
+++ b/src/main/java/org/apache/commons/codec/digest/DigestUtils.java
@@ -42,7 +42,7 @@ import org.apache.commons.codec.binary.StringUtils;
* other methods that require the Digest algorithm name.
* </p>
* <p>
- * Note: the class has shorthand methods for all the algorithms present as standard in Java 6. This approach requires lots of methods for each algorithm, and
+ * Note: The class has shorthand methods for all the algorithms present as standard in Java 6. This approach requires lots of methods for each algorithm, and
* quickly becomes unwieldy. The following code works with all algorithms:
* </p>
*
diff --git a/src/main/java/org/apache/commons/codec/digest/XXHash32.java b/src/main/java/org/apache/commons/codec/digest/XXHash32.java
index 16f59b8b..82c4b49e 100644
--- a/src/main/java/org/apache/commons/codec/digest/XXHash32.java
+++ b/src/main/java/org/apache/commons/codec/digest/XXHash32.java
@@ -61,7 +61,7 @@ public class XXHash32 implements Checksum {
}
private final byte[] oneByte = new byte[1];
private final int[] state = new int[4];
- // Note: the code used to use ByteBuffer but the manual method is 50% faster
+ // Note: The code used to use ByteBuffer but the manual method is 50% faster
// See: https://gitbox.apache.org/repos/asf/commons-compress/diff/2f56fb5c
private final byte[] buffer = new byte[BUF_SIZE];
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 60954807..86806e8d 100644
--- a/src/main/java/org/apache/commons/codec/language/DaitchMokotoffSoundex.java
+++ b/src/main/java/org/apache/commons/codec/language/DaitchMokotoffSoundex.java
@@ -53,7 +53,7 @@ import org.apache.commons.codec.StringEncoder;
* <li>{@link #soundex(String)} - branching enabled, all codes will be returned, separated by '|'
* </ul>
* <p>
- * Note: this implementation has additional branching rules compared to the original description of the algorithm. The
+ * Note: This implementation has additional branching rules compared to the original description of the algorithm. The
* rules can be customized by overriding the default rules contained in the resource file
* {@code org/apache/commons/codec/language/dmrules.txt}.
* </p>
diff --git a/src/main/java/org/apache/commons/codec/language/Soundex.java b/src/main/java/org/apache/commons/codec/language/Soundex.java
index a5ce4e60..e8f4a880 100644
--- a/src/main/java/org/apache/commons/codec/language/Soundex.java
+++ b/src/main/java/org/apache/commons/codec/language/Soundex.java
@@ -33,7 +33,7 @@ public class Soundex implements StringEncoder {
* The marker character used to indicate a silent (ignored) character.
* These are ignored except when they appear as the first character.
* <p>
- * Note: the {@link #US_ENGLISH_MAPPING_STRING} does not use this mechanism
+ * Note: The {@link #US_ENGLISH_MAPPING_STRING} does not use this mechanism
* because changing it might break existing code. Mappings that don't contain
* a silent marker code are treated as though H and W are silent.
* </p>
(commons-codec) 01/03: Javadoc: Grammar
Posted by gg...@apache.org.
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
commit a6f7a5372ecb859d6a3a651e76507a4d354ecadd
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Aug 2 14:45:18 2024 -0400
Javadoc: Grammar
---
src/main/java/org/apache/commons/codec/binary/Base64.java | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
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 48ad7334..161af532 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64.java
@@ -266,7 +266,7 @@ public class Base64 extends BaseNCodec {
* if {@code true} this encoder will chunk the base64 output into 76 character blocks
* @param urlSafe
* if {@code true} this encoder will emit - and _ instead of the usual + and / characters.
- * <b>Note: no padding is added when encoding using the URL-safe alphabet.</b>
+ * <b>Note: No padding is added when encoding using the URL-safe alphabet.</b>
* @return Base64-encoded data.
* @throws IllegalArgumentException
* Thrown when the input array needs an output array bigger than {@link Integer#MAX_VALUE}
@@ -285,7 +285,7 @@ public class Base64 extends BaseNCodec {
* if {@code true} this encoder will chunk the base64 output into 76 character blocks
* @param urlSafe
* if {@code true} this encoder will emit - and _ instead of the usual + and / characters.
- * <b>Note: no padding is added when encoding using the URL-safe alphabet.</b>
+ * <b>Note: No padding is added when encoding using the URL-safe alphabet.</b>
* @param maxResultSize
* The maximum result size to accept.
* @return Base64-encoded data.
@@ -340,7 +340,7 @@ public class Base64 extends BaseNCodec {
/**
* Encodes binary data using a URL-safe variation of the base64 algorithm but does not chunk the output. The
* url-safe variation emits - and _ instead of + and / characters.
- * <b>Note: no padding is added.</b>
+ * <b>Note: No padding is added.</b>
* @param binaryData
* binary data to encode
* @return byte[] containing Base64 characters in their UTF-8 representation.
@@ -353,7 +353,7 @@ public class Base64 extends BaseNCodec {
/**
* Encodes binary data using a URL-safe variation of the base64 algorithm but does not chunk the output. The
* url-safe variation emits - and _ instead of + and / characters.
- * <b>Note: no padding is added.</b>
+ * <b>Note: No padding is added.</b>
* @param binaryData
* binary data to encode
* @return String containing Base64 characters
@@ -603,7 +603,7 @@ public class Base64 extends BaseNCodec {
* @param urlSafe
* Instead of emitting '+' and '/' we emit '-' and '_' respectively. urlSafe is only applied to encode
* operations. Decoding seamlessly handles both modes.
- * <b>Note: no padding is added when using the URL-safe alphabet.</b>
+ * <b>Note: No padding is added when using the URL-safe alphabet.</b>
* @throws IllegalArgumentException
* Thrown when the {@code lineSeparator} contains Base64 characters.
* @since 1.4
@@ -634,7 +634,7 @@ public class Base64 extends BaseNCodec {
* @param urlSafe
* Instead of emitting '+' and '/' we emit '-' and '_' respectively. urlSafe is only applied to encode
* operations. Decoding seamlessly handles both modes.
- * <b>Note: no padding is added when using the URL-safe alphabet.</b>
+ * <b>Note: No padding is added when using the URL-safe alphabet.</b>
* @param decodingPolicy The decoding policy.
* @throws IllegalArgumentException
* Thrown when the {@code lineSeparator} contains Base64 characters.
@@ -807,7 +807,7 @@ public class Base64 extends BaseNCodec {
* the data to encode, and once with inAvail set to "-1" to alert encoder that EOF has been reached, to flush last
* remaining bytes (if not multiple of 3).
* </p>
- * <p><b>Note: no padding is added when encoding using the URL-safe alphabet.</b></p>
+ * <p><b>Note: No padding is added when encoding using the URL-safe alphabet.</b></p>
* <p>
* Thanks to "commons" project in ws.apache.org for the bitwise operations, and general approach.
* https://svn.apache.org/repos/asf/webservices/commons/trunk/modules/util/
(commons-codec) 02/03: Merge branch 'master' of https://gitbox.apache.org/repos/asf/commons-codec
Posted by gg...@apache.org.
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
commit c3188fdbf7fa2c9968f5d2c9ec59750fd2e23b3e
Merge: a6f7a537 b7ad8d21
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Aug 2 14:45:33 2024 -0400
Merge branch 'master' of https://gitbox.apache.org/repos/asf/commons-codec
.github/workflows/scorecards-analysis.yml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)