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-text.git
The following commit(s) were added to refs/heads/master by this push:
new 31f0e88a Javadoc
31f0e88a is described below
commit 31f0e88a55d4ca03cdadf9f77228e2a6bef96849
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 08:47:58 2026 -0400
Javadoc
---
src/main/java/org/apache/commons/text/StrBuilder.java | 2 +-
src/main/java/org/apache/commons/text/TextStringBuilder.java | 2 +-
.../java/org/apache/commons/text/lookup/DefaultStringLookup.java | 4 ++--
.../java/org/apache/commons/text/lookup/StringLookupFactory.java | 6 +++---
src/main/java/org/apache/commons/text/matcher/StringMatcher.java | 2 +-
src/main/java/org/apache/commons/text/numbers/ParsedDecimal.java | 2 +-
.../apache/commons/text/similarity/LongestCommonSubsequence.java | 6 +++---
.../java/org/apache/commons/text/similarity/SimilarityInput.java | 4 ++--
.../java/org/apache/commons/text/jmh/DoubleFormatPerformance.java | 2 +-
.../org/apache/commons/text/lookup/ConstantStringLookupTest.java | 2 +-
.../commons/text/similarity/IntersectionSimilarityTest.java | 8 ++++----
.../apache/commons/text/similarity/JaroWinklerSimilarityTest.java | 2 +-
12 files changed, 21 insertions(+), 21 deletions(-)
diff --git a/src/main/java/org/apache/commons/text/StrBuilder.java
b/src/main/java/org/apache/commons/text/StrBuilder.java
index ed9495f8..c477a57e 100644
--- a/src/main/java/org/apache/commons/text/StrBuilder.java
+++ b/src/main/java/org/apache/commons/text/StrBuilder.java
@@ -1822,7 +1822,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
/**
* Gets the internal buffer for testing.
*
- * @return the internal buffer.
+ * @return The internal buffer.
*/
char[] getBuffer() {
return buffer;
diff --git a/src/main/java/org/apache/commons/text/TextStringBuilder.java
b/src/main/java/org/apache/commons/text/TextStringBuilder.java
index 10f391fd..585711b4 100644
--- a/src/main/java/org/apache/commons/text/TextStringBuilder.java
+++ b/src/main/java/org/apache/commons/text/TextStringBuilder.java
@@ -294,7 +294,7 @@ public class TextStringBuilder implements CharSequence,
Appendable, Serializable
* can be allocated.
*
* @param minCapacity the minimum capacity
- * @return the capacity
+ * @return The capacity
* @throws OutOfMemoryError if the {@code minCapacity} is negative
*/
private static int createPositiveCapacity(final int minCapacity) {
diff --git
a/src/main/java/org/apache/commons/text/lookup/DefaultStringLookup.java
b/src/main/java/org/apache/commons/text/lookup/DefaultStringLookup.java
index 15583542..ab0e6b94 100644
--- a/src/main/java/org/apache/commons/text/lookup/DefaultStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/DefaultStringLookup.java
@@ -216,7 +216,7 @@ public enum DefaultStringLookup {
/**
* Gets the standard prefix for the lookup object of this kind.
*
- * @return the prefix
+ * @return The prefix
*/
public String getKey() {
return key;
@@ -225,7 +225,7 @@ public enum DefaultStringLookup {
/**
* Gets the standard {@link StringLookup} instance of this kind.
*
- * @return the associated {@link StringLookup} object
+ * @return The associated {@link StringLookup} object
*/
public StringLookup getStringLookup() {
return lookup;
diff --git
a/src/main/java/org/apache/commons/text/lookup/StringLookupFactory.java
b/src/main/java/org/apache/commons/text/lookup/StringLookupFactory.java
index ee1bc407..c507d9cb 100644
--- a/src/main/java/org/apache/commons/text/lookup/StringLookupFactory.java
+++ b/src/main/java/org/apache/commons/text/lookup/StringLookupFactory.java
@@ -632,7 +632,7 @@ public final class StringLookupFactory {
* @param <K> The class of the map keys
* @param <V> The class of the map values
* @param map The map to test
- * @return the given map if the input is non-null or an empty immutable
map if the input is null.
+ * @return The given map if the input is non-null or an empty immutable
map if the input is null.
*/
static <K, V> Map<K, V> toMap(final Map<K, V> map) {
return map == null ? Collections.emptyMap() : map;
@@ -866,7 +866,7 @@ public final class StringLookupFactory {
* The examples above convert {@code "address|apache.org"} to the IP
address of {@code apache.org}.
* </p>
*
- * @return the DnsStringLookup singleton instance.
+ * @return The DnsStringLookup singleton instance.
* @since 1.8
*/
public StringLookup dnsStringLookup() {
@@ -1027,7 +1027,7 @@ public final class StringLookupFactory {
* The examples above convert {@code "${sys:os.name}, ${env:USER}"} to the
OS name and Linux user name.
* </p>
*
- * @return the default {@link InterpolatorStringLookup}.
+ * @return The default {@link InterpolatorStringLookup}.
*/
public StringLookup interpolatorStringLookup() {
return InterpolatorStringLookup.INSTANCE;
diff --git a/src/main/java/org/apache/commons/text/matcher/StringMatcher.java
b/src/main/java/org/apache/commons/text/matcher/StringMatcher.java
index 57d93b5d..8fb104ee 100644
--- a/src/main/java/org/apache/commons/text/matcher/StringMatcher.java
+++ b/src/main/java/org/apache/commons/text/matcher/StringMatcher.java
@@ -149,7 +149,7 @@ public interface StringMatcher {
/**
* Returns the size of the matching string. Defaults to 0.
*
- * @return the size of the matching string.
+ * @return The size of the matching string.
* @since 1.9
*/
default int size() {
diff --git a/src/main/java/org/apache/commons/text/numbers/ParsedDecimal.java
b/src/main/java/org/apache/commons/text/numbers/ParsedDecimal.java
index d4541b02..a9bb59a0 100644
--- a/src/main/java/org/apache/commons/text/numbers/ParsedDecimal.java
+++ b/src/main/java/org/apache/commons/text/numbers/ParsedDecimal.java
@@ -466,7 +466,7 @@ final class ParsedDecimal {
* Gets the exponent that would be used when representing this number in
scientific notation (i.e., with a single non-zero digit in front of the decimal
* point).
*
- * @return the exponent that would be used when representing this number
in scientific notation.
+ * @return The exponent that would be used when representing this number
in scientific notation.
*/
public int getScientificExponent() {
return digitCount + exponent - 1;
diff --git
a/src/main/java/org/apache/commons/text/similarity/LongestCommonSubsequence.java
b/src/main/java/org/apache/commons/text/similarity/LongestCommonSubsequence.java
index ac6d8d36..86bc097e 100644
---
a/src/main/java/org/apache/commons/text/similarity/LongestCommonSubsequence.java
+++
b/src/main/java/org/apache/commons/text/similarity/LongestCommonSubsequence.java
@@ -104,7 +104,7 @@ public class LongestCommonSubsequence implements
SimilarityScore<Integer> {
*
* @param left first input sequence.
* @param right second input sequence.
- * @return the LCS of {@code left} and {@code right}.
+ * @return The LCS of {@code left} and {@code right}.
* @since 1.10.0
*/
private static String algorithmC(final CharSequence left, final
CharSequence right) {
@@ -215,7 +215,7 @@ public class LongestCommonSubsequence implements
SimilarityScore<Integer> {
*
* @param left first character sequence.
* @param right second character sequence.
- * @return the longest common subsequence found.
+ * @return The longest common subsequence found.
* @throws IllegalArgumentException if either String input {@code null}.
* @deprecated Deprecated as of 1.2 due to a typo in the method name.
* Use {@link #longestCommonSubsequence(CharSequence, CharSequence)}
instead.
@@ -251,7 +251,7 @@ public class LongestCommonSubsequence implements
SimilarityScore<Integer> {
*
* @param left first character sequence.
* @param right second character sequence.
- * @return the longest common subsequence found.
+ * @return The longest common subsequence found.
* @throws IllegalArgumentException if either String input {@code null}.
* @since 1.2
*/
diff --git
a/src/main/java/org/apache/commons/text/similarity/SimilarityInput.java
b/src/main/java/org/apache/commons/text/similarity/SimilarityInput.java
index 73b85458..aa6b6b2a 100644
--- a/src/main/java/org/apache/commons/text/similarity/SimilarityInput.java
+++ b/src/main/java/org/apache/commons/text/similarity/SimilarityInput.java
@@ -63,14 +63,14 @@ public interface SimilarityInput<E> {
* Gets the element in the input at the given 0-based index.
*
* @param index a 0-based index.
- * @return the element in the input at the given 0-based index.
+ * @return The element in the input at the given 0-based index.
*/
E at(int index);
/**
* Gets the length of the input.
*
- * @return the length of the input.
+ * @return The length of the input.
*/
int length();
diff --git
a/src/test/java/org/apache/commons/text/jmh/DoubleFormatPerformance.java
b/src/test/java/org/apache/commons/text/jmh/DoubleFormatPerformance.java
index f17d9171..00615935 100644
--- a/src/test/java/org/apache/commons/text/jmh/DoubleFormatPerformance.java
+++ b/src/test/java/org/apache/commons/text/jmh/DoubleFormatPerformance.java
@@ -68,7 +68,7 @@ public class DoubleFormatPerformance {
private double[] input;
/** Gets the input doubles.
- * @return the input doubles
+ * @return The input doubles
*/
public double[] getInput() {
return input;
diff --git
a/src/test/java/org/apache/commons/text/lookup/ConstantStringLookupTest.java
b/src/test/java/org/apache/commons/text/lookup/ConstantStringLookupTest.java
index fccc45d7..59111107 100644
--- a/src/test/java/org/apache/commons/text/lookup/ConstantStringLookupTest.java
+++ b/src/test/java/org/apache/commons/text/lookup/ConstantStringLookupTest.java
@@ -135,7 +135,7 @@ class ConstantStringLookupTest {
* Generates the name of a variable for a lookup operation based on the
given field name of this class.
*
* @param field the field name
- * @return the variable for looking up this field
+ * @return The variable for looking up this field
*/
private String variable(final String field) {
return getClass().getName() + '.' + field;
diff --git
a/src/test/java/org/apache/commons/text/similarity/IntersectionSimilarityTest.java
b/src/test/java/org/apache/commons/text/similarity/IntersectionSimilarityTest.java
index 9fc1f433..ac5e4878 100644
---
a/src/test/java/org/apache/commons/text/similarity/IntersectionSimilarityTest.java
+++
b/src/test/java/org/apache/commons/text/similarity/IntersectionSimilarityTest.java
@@ -47,7 +47,7 @@ class IntersectionSimilarityTest {
* Convert the {@link CharSequence} to a {@link List} of bigrams (pairs of
characters). These are represented using 2 16-bit chars packed into a 32-bit
int.
*
* @param sequence the sequence
- * @return the list
+ * @return The list
*/
private static List<Integer> toBigramList(final CharSequence sequence) {
final int length = sequence.length();
@@ -67,7 +67,7 @@ class IntersectionSimilarityTest {
* Convert the {@link CharSequence} to a {@link Set} of bigrams (pairs of
characters). These are represented using 2 16-bit chars packed into a 32-bit
int.
*
* @param sequence the sequence
- * @return the set
+ * @return The set
*/
private static Set<Integer> toBigramSet(final CharSequence sequence) {
final int length = sequence.length();
@@ -87,7 +87,7 @@ class IntersectionSimilarityTest {
* Convert the {@link CharSequence} to a {@link List} of {@link
Character}s.
*
* @param sequence the sequence
- * @return the list
+ * @return The list
*/
private static List<Character> toCharacterList(final CharSequence
sequence) {
final int length = sequence.length();
@@ -102,7 +102,7 @@ class IntersectionSimilarityTest {
* Convert the {@link CharSequence} to a {@link Set} of {@link Character}s.
*
* @param sequence the sequence
- * @return the set
+ * @return The set
*/
private static Set<Character> toCharacterSet(final CharSequence sequence) {
final int length = sequence.length();
diff --git
a/src/test/java/org/apache/commons/text/similarity/JaroWinklerSimilarityTest.java
b/src/test/java/org/apache/commons/text/similarity/JaroWinklerSimilarityTest.java
index 55986ab5..44bb1da3 100644
---
a/src/test/java/org/apache/commons/text/similarity/JaroWinklerSimilarityTest.java
+++
b/src/test/java/org/apache/commons/text/similarity/JaroWinklerSimilarityTest.java
@@ -42,7 +42,7 @@ class JaroWinklerSimilarityTest {
* equality will fail.
*
* @param string the string
- * @return the char sequence
+ * @return The char sequence
*/
private static CharSequence wrap(final String string) {
return new CharSequence() {
