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 d0748772 Fix malformed Javadoc comments
d0748772 is described below
commit d07487725f94114154ac230ffc75d1fb72fecb27
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Dec 13 15:21:44 2025 -0500
Fix malformed Javadoc comments
---
src/changes/changes.xml | 1 +
.../apache/commons/codec/binary/Base32InputStream.java | 4 ++--
.../commons/codec/binary/Base32OutputStream.java | 4 ++--
.../apache/commons/codec/binary/Base64InputStream.java | 4 ++--
.../commons/codec/binary/Base64OutputStream.java | 4 ++--
.../org/apache/commons/codec/binary/BaseNCodec.java | 8 ++++----
.../java/org/apache/commons/codec/digest/Crypt.java | 18 +++++++++---------
.../commons/codec/language/DaitchMokotoffSoundex.java | 12 ++++++------
8 files changed, 28 insertions(+), 27 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index af0d1bd5..dbe06f92 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -47,6 +47,7 @@ The <action> type attribute can be add,update,fix,remove.
<!-- FIX -->
<action type="fix" dev="ggregory" due-to="Gary Gregory">Fix oak leaf
icon references in overview.html when running `mvn clean
javadoc:javadoc`.</action>
<action type="fix" dev="ggregory" due-to="Gary Gregory">Fix Apache RAT
plugin console warnings.</action>
+ <action type="fix" dev="ggregory" due-to="Gary Gregory">Fix malformed
Javadoc comments.</action>
<!-- ADD -->
<!-- UPDATE -->
<action type="update" dev="ggregory" due-to="Gary Gregory,
Dependabot">Bump org.apache.commons:commons-parent from 91 to 93 #415,
#418.</action>
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 481cd0a0..a00f67a4 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base32InputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base32InputStream.java
@@ -38,9 +38,9 @@ import
org.apache.commons.codec.binary.BaseNCodecInputStream.AbstracBuilder; //
* unused from the final character or entire characters. The default mode is
lenient decoding.
* </p>
* <ul>
- * <li>Lenient: Any trailing bits are composed into 8-bit bytes where
possible. The remainder are discarded.
+ * <li>Lenient: Any trailing bits are composed into 8-bit bytes where
possible. The remainder are discarded.</li>
* <li>Strict: The decoding will raise an {@link IllegalArgumentException} if
trailing bits are not part of a valid encoding. Any unused bits from the final
- * character must be zero. Impossible counts of entire final characters are
not allowed.
+ * character must be zero. Impossible counts of entire final characters are
not allowed.</li>
* </ul>
* <p>
* When strict decoding is enabled it is expected that the decoded bytes will
be re-encoded to a byte array that matches the original, i.e. no changes occur
on
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 5f8153b0..322d4cf8 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base32OutputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base32OutputStream.java
@@ -42,9 +42,9 @@ import
org.apache.commons.codec.binary.BaseNCodecOutputStream.AbstractBuilder; /
* unused from the final character or entire characters. The default mode is
lenient decoding.
* </p>
* <ul>
- * <li>Lenient: Any trailing bits are composed into 8-bit bytes where
possible. The remainder are discarded.
+ * <li>Lenient: Any trailing bits are composed into 8-bit bytes where
possible. The remainder are discarded.</li>
* <li>Strict: The decoding will raise an {@link IllegalArgumentException} if
trailing bits are not part of a valid encoding. Any unused bits from the final
- * character must be zero. Impossible counts of entire final characters are
not allowed.
+ * character must be zero. Impossible counts of entire final characters are
not allowed.</li>
* </ul>
* <p>
* When strict decoding is enabled it is expected that the decoded bytes will
be re-encoded to a byte array that matches the original, i.e. no changes occur
on
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 14e0a1bb..cdfc46ea 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64InputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64InputStream.java
@@ -42,9 +42,9 @@ import
org.apache.commons.codec.binary.BaseNCodecInputStream.AbstracBuilder; //
* unused from the final character or entire characters. The default mode is
lenient decoding.
* </p>
* <ul>
- * <li>Lenient: Any trailing bits are composed into 8-bit bytes where
possible. The remainder are discarded.
+ * <li>Lenient: Any trailing bits are composed into 8-bit bytes where
possible. The remainder are discarded.</li>
* <li>Strict: The decoding will raise an {@link IllegalArgumentException} if
trailing bits are not part of a valid encoding. Any unused bits from the final
- * character must be zero. Impossible counts of entire final characters are
not allowed.
+ * character must be zero. Impossible counts of entire final characters are
not allowed.</li>
* </ul>
* <p>
* When strict decoding is enabled it is expected that the decoded bytes will
be re-encoded to a byte array that matches the original, i.e. no changes occur
on
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 a5097aa5..5929b078 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64OutputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64OutputStream.java
@@ -46,9 +46,9 @@ import
org.apache.commons.codec.binary.BaseNCodecOutputStream.AbstractBuilder; /
* unused from the final character or entire characters. The default mode is
lenient decoding.
* </p>
* <ul>
- * <li>Lenient: Any trailing bits are composed into 8-bit bytes where
possible. The remainder are discarded.
+ * <li>Lenient: Any trailing bits are composed into 8-bit bytes where
possible. The remainder are discarded.</li>
* <li>Strict: The decoding will raise an {@link IllegalArgumentException} if
trailing bits are not part of a valid encoding. Any unused bits from the final
- * character must be zero. Impossible counts of entire final characters are
not allowed.
+ * character must be zero. Impossible counts of entire final characters are
not allowed.</li>
* </ul>
* <p>
* When strict decoding is enabled it is expected that the decoded bytes will
be re-encoded to a byte array that matches the original, i.e. no changes occur
on
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 a430f61d..5216607d 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
@@ -38,9 +38,9 @@ import org.apache.commons.codec.EncoderException;
* unused from the final character or entire characters. The default mode is
lenient decoding.
* </p>
* <ul>
- * <li>Lenient: Any trailing bits are composed into 8-bit bytes where
possible. The remainder are discarded.
+ * <li>Lenient: Any trailing bits are composed into 8-bit bytes where
possible. The remainder are discarded.</li>
* <li>Strict: The decoding will raise an {@link IllegalArgumentException} if
trailing bits are not part of a valid encoding. Any unused bits from the final
- * character must be zero. Impossible counts of entire final characters are
not allowed.
+ * character must be zero. Impossible counts of entire final characters are
not allowed.</li>
* </ul>
* <p>
* When strict decoding is enabled it is expected that the decoded bytes will
be re-encoded to a byte array that matches the original, i.e. no changes occur
on
@@ -463,9 +463,9 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
* Defines the decoding behavior when the input bytes contain leftover
trailing bits that cannot be created by a valid encoding. These can be bits
that are
* unused from the final character or entire characters. The default mode
is lenient decoding. Set this to {@code true} to enable strict decoding.
* <ul>
- * <li>Lenient: Any trailing bits are composed into 8-bit bytes where
possible. The remainder are discarded.
+ * <li>Lenient: Any trailing bits are composed into 8-bit bytes where
possible. The remainder are discarded.</li>
* <li>Strict: The decoding will raise an {@link IllegalArgumentException}
if trailing bits are not part of a valid encoding. Any unused bits from the
final
- * character must be zero. Impossible counts of entire final characters
are not allowed.
+ * character must be zero. Impossible counts of entire final characters
are not allowed.</li>
* </ul>
* <p>
* When strict decoding is enabled it is expected that the decoded bytes
will be re-encoded to a byte array that matches the original, i.e. no changes
occur
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 dfeddcaf..db7f79cf 100644
--- a/src/main/java/org/apache/commons/codec/digest/Crypt.java
+++ b/src/main/java/org/apache/commons/codec/digest/Crypt.java
@@ -114,11 +114,11 @@ public class Crypt {
* The exact algorithm depends on the format of the salt string:
* </p>
* <ul>
- * <li>SHA-512 salts start with {@code $6$} and are up to 16 chars long.
- * <li>SHA-256 salts start with {@code $5$} and are up to 16 chars long
- * <li>MD5 salts start with {@code $1$} and are up to 8 chars long
- * <li>DES, the traditional UnixCrypt algorithm is used with only 2 chars
- * <li>Only the first 8 chars of the passwords are used in the DES
algorithm!
+ * <li>SHA-512 salts start with {@code $6$} and are up to 16 chars
long.</li>
+ * <li>SHA-256 salts start with {@code $5$} and are up to 16 chars
long</li>
+ * <li>MD5 salts start with {@code $1$} and are up to 8 chars long</li>
+ * <li>DES, the traditional UnixCrypt algorithm is used with only 2
chars</li>
+ * <li>Only the first 8 chars of the passwords are used in the DES
algorithm!</li>
* </ul>
* <p>
* The magic strings {@code "$apr1$"} and {@code "$2a$"} are not
recognized by this method as its output should be
@@ -140,10 +140,10 @@ public class Crypt {
* The total length is dependent on the algorithm used:
* </p>
* <ul>
- * <li>SHA-512: 106 chars
- * <li>SHA-256: 63 chars
- * <li>MD5: 34 chars
- * <li>DES: 13 chars
+ * <li>SHA-512: 106 chars</li>
+ * <li>SHA-256: 63 chars</li>
+ * <li>MD5: 34 chars</li>
+ * <li>DES: 13 chars</li>
* </ul>
* <p>
* Example:
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 0d075713..7a7cc1a8 100644
--- a/src/main/java/org/apache/commons/codec/language/DaitchMokotoffSoundex.java
+++ b/src/main/java/org/apache/commons/codec/language/DaitchMokotoffSoundex.java
@@ -42,16 +42,16 @@ import org.apache.commons.codec.StringEncoder;
* The main differences compared to the other Soundex variants are:
* </p>
* <ul>
- * <li>coded names are 6 digits long
- * <li>the initial character of the name is coded
- * <li>rules to encoded multi-character n-grams
- * <li>multiple possible encodings for the same name (branching)
+ * <li>coded names are 6 digits long</li>
+ * <li>the initial character of the name is coded</li>
+ * <li>rules to encoded multi-character n-grams</li>
+ * <li>multiple possible encodings for the same name (branching)</li>
* </ul>
* <p>
* This implementation supports branching, depending on the used method:
* <ul>
- * <li>{@link #encode(String)} - branching disabled, only the first code will
be returned
- * <li>{@link #soundex(String)} - branching enabled, all codes will be
returned, separated by '|'
+ * <li>{@link #encode(String)} - branching disabled, only the first code will
be returned</li>
+ * <li>{@link #soundex(String)} - branching enabled, all codes will be
returned, separated by '|'</li>
* </ul>
* <p>
* Note: This implementation has additional branching rules compared to the
original description of the algorithm. The
