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-lang.git
The following commit(s) were added to refs/heads/master by this push:
new b7be19dc9 Javadoc
b7be19dc9 is described below
commit b7be19dc9f26c86fba870a9d9dcb1391c51b053b
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sun Jul 21 11:40:50 2024 -0400
Javadoc
Use HTML 'em' tag instead of 'i' tag
---
.../org/apache/commons/lang3/BooleanUtils.java | 4 +--
.../apache/commons/lang3/CharSequenceUtils.java | 16 +++++------
.../java/org/apache/commons/lang3/CharSet.java | 2 +-
src/main/java/org/apache/commons/lang3/Range.java | 2 +-
.../java/org/apache/commons/lang3/StringUtils.java | 32 +++++++++++-----------
.../org/apache/commons/lang3/builder/Diffable.java | 2 +-
.../commons/lang3/builder/HashCodeBuilder.java | 2 +-
.../lang3/builder/ReflectionToStringBuilder.java | 2 +-
.../org/apache/commons/lang3/math/Fraction.java | 6 ++--
.../commons/lang3/text/ExtendedMessageFormat.java | 10 +++----
.../apache/commons/lang3/text/StrTokenizer.java | 10 +++----
.../org/apache/commons/lang3/text/WordUtils.java | 2 +-
12 files changed, 45 insertions(+), 45 deletions(-)
diff --git a/src/main/java/org/apache/commons/lang3/BooleanUtils.java
b/src/main/java/org/apache/commons/lang3/BooleanUtils.java
index f8f93fa75..dc5d142fc 100644
--- a/src/main/java/org/apache/commons/lang3/BooleanUtils.java
+++ b/src/main/java/org/apache/commons/lang3/BooleanUtils.java
@@ -190,7 +190,7 @@ public class BooleanUtils {
}
/**
- * Checks if a {@link Boolean} value is <i>not</i> {@code false},
+ * Checks if a {@link Boolean} value is <em>not</em> {@code false},
* handling {@code null} by returning {@code true}.
*
* <pre>
@@ -208,7 +208,7 @@ public class BooleanUtils {
}
/**
- * Checks if a {@link Boolean} value is <i>not</i> {@code true},
+ * Checks if a {@link Boolean} value is <em>not</em> {@code true},
* handling {@code null} by returning {@code true}.
*
* <pre>
diff --git a/src/main/java/org/apache/commons/lang3/CharSequenceUtils.java
b/src/main/java/org/apache/commons/lang3/CharSequenceUtils.java
index eaec29a0e..aa48d1207 100644
--- a/src/main/java/org/apache/commons/lang3/CharSequenceUtils.java
+++ b/src/main/java/org/apache/commons/lang3/CharSequenceUtils.java
@@ -77,15 +77,15 @@ public class CharSequenceUtils {
* object at an index no smaller than {@code start}, then
* the index of the first such occurrence is returned. For values
* of {@code searchChar} in the range from 0 to 0xFFFF (inclusive),
- * this is the smallest value <i>k</i> such that:
+ * this is the smallest value <em>k</em> such that:
* </p>
* <blockquote><pre>
- * (this.charAt(<i>k</i>) == searchChar) && (<i>k</i> >= start)
+ * (this.charAt(<em>k</em>) == searchChar) && (<em>k</em> >=
start)
* </pre></blockquote>
* is true. For other values of {@code searchChar}, it is the
- * smallest value <i>k</i> such that:
+ * smallest value <em>k</em> such that:
* <blockquote><pre>
- * (this.codePointAt(<i>k</i>) == searchChar) && (<i>k</i> >=
start)
+ * (this.codePointAt(<em>k</em>) == searchChar) && (<em>k</em>
>= start)
* </pre></blockquote>
* <p>
* is true. In either case, if no such character occurs inm {@code cs}
@@ -219,14 +219,14 @@ public class CharSequenceUtils {
* the specified character, searching backward starting at the
* specified index. For values of {@code searchChar} in the range
* from 0 to 0xFFFF (inclusive), the index returned is the largest
- * value <i>k</i> such that:
+ * value <em>k</em> such that:
* <blockquote><pre>
- * (this.charAt(<i>k</i>) == searchChar) && (<i>k</i> <= start)
+ * (this.charAt(<em>k</em>) == searchChar) && (<em>k</em> <=
start)
* </pre></blockquote>
* is true. For other values of {@code searchChar}, it is the
- * largest value <i>k</i> such that:
+ * largest value <em>k</em> such that:
* <blockquote><pre>
- * (this.codePointAt(<i>k</i>) == searchChar) && (<i>k</i> <=
start)
+ * (this.codePointAt(<em>k</em>) == searchChar) && (<em>k</em>
<= start)
* </pre></blockquote>
* is true. In either case, if no such character occurs in {@code cs}
* at or before position {@code start}, then {@code -1} is returned.
diff --git a/src/main/java/org/apache/commons/lang3/CharSet.java
b/src/main/java/org/apache/commons/lang3/CharSet.java
index 80aa2ef17..56c33607a 100644
--- a/src/main/java/org/apache/commons/lang3/CharSet.java
+++ b/src/main/java/org/apache/commons/lang3/CharSet.java
@@ -228,7 +228,7 @@ public class CharSet implements Serializable {
* Compares two {@link CharSet} objects, returning true if they represent
* exactly the same set of characters defined in the same way.
*
- * <p>The two sets {@code abc} and {@code a-c} are <i>not</i>
+ * <p>The two sets {@code abc} and {@code a-c} are <em>not</em>
* equal according to this method.</p>
*
* @param obj the object to compare to
diff --git a/src/main/java/org/apache/commons/lang3/Range.java
b/src/main/java/org/apache/commons/lang3/Range.java
index 1ceb8329e..e7d167337 100644
--- a/src/main/java/org/apache/commons/lang3/Range.java
+++ b/src/main/java/org/apache/commons/lang3/Range.java
@@ -533,7 +533,7 @@ public class Range<T> implements Serializable {
/**
* Gets the range as a {@link String}.
*
- * <p>The format of the String is '[<i>min</i>..<i>max</i>]'.</p>
+ * <p>The format of the String is '[<em>min</em>..<em>max</em>]'.</p>
*
* @return the {@link String} representation of this range
*/
diff --git a/src/main/java/org/apache/commons/lang3/StringUtils.java
b/src/main/java/org/apache/commons/lang3/StringUtils.java
index 82612f277..cccf53d56 100644
--- a/src/main/java/org/apache/commons/lang3/StringUtils.java
+++ b/src/main/java/org/apache/commons/lang3/StringUtils.java
@@ -2684,14 +2684,14 @@ public class StringUtils {
* {@code seq} {@link CharSequence} object, then the index (in Unicode
* code units) of the first such occurrence is returned. For
* values of {@code searchChar} in the range from 0 to 0xFFFF
- * (inclusive), this is the smallest value <i>k</i> such that:
+ * (inclusive), this is the smallest value <em>k</em> such that:
* <blockquote><pre>
- * this.charAt(<i>k</i>) == searchChar
+ * this.charAt(<em>k</em>) == searchChar
* </pre></blockquote>
* is true. For other values of {@code searchChar}, it is the
- * smallest value <i>k</i> such that:
+ * smallest value <em>k</em> such that:
* <blockquote><pre>
- * this.codePointAt(<i>k</i>) == searchChar
+ * this.codePointAt(<em>k</em>) == searchChar
* </pre></blockquote>
* is true. In either case, if no such character occurs in {@code seq},
* then {@code INDEX_NOT_FOUND (-1)} is returned.
@@ -2730,14 +2730,14 @@ public class StringUtils {
* object at an index no smaller than {@code startPos}, then
* the index of the first such occurrence is returned. For values
* of {@code searchChar} in the range from 0 to 0xFFFF (inclusive),
- * this is the smallest value <i>k</i> such that:
+ * this is the smallest value <em>k</em> such that:
* <blockquote><pre>
- * (this.charAt(<i>k</i>) == searchChar) && (<i>k</i> >=
startPos)
+ * (this.charAt(<em>k</em>) == searchChar) && (<em>k</em> >=
startPos)
* </pre></blockquote>
* is true. For other values of {@code searchChar}, it is the
- * smallest value <i>k</i> such that:
+ * smallest value <em>k</em> such that:
* <blockquote><pre>
- * (this.codePointAt(<i>k</i>) == searchChar) && (<i>k</i> >=
startPos)
+ * (this.codePointAt(<em>k</em>) == searchChar) && (<em>k</em>
>= startPos)
* </pre></blockquote>
* is true. In either case, if no such character occurs in {@code seq}
* at or after position {@code startPos}, then
@@ -4924,14 +4924,14 @@ public class StringUtils {
* Returns the index within {@code seq} of the last occurrence of
* the specified character. For values of {@code searchChar} in the
* range from 0 to 0xFFFF (inclusive), the index (in Unicode code
- * units) returned is the largest value <i>k</i> such that:
+ * units) returned is the largest value <em>k</em> such that:
* <blockquote><pre>
- * this.charAt(<i>k</i>) == searchChar
+ * this.charAt(<em>k</em>) == searchChar
* </pre></blockquote>
* is true. For other values of {@code searchChar}, it is the
- * largest value <i>k</i> such that:
+ * largest value <em>k</em> such that:
* <blockquote><pre>
- * this.codePointAt(<i>k</i>) == searchChar
+ * this.codePointAt(<em>k</em>) == searchChar
* </pre></blockquote>
* is true. In either case, if no such character occurs in this
* string, then {@code -1} is returned. Furthermore, a {@code null} or
empty ("")
@@ -4966,14 +4966,14 @@ public class StringUtils {
* the specified character, searching backward starting at the
* specified index. For values of {@code searchChar} in the range
* from 0 to 0xFFFF (inclusive), the index returned is the largest
- * value <i>k</i> such that:
+ * value <em>k</em> such that:
* <blockquote><pre>
- * (this.charAt(<i>k</i>) == searchChar) && (<i>k</i> <=
startPos)
+ * (this.charAt(<em>k</em>) == searchChar) && (<em>k</em> <=
startPos)
* </pre></blockquote>
* is true. For other values of {@code searchChar}, it is the
- * largest value <i>k</i> such that:
+ * largest value <em>k</em> such that:
* <blockquote><pre>
- * (this.codePointAt(<i>k</i>) == searchChar) && (<i>k</i> <=
startPos)
+ * (this.codePointAt(<em>k</em>) == searchChar) && (<em>k</em>
<= startPos)
* </pre></blockquote>
* is true. In either case, if no such character occurs in {@code seq}
* at or before position {@code startPos}, then
diff --git a/src/main/java/org/apache/commons/lang3/builder/Diffable.java
b/src/main/java/org/apache/commons/lang3/builder/Diffable.java
index cf4b33f0e..dc613e1fb 100644
--- a/src/main/java/org/apache/commons/lang3/builder/Diffable.java
+++ b/src/main/java/org/apache/commons/lang3/builder/Diffable.java
@@ -21,7 +21,7 @@ package org.apache.commons.lang3.builder;
* for differences. The {@link DiffResult} object retrieved can be queried
* for a list of differences or printed using the {@link
DiffResult#toString()}.
*
- * <p>The calculation of the differences is <i>consistent with equals</i> if
+ * <p>The calculation of the differences is <em>consistent with equals</em> if
* and only if {@code d1.equals(d2)} implies {@code d1.diff(d2) == ""}.
* It is strongly recommended that implementations are consistent with equals
* to avoid confusion. Note that {@code null} is not an instance of any class
diff --git
a/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java
b/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java
index c347ed654..cc24f2724 100644
--- a/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java
@@ -542,7 +542,7 @@ public class HashCodeBuilder implements Builder<Integer> {
* that represent {@code false}.
* </p>
* <p>
- * This is in accordance with the <i>Effective Java</i> design.
+ * This is in accordance with the <em>Effective Java</em> design.
* </p>
*
* @param value
diff --git
a/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java
b/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java
index e6c83b8e0..fa95b4e7e 100644
---
a/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java
+++
b/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java
@@ -68,7 +68,7 @@ import org.apache.commons.lang3.stream.Streams;
* <li>{@link #getValue(java.lang.reflect.Field)}</li>
* </ul>
* <p>
- * For example, this method does <i>not</i> include the {@code password} field
in the returned {@link String}:
+ * For example, this method does <em>not</em> include the {@code password}
field in the returned {@link String}:
* </p>
* <pre>
* public String toString() {
diff --git a/src/main/java/org/apache/commons/lang3/math/Fraction.java
b/src/main/java/org/apache/commons/lang3/math/Fraction.java
index d1ff02c06..3d67ca754 100644
--- a/src/main/java/org/apache/commons/lang3/math/Fraction.java
+++ b/src/main/java/org/apache/commons/lang3/math/Fraction.java
@@ -26,7 +26,7 @@ import java.util.Objects;
* <p>This class is immutable, and interoperable with most methods that accept
* a {@link Number}.</p>
*
- * <p>Note that this class is intended for common use cases, it is <i>int</i>
+ * <p>Note that this class is intended for common use cases, it is <em>int</em>
* based and thus suffers from various overflow issues. For a BigInteger based
* equivalent, please see the Commons Math BigFraction class.</p>
*
@@ -857,7 +857,7 @@ public final class Fraction extends Number implements
Comparable<Fraction> {
/**
* Gets the fraction as a proper {@link String} in the format X Y/Z.
*
- * <p>The format used in '<i>wholeNumber</i>
<i>numerator</i>/<i>denominator</i>'.
+ * <p>The format used in '<em>wholeNumber</em>
<em>numerator</em>/<em>denominator</em>'.
* If the whole number is zero it will be omitted. If the numerator is
zero,
* only the whole number is returned.</p>
*
@@ -892,7 +892,7 @@ public final class Fraction extends Number implements
Comparable<Fraction> {
/**
* Gets the fraction as a {@link String}.
*
- * <p>The format used is '<i>numerator</i>/<i>denominator</i>' always.
+ * <p>The format used is '<em>numerator</em>/<em>denominator</em>' always.
*
* @return a {@link String} form of the fraction
*/
diff --git
a/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java
b/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java
index 4b47f28fd..8fedbe167 100644
--- a/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java
+++ b/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java
@@ -38,14 +38,14 @@ import org.apache.commons.lang3.Validate;
* and the formats supported by {@link java.text.MessageFormat} can be
overridden
* at the format and/or format style level (see MessageFormat). A "format
element"
* embedded in the message pattern is specified (<b>()?</b> signifies
optionality):<br>
- * <code>{</code><i>argument-number</i><b>(</b>{@code ,}<i>format-name</i><b>
- * (</b>{@code ,}<i>format-style</i><b>)?)?</b><code>}</code>
+ * <code>{</code><em>argument-number</em><b>(</b>{@code
,}<em>format-name</em><b>
+ * (</b>{@code ,}<em>format-style</em><b>)?)?</b><code>}</code>
*
* <p>
- * <i>format-name</i> and <i>format-style</i> values are trimmed of
surrounding whitespace
- * in the manner of {@link java.text.MessageFormat}. If <i>format-name</i>
denotes
+ * <em>format-name</em> and <em>format-style</em> values are trimmed of
surrounding whitespace
+ * in the manner of {@link java.text.MessageFormat}. If <em>format-name</em>
denotes
* {@code FormatFactory formatFactoryInstance} in {@code registry}, a {@link
Format}
- * matching <i>format-name</i> and <i>format-style</i> is requested from
+ * matching <em>format-name</em> and <em>format-style</em> is requested from
* {@code formatFactoryInstance}. If this is successful, the {@link Format}
* found is used for this format element.
* </p>
diff --git a/src/main/java/org/apache/commons/lang3/text/StrTokenizer.java
b/src/main/java/org/apache/commons/lang3/text/StrTokenizer.java
index e82dc3cc0..77014a769 100644
--- a/src/main/java/org/apache/commons/lang3/text/StrTokenizer.java
+++ b/src/main/java/org/apache/commons/lang3/text/StrTokenizer.java
@@ -38,23 +38,23 @@ import org.apache.commons.lang3.StringUtils;
* like {@link StringTokenizer}.
* </p>
* <p>
- * The input String is split into a number of <i>tokens</i>.
- * Each token is separated from the next String by a <i>delimiter</i>.
+ * The input String is split into a number of <em>tokens</em>.
+ * Each token is separated from the next String by a <em>delimiter</em>.
* One or more delimiter characters must be specified.
* </p>
* <p>
* Each token may be surrounded by quotes.
- * The <i>quote</i> matcher specifies the quote character(s).
+ * The <em>quote</em> matcher specifies the quote character(s).
* A quote may be escaped within a quoted section by duplicating itself.
* </p>
* <p>
* Between each token and the delimiter are potentially characters that need
trimming.
- * The <i>trimmer</i> matcher specifies these characters.
+ * The <em>trimmer</em> matcher specifies these characters.
* One usage might be to trim whitespace characters.
* </p>
* <p>
* At any point outside the quotes there might potentially be invalid
characters.
- * The <i>ignored</i> matcher specifies these characters to be removed.
+ * The <em>ignored</em> matcher specifies these characters to be removed.
* One usage might be to remove new line characters.
* </p>
* <p>
diff --git a/src/main/java/org/apache/commons/lang3/text/WordUtils.java
b/src/main/java/org/apache/commons/lang3/text/WordUtils.java
index 0115150dd..55024d6c5 100644
--- a/src/main/java/org/apache/commons/lang3/text/WordUtils.java
+++ b/src/main/java/org/apache/commons/lang3/text/WordUtils.java
@@ -412,7 +412,7 @@ public class WordUtils {
* Wraps a single line of text, identifying words by {@code ' '}.
*
* <p>New lines will be separated by the system property line separator.
- * Very long words, such as URLs will <i>not</i> be wrapped.</p>
+ * Very long words, such as URLs will <em>not</em> be wrapped.</p>
*
* <p>Leading spaces on a new line are stripped.
* Trailing spaces are not stripped.</p>
