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-text.git
The following commit(s) were added to refs/heads/master by this push:
new 97f563d8 Javadoc
97f563d8 is described below
commit 97f563d884300f237b679374522fb164f1f0bc3b
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sun Jul 21 11:49:13 2024 -0400
Javadoc
Use HTML 'em' tag instead of 'i' tag
---
.../org/apache/commons/text/ExtendedMessageFormat.java | 10 +++++-----
src/main/java/org/apache/commons/text/StrTokenizer.java | 10 +++++-----
src/main/java/org/apache/commons/text/StringTokenizer.java | 10 +++++-----
src/main/java/org/apache/commons/text/WordUtils.java | 2 +-
.../commons/text/similarity/LongestCommonSubsequence.java | 14 +++++++-------
.../text/similarity/LongestCommonSubsequenceDistance.java | 2 +-
6 files changed, 24 insertions(+), 24 deletions(-)
diff --git a/src/main/java/org/apache/commons/text/ExtendedMessageFormat.java
b/src/main/java/org/apache/commons/text/ExtendedMessageFormat.java
index be7b1705..60d63e94 100644
--- a/src/main/java/org/apache/commons/text/ExtendedMessageFormat.java
+++ b/src/main/java/org/apache/commons/text/ExtendedMessageFormat.java
@@ -40,14 +40,14 @@ import org.apache.commons.text.matcher.StringMatcherFactory;
* 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 {}<i>argument-number</i><b>(</b>{@code ,}<i>format-name</i><b>
- * (</b>{@code ,}<i>format-style</i><b>)?)?</b>{@code }}
+ * {@code {}<em>argument-number</em><b>(</b>{@code ,}<em>format-name</em><b>
+ * (</b>{@code ,}<em>format-style</em><b>)?)?</b>{@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 {@code
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 {@code Format}
* found is used for this format element.
* </p>
diff --git a/src/main/java/org/apache/commons/text/StrTokenizer.java
b/src/main/java/org/apache/commons/text/StrTokenizer.java
index e58b8b1c..71d5a652 100644
--- a/src/main/java/org/apache/commons/text/StrTokenizer.java
+++ b/src/main/java/org/apache/commons/text/StrTokenizer.java
@@ -35,20 +35,20 @@ import org.apache.commons.lang3.StringUtils;
* the {@code ListIterator} interface. By default, it is set up
* like {@code StringTokenizer}.
* <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>
* 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>
* 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>
* 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>
* Empty tokens may be removed or returned as null.
diff --git a/src/main/java/org/apache/commons/text/StringTokenizer.java
b/src/main/java/org/apache/commons/text/StringTokenizer.java
index 33ea73ca..bb7bd747 100644
--- a/src/main/java/org/apache/commons/text/StringTokenizer.java
+++ b/src/main/java/org/apache/commons/text/StringTokenizer.java
@@ -35,16 +35,16 @@ import org.apache.commons.text.matcher.StringMatcherFactory;
* {@link java.util.StringTokenizer StringTokenizer}, however it offers much
more control and flexibility including
* implementing the {@code ListIterator} interface. By default, it is set up
like {@code StringTokenizer}.
* <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>. One or more delimiter characters must be specified.
+ * 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>
- * Each token may be surrounded by quotes. The <i>quote</i> matcher specifies
the quote character(s). A quote may be
+ * Each token may be surrounded by quotes. The <em>quote</em> matcher
specifies the quote character(s). A quote may be
* escaped within a quoted section by duplicating itself.
* <p>
- * Between each token and the delimiter are potentially characters that need
trimming. The <i>trimmer</i> matcher
+ * Between each token and the delimiter are potentially characters that need
trimming. The <em>trimmer</em> matcher
* specifies these characters. One usage might be to trim whitespace
characters.
* <p>
- * At any point outside the quotes there might potentially be invalid
characters. The <i>ignored</i> matcher specifies
+ * At any point outside the quotes there might potentially be invalid
characters. The <em>ignored</em> matcher specifies
* these characters to be removed. One usage might be to remove new line
characters.
* <p>
* Empty tokens may be removed or returned as null.
diff --git a/src/main/java/org/apache/commons/text/WordUtils.java
b/src/main/java/org/apache/commons/text/WordUtils.java
index 4acfa083..a52de893 100644
--- a/src/main/java/org/apache/commons/text/WordUtils.java
+++ b/src/main/java/org/apache/commons/text/WordUtils.java
@@ -565,7 +565,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>
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 b91f23c0..c5ba729c 100644
---
a/src/main/java/org/apache/commons/text/similarity/LongestCommonSubsequence.java
+++
b/src/main/java/org/apache/commons/text/similarity/LongestCommonSubsequence.java
@@ -23,9 +23,9 @@ package org.apache.commons.text.similarity;
* The Longest common subsequence algorithm returns the length of the longest
subsequence that two strings have in
* common. Two strings that are entirely different, return a value of 0, and
two strings that return a value
* of the commonly shared length implies that the strings are completely the
same in value and position.
- * <i>Note.</i> Generally this algorithm is fairly inefficient, as for length
<i>m</i>, <i>n</i> of the input
+ * <em>Note.</em> Generally this algorithm is fairly inefficient, as for
length <em>m</em>, <em>n</em> of the input
* {@code CharSequence}'s {@code left} and {@code right} respectively, the
runtime of the
- * algorithm is <i>O(m*n)</i>.
+ * algorithm is <em>O(m*n)</em>.
* </p>
*
* <p>
@@ -40,7 +40,7 @@ package org.apache.commons.text.similarity;
* <p>For further reading see:</p>
* <ul>
* <li>
- * Lothaire, M. <i>Applied combinatorics on words</i>. New York: Cambridge U
Press, 2005. <b>12-13</b>
+ * Lothaire, M. <em>Applied combinatorics on words</em>. New York: Cambridge U
Press, 2005. <b>12-13</b>
* </li>
* <li>
* D. S. Hirschberg, "A linear space algorithm for computing maximal common
subsequences," CACM, 1975, pp. 341--343.
@@ -60,7 +60,7 @@ public class LongestCommonSubsequence implements
SimilarityScore<Integer> {
* An implementation of "ALG B" from Hirschberg's CACM '71 paper.
* Assuming the first input sequence is of size <code>m</code> and the
second input sequence is of size
* <code>n</code>, this method returns the last row of the dynamic
programming (DP) table when calculating
- * the LCS of the two sequences in <i>O(m*n)</i> time and <i>O(n)</i>
space.
+ * the LCS of the two sequences in <em>O(m*n)</em> time and <em>O(n)</em>
space.
* The last element of the returned array, is the size of the LCS of the
two input sequences.
*
* @param left first input sequence.
@@ -103,7 +103,7 @@ public class LongestCommonSubsequence implements
SimilarityScore<Integer> {
* An implementation of "ALG C" from Hirschberg's CACM '71 paper.
* Assuming the first input sequence is of size <code>m</code> and the
second input sequence is of size
* <code>n</code>, this method returns the Longest Common Subsequence
(LCS) of the two sequences in
- * <i>O(m*n)</i> time and <i>O(m+n)</i> space.
+ * <em>O(m*n)</em> time and <em>O(m+n)</em> space.
*
* @param left first input sequence.
* @param right second input sequence.
@@ -210,7 +210,7 @@ public class LongestCommonSubsequence implements
SimilarityScore<Integer> {
* </p>
*
* <p>
- * For reference, we give the definition of a subsequence for the reader:
a <i>subsequence</i> is a sequence that
+ * For reference, we give the definition of a subsequence for the reader:
a <em>subsequence</em> is a sequence that
* can be derived from another sequence by deleting some elements without
changing the order of the remaining
* elements.
* </p>
@@ -246,7 +246,7 @@ public class LongestCommonSubsequence implements
SimilarityScore<Integer> {
* </p>
*
* <p>
- * For reference, we give the definition of a subsequence for the reader:
a <i>subsequence</i> is a sequence that
+ * For reference, we give the definition of a subsequence for the reader:
a <em>subsequence</em> is a sequence that
* can be derived from another sequence by deleting some elements without
changing the order of the remaining
* elements.
* </p>
diff --git
a/src/main/java/org/apache/commons/text/similarity/LongestCommonSubsequenceDistance.java
b/src/main/java/org/apache/commons/text/similarity/LongestCommonSubsequenceDistance.java
index f5f5bcf9..6bf3d0bc 100644
---
a/src/main/java/org/apache/commons/text/similarity/LongestCommonSubsequenceDistance.java
+++
b/src/main/java/org/apache/commons/text/similarity/LongestCommonSubsequenceDistance.java
@@ -30,7 +30,7 @@ package org.apache.commons.text.similarity;
*
* <p>For further reading see:</p>
*
- * <p>Lothaire, M. <i>Applied combinatorics on words</i>. New York: Cambridge
U Press, 2005. <b>12-13</b></p>
+ * <p>Lothaire, M. <em>Applied combinatorics on words</em>. New York:
Cambridge U Press, 2005. <b>12-13</b></p>
*
* @since 1.0
*/
