Skip to content

Commit

Permalink
Javadoc
Browse files Browse the repository at this point in the history
Use HTML 'em' tag instead of 'i' tag
  • Loading branch information
garydgregory committed Jul 21, 2024
1 parent 81cc058 commit 97f563d
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 24 deletions.
10 changes: 5 additions & 5 deletions src/main/java/org/apache/commons/text/ExtendedMessageFormat.java
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,14 @@
* 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>
Expand Down
10 changes: 5 additions & 5 deletions src/main/java/org/apache/commons/text/StrTokenizer.java
Original file line number Diff line number Diff line change
Expand Up @@ -35,20 +35,20 @@
* 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.
Expand Down
10 changes: 5 additions & 5 deletions src/main/java/org/apache/commons/text/StringTokenizer.java
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,16 @@
* {@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.
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/apache/commons/text/WordUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -565,7 +565,7 @@ public static String uncapitalize(final String str, final char... delimiters) {
* 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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@
* 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>
Expand All @@ -40,7 +40,7 @@
* <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.
Expand All @@ -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.
Expand Down Expand Up @@ -103,7 +103,7 @@ private static int[] algorithmB(final CharSequence left, final CharSequence righ
* 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.
Expand Down Expand Up @@ -210,7 +210,7 @@ public Integer apply(final CharSequence left, final CharSequence right) {
* </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>
Expand Down Expand Up @@ -246,7 +246,7 @@ public CharSequence logestCommonSubsequence(final CharSequence left, final CharS
* </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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
*
* <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
*/
Expand Down

0 comments on commit 97f563d

Please sign in to comment.