This is an automated email from the ASF dual-hosted git repository.
garydgregory 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 7bc16aa4 Make the @param names in BaseNCodec match the parameters they
document (#444)
7bc16aa4 is described below
commit 7bc16aa49e12f12f3ffe8e91b513e42904e04276
Author: geonseok <[email protected]>
AuthorDate: Sat Sep 19 23:12:27 2026 +0900
Make the @param names in BaseNCodec match the parameters they document
(#444)
javadoc discards a @param tag whose name matches no parameter of the method,
so all three of these removed an argument's documentation from the generated
docs instead of adding it. javadoc -Xdoclint reports each as an error:
BaseNCodec.java:483: error: @param name not found
BaseNCodec.java:693: error: @param name not found
BaseNCodec.java:774: error: @param name not found
toUnsignedBytes takes `value`, but the tag said `bigInt`. That one is fixed
in
the comment.
The abstract decode and encode declare `int i` while their own tag, their
Javadoc text ("initial offset of the subarray"), the caller in
encode(byte[],
int, int), and the Base16 and Base58 overrides all call it `offset`. Here
the
parameter name is the typo rather than the tag, so `i` is renamed to
`offset`.
Parameter names of an abstract, package-private method carry no binary
signature, so this changes no behaviour; japicmp confirms it.
Generated-by: Claude Opus 5 (Claude Code)
Claude-Session: https://claude.ai/code/session_01GuW8Eie2iuc8mqnqZaCLWR
Co-authored-by: hxperl <[email protected]>
Co-authored-by: Claude Opus 5 (1M context) <[email protected]>
---
src/main/java/org/apache/commons/codec/binary/BaseNCodec.java | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
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 c2e951d2..0bb8887c 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
@@ -516,7 +516,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
* The value {@link BigInteger#ZERO} maps to an empty array.
* </p>
*
- * @param bigInt {@code BigInteger} to be converted.
+ * @param value {@code BigInteger} to be converted.
* @return A byte array representation of the BigInteger parameter.
*/
static byte[] toUnsignedBytes(final BigInteger value) {
@@ -725,7 +725,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
* @param length length of the subarray.
* @throws IllegalArgumentException Thrown when a problem is detected
processing data.
*/
- abstract void decode(byte[] array, int i, int length, Context context);
+ abstract void decode(byte[] array, int offset, int length, Context
context);
/**
* Decodes an Object using the Base-N algorithm. This method is provided
in order to satisfy the requirements of the Decoder interface, and will throw a
@@ -816,7 +816,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
* @param length length of the subarray.
* @throws IllegalArgumentException Thrown when a problem is detected
processing data.
*/
- abstract void encode(byte[] array, int i, int length, Context context);
+ abstract void encode(byte[] array, int offset, int length, Context
context);
/**
* Encodes an Object using the Base-N algorithm. This method is provided
in order to satisfy the requirements of the Encoder interface, and will throw an
