Javadoc: Replace <code></code> HTML tags with Javadoc {@code} notation.diff --git a/src/main/java/org/apache/commons/text/CaseUtils.java b/src/main/java/org/apache/commons/text/CaseUtils.java
index 0144db8..d3c9684 100644
--- a/src/main/java/org/apache/commons/text/CaseUtils.java
+++ b/src/main/java/org/apache/commons/text/CaseUtils.java
@@ -24,8 +24,8 @@
/**
* <p>Case manipulation operations on Strings that contain words.</p>
*
- * <p>This class tries to handle <code>null</code> input gracefully.
- * An exception will not be thrown for a <code>null</code> input.
+ * <p>This class tries to handle {@code null} input gracefully.
+ * An exception will not be thrown for a {@code null} input.
* Each method documents its behaviour in more detail.</p>
*
* @since 1.2
@@ -33,9 +33,9 @@
public class CaseUtils {
/**
- * <p><code>CaseUtils</code> instances should NOT be constructed in
+ * <p>{@code CaseUtils} instances should NOT be constructed in
* standard programming. Instead, the class should be used as
- * <code>CaseUtils.toCamelCase("foo bar", true, new char[]{'-'});</code>.</p>
+ * {@code CaseUtils.toCamelCase("foo bar", true, new char[]{'-'});}.</p>
*
* <p>This constructor is public to permit tools that require a JavaBean
* instance to operate.</p>
@@ -54,7 +54,7 @@
* character may or may not be capitalized and it's determined by the user input for capitalizeFirstLetter
* variable.</p>
*
- * <p>A <code>null</code> input String returns <code>null</code>.
+ * <p>A {@code null} input String returns {@code null}.
* Capitalization uses the Unicode title case, normally equivalent to
* upper case and cannot perform locale-sensitive mappings.</p>
*
@@ -71,7 +71,7 @@
* @param str the String to be converted to camelCase, may be null
* @param capitalizeFirstLetter boolean that determines if the first character of first word should be title case.
* @param delimiters set of characters to determine capitalization, null and/or empty array means whitespace
- * @return camelCase of String, <code>null</code> if null String input
+ * @return camelCase of String, {@code null} if null String input
*/
public static String toCamelCase(String str, final boolean capitalizeFirstLetter, final char... delimiters) {
if (StringUtils.isEmpty(str)) {
diff --git a/src/main/java/org/apache/commons/text/CompositeFormat.java b/src/main/java/org/apache/commons/text/CompositeFormat.java
index 8f1e116..7d5fd14 100644
--- a/src/main/java/org/apache/commons/text/CompositeFormat.java
+++ b/src/main/java/org/apache/commons/text/CompositeFormat.java
@@ -60,7 +60,7 @@
* @param obj the object to format
* @param toAppendTo the {@link StringBuffer} to append to
* @param pos the FieldPosition to use (or ignore).
- * @return <code>toAppendTo</code>
+ * @return {@code toAppendTo}
* @see Format#format(Object, StringBuffer, FieldPosition)
*/
@Override // Therefore has to use StringBuffer
diff --git a/src/main/java/org/apache/commons/text/ExtendedMessageFormat.java b/src/main/java/org/apache/commons/text/ExtendedMessageFormat.java
index 612845f..e4b5b6a 100644
--- a/src/main/java/org/apache/commons/text/ExtendedMessageFormat.java
+++ b/src/main/java/org/apache/commons/text/ExtendedMessageFormat.java
@@ -30,38 +30,38 @@
import org.apache.commons.text.matcher.StringMatcherFactory;
/**
- * Extends <code>java.text.MessageFormat</code> to allow pluggable/additional formatting
+ * Extends {@code java.text.MessageFormat} to allow pluggable/additional formatting
* options for embedded format elements. Client code should specify a registry
- * of <code>FormatFactory</code> instances associated with <code>String</code>
+ * of {@code FormatFactory} instances associated with {@code String}
* format names. This registry will be consulted when the format elements are
* parsed from the message pattern. In this way custom patterns can be specified,
- * and the formats supported by <code>java.text.MessageFormat</code> can be overridden
+ * and the formats supported by {@code 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>,</code><i>format-name</i><b>
- * (</b><code>,</code><i>format-style</i><b>)?)?</b><code>}</code>
+ * {@code {}<i>argument-number</i><b>(</b>{@code ,}<i>format-name</i><b>
+ * (</b>{@code ,}<i>format-style</i><b>)?)?</b>{@code }}
*
* <p>
* <i>format-name</i> and <i>format-style</i> values are trimmed of surrounding whitespace
- * in the manner of <code>java.text.MessageFormat</code>. If <i>format-name</i> denotes
- * <code>FormatFactory formatFactoryInstance</code> in <code>registry</code>, a <code>Format</code>
+ * in the manner of {@code java.text.MessageFormat}. If <i>format-name</i> denotes
+ * {@code FormatFactory formatFactoryInstance} in {@code registry}, a {@code Format}
* matching <i>format-name</i> and <i>format-style</i> is requested from
- * <code>formatFactoryInstance</code>. If this is successful, the <code>Format</code>
+ * {@code formatFactoryInstance}. If this is successful, the {@code Format}
* found is used for this format element.
* </p>
*
* <p><b>NOTICE:</b> The various subformat mutator methods are considered unnecessary; they exist on the parent
* class to allow the type of customization which it is the job of this class to provide in
* a configurable fashion. These methods have thus been disabled and will throw
- * <code>UnsupportedOperationException</code> if called.
+ * {@code UnsupportedOperationException} if called.
* </p>
*
- * <p>Limitations inherited from <code>java.text.MessageFormat</code>:</p>
+ * <p>Limitations inherited from {@code java.text.MessageFormat}:</p>
* <ul>
* <li>When using "choice" subformats, support for nested formatting instructions is limited
* to that provided by the base class.</li>
- * <li>Thread-safety of <code>Format</code>s, including <code>MessageFormat</code> and thus
- * <code>ExtendedMessageFormat</code>, is not guaranteed.</li>
+ * <li>Thread-safety of {@code Format}s, including {@code MessageFormat} and thus
+ * {@code ExtendedMessageFormat}, is not guaranteed.</li>
* </ul>
*
* @since 1.0
@@ -501,7 +501,7 @@
* Convenience method to advance parse position by 1.
*
* @param pos ParsePosition
- * @return <code>pos</code>
+ * @return {@code pos}
*/
private ParsePosition next(final ParsePosition pos) {
pos.setIndex(pos.getIndex() + 1);
@@ -509,13 +509,13 @@
}
/**
- * Consume a quoted string, adding it to <code>appendTo</code> if
+ * Consume a quoted string, adding it to {@code appendTo} if
* specified.
*
* @param pattern pattern to parse
* @param pos current parse position
* @param appendTo optional StringBuilder to append
- * @return <code>appendTo</code>
+ * @return {@code appendTo}
*/
private StringBuilder appendQuotedString(final String pattern, final ParsePosition pos,
final StringBuilder appendTo) {
@@ -558,7 +558,7 @@
/**
* Learn whether the specified Collection contains non-null elements.
* @param coll to check
- * @return <code>true</code> if some Object was found, <code>false</code> otherwise.
+ * @return {@code true} if some Object was found, {@code false} otherwise.
*/
private boolean containsElements(final Collection<?> coll) {
if (coll == null || coll.isEmpty()) {
diff --git a/src/main/java/org/apache/commons/text/FormatFactory.java b/src/main/java/org/apache/commons/text/FormatFactory.java
index ceee01b..d2908d3 100644
--- a/src/main/java/org/apache/commons/text/FormatFactory.java
+++ b/src/main/java/org/apache/commons/text/FormatFactory.java
@@ -31,8 +31,8 @@
*
* @param name The format type name
* @param arguments Arguments used to create the format instance. This allows the
- * <code>FormatFactory</code> to implement the "format style"
- * concept from <code>java.text.MessageFormat</code>.
+ * {@code FormatFactory} to implement the "format style"
+ * concept from {@code java.text.MessageFormat}.
* @param locale The locale, may be null
* @return The format instance
*/
diff --git a/src/main/java/org/apache/commons/text/StrBuilder.java b/src/main/java/org/apache/commons/text/StrBuilder.java
index 44cd765..c643a9a 100644
--- a/src/main/java/org/apache/commons/text/StrBuilder.java
+++ b/src/main/java/org/apache/commons/text/StrBuilder.java
@@ -268,7 +268,7 @@
* This method is the same as checking {@link #length()} and is provided to match the
* API of Collections.
*
- * @return <code>true</code> if the size is <code>0</code>.
+ * @return {@code true} if the size is {@code 0}.
*/
public boolean isEmpty() {
return size == 0;
@@ -278,7 +278,7 @@
* Clears the string builder (convenience Collections API style method).
* <p>
* This method does not reduce the size of the internal character buffer.
- * To do that, call <code>clear()</code> followed by {@link #minimizeCapacity()}.
+ * To do that, call {@code clear()} followed by {@link #minimizeCapacity()}.
* <p>
* This method is the same as {@link #setLength(int)} called with zero
* and is provided to match the API of Collections.
@@ -480,7 +480,7 @@
}
/**
- * Appends the text representing <code>null</code> to this string builder.
+ * Appends the text representing {@code null} to this string builder.
*
* @return this, to enable chaining
*/
@@ -903,7 +903,7 @@
}
/**
- * Appends an int value to the string builder using <code>String.valueOf</code>.
+ * Appends an int value to the string builder using {@code String.valueOf}.
*
* @param value the value to append
* @return this, to enable chaining
@@ -913,7 +913,7 @@
}
/**
- * Appends a long value to the string builder using <code>String.valueOf</code>.
+ * Appends a long value to the string builder using {@code String.valueOf}.
*
* @param value the value to append
* @return this, to enable chaining
@@ -923,7 +923,7 @@
}
/**
- * Appends a float value to the string builder using <code>String.valueOf</code>.
+ * Appends a float value to the string builder using {@code String.valueOf}.
*
* @param value the value to append
* @return this, to enable chaining
@@ -933,7 +933,7 @@
}
/**
- * Appends a double value to the string builder using <code>String.valueOf</code>.
+ * Appends a double value to the string builder using {@code String.valueOf}.
*
* @param value the value to append
* @return this, to enable chaining
@@ -1107,7 +1107,7 @@
}
/**
- * Appends an int value followed by a new line to the string builder using <code>String.valueOf</code>.
+ * Appends an int value followed by a new line to the string builder using {@code String.valueOf}.
*
* @param value the value to append
* @return this, to enable chaining
@@ -1117,7 +1117,7 @@
}
/**
- * Appends a long value followed by a new line to the string builder using <code>String.valueOf</code>.
+ * Appends a long value followed by a new line to the string builder using {@code String.valueOf}.
*
* @param value the value to append
* @return this, to enable chaining
@@ -1127,7 +1127,7 @@
}
/**
- * Appends a float value followed by a new line to the string builder using <code>String.valueOf</code>.
+ * Appends a float value followed by a new line to the string builder using {@code String.valueOf}.
*
* @param value the value to append
* @return this, to enable chaining
@@ -1137,7 +1137,7 @@
}
/**
- * Appends a double value followed by a new line to the string builder using <code>String.valueOf</code>.
+ * Appends a double value followed by a new line to the string builder using {@code String.valueOf}.
*
* @param value the value to append
* @return this, to enable chaining
@@ -1452,7 +1452,7 @@
//-----------------------------------------------------------------------
/**
* Appends an object to the builder padding on the left to a fixed width.
- * The <code>toString</code> of the object is used.
+ * The {@code toString} of the object is used.
* If the object is larger than the length, the left hand side is lost.
* If the object is null, the null text value is used.
*
@@ -1485,7 +1485,7 @@
/**
* Appends an object to the builder padding on the left to a fixed width.
- * The <code>String.valueOf</code> of the <code>int</code> value is used.
+ * The {@code String.valueOf} of the {@code int} value is used.
* If the formatted value is larger than the length, the left hand side is lost.
*
* @param value the value to append
@@ -1499,7 +1499,7 @@
/**
* Appends an object to the builder padding on the right to a fixed length.
- * The <code>toString</code> of the object is used.
+ * The {@code toString} of the object is used.
* If the object is larger than the length, the right hand side is lost.
* If the object is null, null text value is used.
*
@@ -1532,7 +1532,7 @@
/**
* Appends an object to the builder padding on the right to a fixed length.
- * The <code>String.valueOf</code> of the <code>int</code> value is used.
+ * The {@code String.valueOf} of the {@code int} value is used.
* If the object is larger than the length, the right hand side is lost.
*
* @param value the value to append
@@ -2250,7 +2250,7 @@
* Extracts the leftmost characters from the string builder without
* throwing an exception.
* <p>
- * This method extracts the left <code>length</code> characters from
+ * This method extracts the left {@code length} characters from
* the builder. If this many characters are not available, the whole
* builder is returned. Thus the returned string may be shorter than the
* length requested.
@@ -2272,7 +2272,7 @@
* Extracts the rightmost characters from the string builder without
* throwing an exception.
* <p>
- * This method extracts the right <code>length</code> characters from
+ * This method extracts the right {@code length} characters from
* the builder. If this many characters are not available, the whole
* builder is returned. Thus the returned string may be shorter than the
* length requested.
@@ -2294,7 +2294,7 @@
* Extracts some characters from the middle of the string builder without
* throwing an exception.
* <p>
- * This method extracts <code>length</code> characters from the builder
+ * This method extracts {@code length} characters from the builder
* at the specified index.
* If the index is negative it is treated as zero.
* If the index is greater than the builder size, it is treated as the builder size.
@@ -2650,8 +2650,8 @@
* This method allows the contents of the builder to be read
* using any standard method that expects a Reader.
* <p>
- * To use, simply create a <code>StrBuilder</code>, populate it with
- * data, call <code>asReader</code>, and then read away.
+ * To use, simply create a {@code StrBuilder}, populate it with
+ * data, call {@code asReader}, and then read away.
* <p>
* The internal character array is shared between the builder and the reader.
* This allows you to append to the builder after creating the reader,
@@ -2674,9 +2674,9 @@
* This method allows you to populate the contents of the builder
* using any standard method that takes a Writer.
* <p>
- * To use, simply create a <code>StrBuilder</code>,
- * call <code>asWriter</code>, and populate away. The data is available
- * at any time using the methods of the <code>StrBuilder</code>.
+ * To use, simply create a {@code StrBuilder},
+ * call {@code asWriter}, and populate away. The data is available
+ * at any time using the methods of the {@code StrBuilder}.
* <p>
* The internal character array is shared between the builder and the writer.
* This allows you to intermix calls that append to the builder and
@@ -2693,7 +2693,7 @@
}
/**
- * Appends current contents of this <code>StrBuilder</code> to the
+ * Appends current contents of this {@code StrBuilder} to the
* provided {@link Appendable}.
* <p>
* This method tries to avoid doing any extra copies of contents.
diff --git a/src/main/java/org/apache/commons/text/StrMatcher.java b/src/main/java/org/apache/commons/text/StrMatcher.java
index 1629a4f..23cfccd 100644
--- a/src/main/java/org/apache/commons/text/StrMatcher.java
+++ b/src/main/java/org/apache/commons/text/StrMatcher.java
@@ -230,16 +230,16 @@
* Returns the number of matching characters, or zero if there is no match.
* <p>
* This method is called to check for a match.
- * The parameter <code>pos</code> represents the current position to be
- * checked in the string <code>buffer</code> (a character array which must
+ * The parameter {@code pos} represents the current position to be
+ * checked in the string {@code buffer} (a character array which must
* not be changed).
- * The API guarantees that <code>pos</code> is a valid index for <code>buffer</code>.
+ * The API guarantees that {@code pos} is a valid index for {@code buffer}.
* <p>
* The character array may be larger than the active area to be matched.
* Only values in the buffer between the specified indices may be accessed.
* <p>
* The matching code may check one character or many.
- * It may check characters preceding <code>pos</code> as well as those
+ * It may check characters preceding {@code pos} as well as those
* after, so long as no checks exceed the bounds specified.
* <p>
* It must return zero for no match, or a positive number if a match was found.
@@ -257,13 +257,13 @@
* Returns the number of matching characters, or zero if there is no match.
* <p>
* This method is called to check for a match.
- * The parameter <code>pos</code> represents the current position to be
- * checked in the string <code>buffer</code> (a character array which must
+ * The parameter {@code pos} represents the current position to be
+ * checked in the string {@code buffer} (a character array which must
* not be changed).
- * The API guarantees that <code>pos</code> is a valid index for <code>buffer</code>.
+ * The API guarantees that {@code pos} is a valid index for {@code buffer}.
* <p>
* The matching code may check one character or many.
- * It may check characters preceding <code>pos</code> as well as those after.
+ * It may check characters preceding {@code pos} as well as those after.
* <p>
* It must return zero for no match, or a positive number if a match was found.
* The number indicates the number of characters that matched.
@@ -398,14 +398,14 @@
static final class NoMatcher extends StrMatcher {
/**
- * Constructs a new instance of <code>NoMatcher</code>.
+ * Constructs a new instance of {@code NoMatcher}.
*/
NoMatcher() {
super();
}
/**
- * Always returns <code>false</code>.
+ * Always returns {@code false}.
*
* @param buffer the text content to match against, do not change
* @param pos the starting position for the match, valid for buffer
@@ -426,7 +426,7 @@
static final class TrimMatcher extends StrMatcher {
/**
- * Constructs a new instance of <code>TrimMatcher</code>.
+ * Constructs a new instance of {@code TrimMatcher}.
*/
TrimMatcher() {
super();
diff --git a/src/main/java/org/apache/commons/text/StrSubstitutor.java b/src/main/java/org/apache/commons/text/StrSubstitutor.java
index e8bf4cd..9d6f4e0 100644
--- a/src/main/java/org/apache/commons/text/StrSubstitutor.java
+++ b/src/main/java/org/apache/commons/text/StrSubstitutor.java
@@ -29,7 +29,7 @@
* Substitutes variables within a string by values.
* <p>
* This class takes a piece of text and substitutes all the variables within it.
- * The default definition of a variable is <code>${variableName}</code>.
+ * The default definition of a variable is {@code ${variableName}}.
* The prefix and suffix can be changed via constructors and set methods.
* <p>
* Variable values are typically resolved from a map, but could also be resolved
@@ -44,7 +44,7 @@
* Typical usage of this class follows the following pattern: First an instance is created
* and initialized with the map that contains the values for the available variables.
* If a prefix and/or suffix for variables should be used other than the default ones,
- * the appropriate settings can be performed. After that the <code>replace()</code>
+ * the appropriate settings can be performed. After that the {@code replace()}
* method can be called passing in the source text for interpolation. In the returned
* text all variable references (as long as their values are known) will be resolved.
* The following example demonstrates this:
@@ -96,7 +96,7 @@
* The variable ${${name}} must be used.
* </pre>
* Here only the variable's name referred to in the text should be replaced resulting
- * in the text (assuming that the value of the <code>name</code> variable is <code>x</code>):
+ * in the text (assuming that the value of the {@code name} variable is {@code x}):
* <pre>
* The variable ${x} must be used.
* </pre>
@@ -114,7 +114,7 @@
* <pre>
* ${jre-${java.specification.version}}
* </pre>
- * <code>StrSubstitutor</code> supports this recursive substitution in variable
+ * {@code StrSubstitutor} supports this recursive substitution in variable
* names, but it has to be enabled explicitly by setting the
* {@link #setEnableSubstitutionInVariables(boolean) enableSubstitutionInVariables}
* property to <b>true</b>.
@@ -601,7 +601,7 @@
/**
* Replaces all the occurrences of variables in the given source object with
* their matching values from the resolver. The input source object is
- * converted to a string using <code>toString</code> and is not altered.
+ * converted to a string using {@code toString} and is not altered.
*
* @param source the source to replace in, null returns null
* @return The result of the replace operation
@@ -1122,7 +1122,7 @@
* variable name and the variable default value. This delimiter is expressed in terms of a matcher
* allowing advanced variable default value delimiter matches.
* <p>
- * If the <code>valueDelimiterMatcher</code> is null, then the variable default value resolution
+ * If the {@code valueDelimiterMatcher} is null, then the variable default value resolution
* becomes disabled.
*
* @param valueDelimiterMatcher variable default value delimiter matcher to use, may be null
@@ -1154,7 +1154,7 @@
* variable name and the variable default value. This method allows a string
* variable default value delimiter to be easily set.
* <p>
- * If the <code>valueDelimiter</code> is null or empty string, then the variable default
+ * If the {@code valueDelimiter} is null or empty string, then the variable default
* value resolution becomes disabled.
*
* @param valueDelimiter the variable default value delimiter string to use, may be null or empty
@@ -1203,7 +1203,7 @@
* Sets a flag whether substitution is done in variable names. If set to
* <b>true</b>, the names of variables can contain other variables which are
* processed first before the original variable is evaluated, e.g.
- * <code>${jre-${java.version}}</code>. The default value is <b>false</b>.
+ * {@code ${jre-${java.version}}}. The default value is <b>false</b>.
*
* @param enableSubstitutionInVariables the new value of the flag
*/
@@ -1261,11 +1261,11 @@
/**
* Sets a flag controlling whether escapes are preserved during
* substitution. If set to <b>true</b>, the escape character is retained
- * during substitution (e.g. <code>$${this-is-escaped}</code> remains
- * <code>$${this-is-escaped}</code>). If set to <b>false</b>, the escape
+ * during substitution (e.g. {@code $${this-is-escaped}} remains
+ * {@code $${this-is-escaped}}). If set to <b>false</b>, the escape
* character is removed during substitution (e.g.
- * <code>$${this-is-escaped}</code> becomes
- * <code>${this-is-escaped}</code>). The default value is <b>false</b>
+ * {@code $${this-is-escaped}} becomes
+ * {@code ${this-is-escaped}}). The default value is <b>false</b>
*
* @param preserveEscapes true if escapes are to be preserved
*/
diff --git a/src/main/java/org/apache/commons/text/StrTokenizer.java b/src/main/java/org/apache/commons/text/StrTokenizer.java
index ed0255e..e700b52 100644
--- a/src/main/java/org/apache/commons/text/StrTokenizer.java
+++ b/src/main/java/org/apache/commons/text/StrTokenizer.java
@@ -29,8 +29,8 @@
* This class can split a String into many smaller strings. It aims
* to do a similar job to {@link java.util.StringTokenizer StringTokenizer},
* however it offers much more control and flexibility including implementing
- * the <code>ListIterator</code> interface. By default, it is set up
- * like <code>StringTokenizer</code>.
+ * 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>.
@@ -129,9 +129,9 @@
//-----------------------------------------------------------------------
/**
- * Returns a clone of <code>CSV_TOKENIZER_PROTOTYPE</code>.
+ * Returns a clone of {@code CSV_TOKENIZER_PROTOTYPE}.
*
- * @return a clone of <code>CSV_TOKENIZER_PROTOTYPE</code>.
+ * @return a clone of {@code CSV_TOKENIZER_PROTOTYPE}.
*/
private static StrTokenizer getCSVClone() {
return (StrTokenizer) CSV_TOKENIZER_PROTOTYPE.clone();
@@ -181,9 +181,9 @@
}
/**
- * Returns a clone of <code>TSV_TOKENIZER_PROTOTYPE</code>.
+ * Returns a clone of {@code TSV_TOKENIZER_PROTOTYPE}.
*
- * @return a clone of <code>TSV_TOKENIZER_PROTOTYPE</code>.
+ * @return a clone of {@code TSV_TOKENIZER_PROTOTYPE}.
*/
private static StrTokenizer getTSVClone() {
return (StrTokenizer) TSV_TOKENIZER_PROTOTYPE.clone();
@@ -628,7 +628,7 @@
* offset or count to be parsed, or call the tokenizer multiple times on
* multiple strings. It is also be possible to filter the results.
* <p>
- * <code>StrTokenizer</code> will always pass a zero offset and a count
+ * {@code StrTokenizer} will always pass a zero offset and a count
* equal to the length of the array to this method, however a subclass
* may pass other values, or even an entirely different array.
*
@@ -1080,7 +1080,7 @@
/**
* Creates a new instance of this Tokenizer. The new instance is reset so
* that it will be at the start of the token list.
- * If a {@link CloneNotSupportedException} is caught, return <code>null</code>.
+ * If a {@link CloneNotSupportedException} is caught, return {@code null}.
*
* @return a new instance of this Tokenizer which has been reset.
*/
diff --git a/src/main/java/org/apache/commons/text/StringEscapeUtils.java b/src/main/java/org/apache/commons/text/StringEscapeUtils.java
index 1b2bc5f..d22baa2 100644
--- a/src/main/java/org/apache/commons/text/StringEscapeUtils.java
+++ b/src/main/java/org/apache/commons/text/StringEscapeUtils.java
@@ -636,10 +636,10 @@
* <p>
* For example:
* </p>
- * <p><code>"bread" & "butter"</code></p>
+ * <p>{@code "bread" & "butter"}</p>
* becomes:
* <p>
- * <code>&quot;bread&quot; &amp; &quot;butter&quot;</code>.
+ * {@code &quot;bread&quot; &amp; &quot;butter&quot;}.
* </p>
*
* <p>Supports all known HTML 4.0 entities, including funky accents.
diff --git a/src/main/java/org/apache/commons/text/StringSubstitutor.java b/src/main/java/org/apache/commons/text/StringSubstitutor.java
index e1f3ee9..59a5fc9 100644
--- a/src/main/java/org/apache/commons/text/StringSubstitutor.java
+++ b/src/main/java/org/apache/commons/text/StringSubstitutor.java
@@ -33,7 +33,7 @@
* Substitutes variables within a string by values.
* <p>
* This class takes a piece of text and substitutes all the variables within it. The default definition of a variable is
- * <code>${variableName}</code>. The prefix and suffix can be changed via constructors and set methods.
+ * {@code ${variableName}}. The prefix and suffix can be changed via constructors and set methods.
* </p>
* <p>
* Variable values are typically resolved from a map, but could also be resolved from system properties, or by supplying
@@ -732,7 +732,7 @@
// -----------------------------------------------------------------------
/**
* Replaces all the occurrences of variables in the given source object with their matching values from the
- * resolver. The input source object is converted to a string using <code>toString</code> and is not altered.
+ * resolver. The input source object is converted to a string using {@code toString} and is not altered.
*
* @param source the source to replace in, null returns null
* @return The result of the replace operation
@@ -1026,7 +1026,7 @@
/**
* Sets a flag whether substitution is done in variable names. If set to <b>true</b>, the names of variables can
* contain other variables which are processed first before the original variable is evaluated, e.g.
- * <code>${jre-${java.version}}</code>. The default value is <b>false</b>.
+ * {@code ${jre-${java.version}}}. The default value is <b>false</b>.
*
* @param enableSubstitutionInVariables the new value of the flag
* @return this, to enable chaining
@@ -1061,9 +1061,9 @@
/**
* Sets a flag controlling whether escapes are preserved during substitution. If set to <b>true</b>, the escape
- * character is retained during substitution (e.g. <code>$${this-is-escaped}</code> remains
- * <code>$${this-is-escaped}</code>). If set to <b>false</b>, the escape character is removed during substitution
- * (e.g. <code>$${this-is-escaped}</code> becomes <code>${this-is-escaped}</code>). The default value is
+ * character is retained during substitution (e.g. {@code $${this-is-escaped}} remains
+ * {@code $${this-is-escaped}}). If set to <b>false</b>, the escape character is removed during substitution
+ * (e.g. {@code $${this-is-escaped}} becomes {@code ${this-is-escaped}}). The default value is
* <b>false</b>
*
* @param preserveEscapes true if escapes are to be preserved
@@ -1093,7 +1093,7 @@
* The variable default value delimiter is the character or characters that delimite the variable name and the
* variable default value. This method allows a string variable default value delimiter to be easily set.
* <p>
- * If the <code>valueDelimiter</code> is null or empty string, then the variable default value resolution becomes
+ * If the {@code valueDelimiter} is null or empty string, then the variable default value resolution becomes
* disabled.
*
* @param valueDelimiter the variable default value delimiter string to use, may be null or empty
@@ -1114,7 +1114,7 @@
* variable default value. This delimiter is expressed in terms of a matcher allowing advanced variable default
* value delimiter matches.
* <p>
- * If the <code>valueDelimiterMatcher</code> is null, then the variable default value resolution becomes disabled.
+ * If the {@code valueDelimiterMatcher} is null, then the variable default value resolution becomes disabled.
*
* @param valueDelimiterMatcher variable default value delimiter matcher to use, may be null
* @return this, to enable chaining
diff --git a/src/main/java/org/apache/commons/text/StringTokenizer.java b/src/main/java/org/apache/commons/text/StringTokenizer.java
index 5e9c1d6..ec25e9f 100644
--- a/src/main/java/org/apache/commons/text/StringTokenizer.java
+++ b/src/main/java/org/apache/commons/text/StringTokenizer.java
@@ -30,7 +30,7 @@
* <p>
* This class can split a String into many smaller strings. It aims to do a similar job to
* {@link java.util.StringTokenizer StringTokenizer}, however it offers much more control and flexibility including
- * implementing the <code>ListIterator</code> interface. By default, it is set up like <code>StringTokenizer</code>.
+ * 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.
@@ -136,9 +136,9 @@
// -----------------------------------------------------------------------
/**
- * Returns a clone of <code>CSV_TOKENIZER_PROTOTYPE</code>.
+ * Returns a clone of {@code CSV_TOKENIZER_PROTOTYPE}.
*
- * @return a clone of <code>CSV_TOKENIZER_PROTOTYPE</code>.
+ * @return a clone of {@code CSV_TOKENIZER_PROTOTYPE}.
*/
private static StringTokenizer getCSVClone() {
return (StringTokenizer) CSV_TOKENIZER_PROTOTYPE.clone();
@@ -188,9 +188,9 @@
}
/**
- * Returns a clone of <code>TSV_TOKENIZER_PROTOTYPE</code>.
+ * Returns a clone of {@code TSV_TOKENIZER_PROTOTYPE}.
*
- * @return a clone of <code>TSV_TOKENIZER_PROTOTYPE</code>.
+ * @return a clone of {@code TSV_TOKENIZER_PROTOTYPE}.
*/
private static StringTokenizer getTSVClone() {
return (StringTokenizer) TSV_TOKENIZER_PROTOTYPE.clone();
@@ -666,7 +666,7 @@
* could alter the character array, offset or count to be parsed, or call the tokenizer multiple times on multiple
* strings. It is also be possible to filter the results.
* <p>
- * <code>StrTokenizer</code> will always pass a zero offset and a count equal to the length of the array to this
+ * {@code StrTokenizer} will always pass a zero offset and a count equal to the length of the array to this
* method, however a subclass may pass other values, or even an entirely different array.
*
* @param srcChars
@@ -1126,7 +1126,7 @@
// -----------------------------------------------------------------------
/**
* Creates a new instance of this Tokenizer. The new instance is reset so that it will be at the start of the token
- * list. If a {@link CloneNotSupportedException} is caught, return <code>null</code>.
+ * list. If a {@link CloneNotSupportedException} is caught, return {@code null}.
*
* @return a new instance of this Tokenizer which has been reset.
*/
diff --git a/src/main/java/org/apache/commons/text/TextStringBuilder.java b/src/main/java/org/apache/commons/text/TextStringBuilder.java
index 5aa461a..89e6501 100644
--- a/src/main/java/org/apache/commons/text/TextStringBuilder.java
+++ b/src/main/java/org/apache/commons/text/TextStringBuilder.java
@@ -283,7 +283,7 @@
* <p>
* This method is the same as checking {@link #length()} and is provided to match the API of Collections.
*
- * @return <code>true</code> if the size is <code>0</code>.
+ * @return {@code true} if the size is {@code 0}.
*/
public boolean isEmpty() {
return size == 0;
@@ -292,7 +292,7 @@
/**
* Clears the string builder (convenience Collections API style method).
* <p>
- * This method does not reduce the size of the internal character buffer. To do that, call <code>clear()</code>
+ * This method does not reduce the size of the internal character buffer. To do that, call {@code clear()}
* followed by {@link #minimizeCapacity()}.
* <p>
* This method is the same as {@link #setLength(int)} called with zero and is provided to match the API of
@@ -509,7 +509,7 @@
}
/**
- * Appends the text representing <code>null</code> to this string builder.
+ * Appends the text representing {@code null} to this string builder.
*
* @return this, to enable chaining
*/
@@ -955,7 +955,7 @@
}
/**
- * Appends an int value to the string builder using <code>String.valueOf</code>.
+ * Appends an int value to the string builder using {@code String.valueOf}.
*
* @param value
* the value to append
@@ -966,7 +966,7 @@
}
/**
- * Appends a long value to the string builder using <code>String.valueOf</code>.
+ * Appends a long value to the string builder using {@code String.valueOf}.
*
* @param value
* the value to append
@@ -977,7 +977,7 @@
}
/**
- * Appends a float value to the string builder using <code>String.valueOf</code>.
+ * Appends a float value to the string builder using {@code String.valueOf}.
*
* @param value
* the value to append
@@ -988,7 +988,7 @@
}
/**
- * Appends a double value to the string builder using <code>String.valueOf</code>.
+ * Appends a double value to the string builder using {@code String.valueOf}.
*
* @param value
* the value to append
@@ -1186,7 +1186,7 @@
}
/**
- * Appends an int value followed by a new line to the string builder using <code>String.valueOf</code>.
+ * Appends an int value followed by a new line to the string builder using {@code String.valueOf}.
*
* @param value
* the value to append
@@ -1197,7 +1197,7 @@
}
/**
- * Appends a long value followed by a new line to the string builder using <code>String.valueOf</code>.
+ * Appends a long value followed by a new line to the string builder using {@code String.valueOf}.
*
* @param value
* the value to append
@@ -1208,7 +1208,7 @@
}
/**
- * Appends a float value followed by a new line to the string builder using <code>String.valueOf</code>.
+ * Appends a float value followed by a new line to the string builder using {@code String.valueOf}.
*
* @param value
* the value to append
@@ -1219,7 +1219,7 @@
}
/**
- * Appends a double value followed by a new line to the string builder using <code>String.valueOf</code>.
+ * Appends a double value followed by a new line to the string builder using {@code String.valueOf}.
*
* @param value
* the value to append
@@ -1543,7 +1543,7 @@
// -----------------------------------------------------------------------
/**
- * Appends an object to the builder padding on the left to a fixed width. The <code>toString</code> of the object is
+ * Appends an object to the builder padding on the left to a fixed width. The {@code toString} of the object is
* used. If the object is larger than the length, the left hand side is lost. If the object is null, the null text
* value is used.
*
@@ -1578,8 +1578,8 @@
}
/**
- * Appends an object to the builder padding on the left to a fixed width. The <code>String.valueOf</code> of the
- * <code>int</code> value is used. If the formatted value is larger than the length, the left hand side is lost.
+ * Appends an object to the builder padding on the left to a fixed width. The {@code String.valueOf} of the
+ * {@code int} value is used. If the formatted value is larger than the length, the left hand side is lost.
*
* @param value
* the value to append
@@ -1594,7 +1594,7 @@
}
/**
- * Appends an object to the builder padding on the right to a fixed length. The <code>toString</code> of the object
+ * Appends an object to the builder padding on the right to a fixed length. The {@code toString} of the object
* is used. If the object is larger than the length, the right hand side is lost. If the object is null, null text
* value is used.
*
@@ -1629,8 +1629,8 @@
}
/**
- * Appends an object to the builder padding on the right to a fixed length. The <code>String.valueOf</code> of the
- * <code>int</code> value is used. If the object is larger than the length, the right hand side is lost.
+ * Appends an object to the builder padding on the right to a fixed length. The {@code String.valueOf} of the
+ * {@code int} value is used. If the object is larger than the length, the right hand side is lost.
*
* @param value
* the value to append
@@ -2413,7 +2413,7 @@
/**
* Extracts the leftmost characters from the string builder without throwing an exception.
* <p>
- * This method extracts the left <code>length</code> characters from the builder. If this many characters are not
+ * This method extracts the left {@code length} characters from the builder. If this many characters are not
* available, the whole builder is returned. Thus the returned string may be shorter than the length requested.
*
* @param length
@@ -2433,7 +2433,7 @@
/**
* Extracts the rightmost characters from the string builder without throwing an exception.
* <p>
- * This method extracts the right <code>length</code> characters from the builder. If this many characters are not
+ * This method extracts the right {@code length} characters from the builder. If this many characters are not
* available, the whole builder is returned. Thus the returned string may be shorter than the length requested.
*
* @param length
@@ -2453,7 +2453,7 @@
/**
* Extracts some characters from the middle of the string builder without throwing an exception.
* <p>
- * This method extracts <code>length</code> characters from the builder at the specified index. If the index is
+ * This method extracts {@code length} characters from the builder at the specified index. If the index is
* negative it is treated as zero. If the index is greater than the builder size, it is treated as the builder size.
* If the length is negative, the empty string is returned. If insufficient characters are available in the builder,
* as much as possible is returned. Thus the returned string may be shorter than the length requested.
@@ -2816,7 +2816,7 @@
* <p>
* This method allows the contents of the builder to be read using any standard method that expects a Reader.
* <p>
- * To use, simply create a <code>StrBuilder</code>, populate it with data, call <code>asReader</code>, and then read
+ * To use, simply create a {@code StrBuilder}, populate it with data, call {@code asReader}, and then read
* away.
* <p>
* The internal character array is shared between the builder and the reader. This allows you to append to the
@@ -2837,8 +2837,8 @@
* <p>
* This method allows you to populate the contents of the builder using any standard method that takes a Writer.
* <p>
- * To use, simply create a <code>StrBuilder</code>, call <code>asWriter</code>, and populate away. The data is
- * available at any time using the methods of the <code>StrBuilder</code>.
+ * To use, simply create a {@code StrBuilder}, call {@code asWriter}, and populate away. The data is
+ * available at any time using the methods of the {@code StrBuilder}.
* <p>
* The internal character array is shared between the builder and the writer. This allows you to intermix calls that
* append to the builder and write using the writer and the changes will be occur correctly. Note however, that no
@@ -2853,7 +2853,7 @@
}
/**
- * Appends current contents of this <code>StrBuilder</code> to the provided {@link Appendable}.
+ * Appends current contents of this {@code StrBuilder} to the provided {@link Appendable}.
* <p>
* This method tries to avoid doing any extra copies of contents.
*
diff --git a/src/main/java/org/apache/commons/text/WordUtils.java b/src/main/java/org/apache/commons/text/WordUtils.java
index 682adc9..2b9e7d5 100644
--- a/src/main/java/org/apache/commons/text/WordUtils.java
+++ b/src/main/java/org/apache/commons/text/WordUtils.java
@@ -31,8 +31,8 @@
* </p>
*
* <p>
- * This class tries to handle <code>null</code> input gracefully. An exception will not be thrown for a
- * <code>null</code> input. Each method documents its behavior in more detail.
+ * This class tries to handle {@code null} input gracefully. An exception will not be thrown for a
+ * {@code null} input. Each method documents its behavior in more detail.
* </p>
*
* @since 1.1
@@ -40,9 +40,9 @@
public class WordUtils {
/**
- * <p><code>WordUtils</code> instances should NOT be constructed in
+ * <p>{@code WordUtils} instances should NOT be constructed in
* standard programming. Instead, the class should be used as
- * <code>WordUtils.wrap("foo bar", 20);</code>.</p>
+ * {@code WordUtils.wrap("foo bar", 20);}.</p>
*
* <p>This constructor is public to permit tools that require a JavaBean
* instance to operate.</p>
@@ -54,7 +54,7 @@
// Wrapping
//--------------------------------------------------------------------------
/**
- * <p>Wraps a single line of text, identifying words by <code>' '</code>.</p>
+ * <p>Wraps a single line of text, identifying words by {@code ' '}.</p>
*
* <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>
@@ -100,14 +100,14 @@
*
* @param str the String to be word wrapped, may be null
* @param wrapLength the column to wrap the words at, less than 1 is treated as 1
- * @return a line with newlines inserted, <code>null</code> if null input
+ * @return a line with newlines inserted, {@code null} if null input
*/
public static String wrap(final String str, final int wrapLength) {
return wrap(str, wrapLength, null, false);
}
/**
- * <p>Wraps a single line of text, identifying words by <code>' '</code>.</p>
+ * <p>Wraps a single line of text, identifying words by {@code ' '}.</p>
*
* <p>Leading spaces on a new line are stripped.
* Trailing spaces are not stripped.</p>
@@ -177,9 +177,9 @@
* @param str the String to be word wrapped, may be null
* @param wrapLength the column to wrap the words at, less than 1 is treated as 1
* @param newLineStr the string to insert for a new line,
- * <code>null</code> uses the system property line separator
+ * {@code null} uses the system property line separator
* @param wrapLongWords true if long words (such as URLs) should be wrapped
- * @return a line with newlines inserted, <code>null</code> if null input
+ * @return a line with newlines inserted, {@code null} if null input
*/
public static String wrap(final String str,
final int wrapLength,
@@ -189,7 +189,7 @@
}
/**
- * <p>Wraps a single line of text, identifying words by <code>wrapOn</code>.</p>
+ * <p>Wraps a single line of text, identifying words by {@code wrapOn}.</p>
*
* <p>Leading spaces on a new line are stripped.
* Trailing spaces are not stripped.</p>
@@ -274,11 +274,11 @@
* @param str the String to be word wrapped, may be null
* @param wrapLength the column to wrap the words at, less than 1 is treated as 1
* @param newLineStr the string to insert for a new line,
- * <code>null</code> uses the system property line separator
+ * {@code null} uses the system property line separator
* @param wrapLongWords true if long words (such as URLs) should be wrapped
* @param wrapOn regex expression to be used as a breakable characters,
* if blank string is provided a space character will be used
- * @return a line with newlines inserted, <code>null</code> if null input
+ * @return a line with newlines inserted, {@code null} if null input
*/
public static String wrap(final String str,
int wrapLength,
@@ -391,7 +391,7 @@
* use {@link #capitalizeFully(String)}.</p>
*
* <p>Whitespace is defined by {@link Character#isWhitespace(char)}.
- * A <code>null</code> input String returns <code>null</code>.
+ * A {@code null} input String returns {@code null}.
* Capitalization uses the Unicode title case, normally equivalent to
* upper case.</p>
*
@@ -402,7 +402,7 @@
* </pre>
*
* @param str the String to capitalize, may be null
- * @return capitalized String, <code>null</code> if null String input
+ * @return capitalized String, {@code null} if null String input
* @see #uncapitalize(String)
* @see #capitalizeFully(String)
*/
@@ -420,7 +420,7 @@
* The first string character and the first non-delimiter character after a
* delimiter will be capitalized. </p>
*
- * <p>A <code>null</code> input String returns <code>null</code>.
+ * <p>A {@code null} input String returns {@code null}.
* Capitalization uses the Unicode title case, normally equivalent to
* upper case.</p>
*
@@ -435,7 +435,7 @@
*
* @param str the String to capitalize, may be null
* @param delimiters set of characters to determine capitalization, null means whitespace
- * @return capitalized String, <code>null</code> if null String input
+ * @return capitalized String, {@code null} if null String input
* @see #uncapitalize(String)
* @see #capitalizeFully(String)
*/
@@ -476,7 +476,7 @@
* lowercase characters. </p>
*
* <p>Whitespace is defined by {@link Character#isWhitespace(char)}.
- * A <code>null</code> input String returns <code>null</code>.
+ * A {@code null} input String returns {@code null}.
* Capitalization uses the Unicode title case, normally equivalent to
* upper case.</p>
*
@@ -487,7 +487,7 @@
* </pre>
*
* @param str the String to capitalize, may be null
- * @return capitalized String, <code>null</code> if null String input
+ * @return capitalized String, {@code null} if null String input
*/
public static String capitalizeFully(final String str) {
return capitalizeFully(str, null);
@@ -502,7 +502,7 @@
* The first string character and the first non-delimiter character after a
* delimiter will be capitalized. </p>
*
- * <p>A <code>null</code> input String returns <code>null</code>.
+ * <p>A {@code null} input String returns {@code null}.
* Capitalization uses the Unicode title case, normally equivalent to
* upper case.</p>
*
@@ -516,7 +516,7 @@
*
* @param str the String to capitalize, may be null
* @param delimiters set of characters to determine capitalization, null means whitespace
- * @return capitalized String, <code>null</code> if null String input
+ * @return capitalized String, {@code null} if null String input
*/
public static String capitalizeFully(String str, final char... delimiters) {
if (StringUtils.isEmpty(str)) {
@@ -532,7 +532,7 @@
* Only the first character of each word is changed.</p>
*
* <p>Whitespace is defined by {@link Character#isWhitespace(char)}.
- * A <code>null</code> input String returns <code>null</code>.</p>
+ * A {@code null} input String returns {@code null}.</p>
*
* <pre>
* WordUtils.uncapitalize(null) = null
@@ -541,7 +541,7 @@
* </pre>
*
* @param str the String to uncapitalize, may be null
- * @return uncapitalized String, <code>null</code> if null String input
+ * @return uncapitalized String, {@code null} if null String input
* @see #capitalize(String)
*/
public static String uncapitalize(final String str) {
@@ -557,7 +557,7 @@
* delimiter will be uncapitalized. </p>
*
* <p>Whitespace is defined by {@link Character#isWhitespace(char)}.
- * A <code>null</code> input String returns <code>null</code>.</p>
+ * A {@code null} input String returns {@code null}.</p>
*
* <pre>
* WordUtils.uncapitalize(null, *) = null
@@ -570,7 +570,7 @@
*
* @param str the String to uncapitalize, may be null
* @param delimiters set of characters to determine uncapitalization, null means whitespace
- * @return uncapitalized String, <code>null</code> if null String input
+ * @return uncapitalized String, {@code null} if null String input
* @see #capitalize(String)
*/
public static String uncapitalize(final String str, final char... delimiters) {
@@ -615,7 +615,7 @@
* </ul>
*
* <p>Whitespace is defined by {@link Character#isWhitespace(char)}.
- * A <code>null</code> input String returns <code>null</code>.</p>
+ * A {@code null} input String returns {@code null}.</p>
*
* <pre>
* StringUtils.swapCase(null) = null
@@ -624,7 +624,7 @@
* </pre>
*
* @param str the String to swap case, may be null
- * @return The changed String, <code>null</code> if null String input
+ * @return The changed String, {@code null} if null String input
*/
public static String swapCase(final String str) {
if (StringUtils.isEmpty(str)) {
@@ -665,7 +665,7 @@
* Their case is not changed.</p>
*
* <p>Whitespace is defined by {@link Character#isWhitespace(char)}.
- * A <code>null</code> input String returns <code>null</code>.</p>
+ * A {@code null} input String returns {@code null}.</p>
*
* <pre>
* WordUtils.initials(null) = null
@@ -675,7 +675,7 @@
* </pre>
*
* @param str the String to get initials from, may be null
- * @return String of initial letters, <code>null</code> if null String input
+ * @return String of initial letters, {@code null} if null String input
* @see #initials(String,char[])
*/
public static String initials(final String str) {
@@ -690,7 +690,7 @@
*
* <p>If the delimiters array is null, then Whitespace is used.
* Whitespace is defined by {@link Character#isWhitespace(char)}.
- * A <code>null</code> input String returns <code>null</code>.
+ * A {@code null} input String returns {@code null}.
* An empty delimiter array returns an empty String.</p>
*
* <pre>
@@ -704,7 +704,7 @@
*
* @param str the String to get initials from, may be null
* @param delimiters set of characters to determine words, null means whitespace
- * @return String of initial characters, <code>null</code> if null String input
+ * @return String of initial characters, {@code null} if null String input
* @see #initials(String)
*/
public static String initials(final String str, final char... delimiters) {
diff --git a/src/main/java/org/apache/commons/text/diff/DeleteCommand.java b/src/main/java/org/apache/commons/text/diff/DeleteCommand.java
index 8173718..69ed484 100644
--- a/src/main/java/org/apache/commons/text/diff/DeleteCommand.java
+++ b/src/main/java/org/apache/commons/text/diff/DeleteCommand.java
@@ -44,7 +44,7 @@
}
/**
- * Accept a visitor. When a <code>DeleteCommand</code> accepts a visitor, it calls
+ * Accept a visitor. When a {@code DeleteCommand} accepts a visitor, it calls
* its {@link CommandVisitor#visitDeleteCommand visitDeleteCommand} method.
*
* @param visitor the visitor to be accepted
diff --git a/src/main/java/org/apache/commons/text/diff/EditCommand.java b/src/main/java/org/apache/commons/text/diff/EditCommand.java
index 1abd71f..d262154 100644
--- a/src/main/java/org/apache/commons/text/diff/EditCommand.java
+++ b/src/main/java/org/apache/commons/text/diff/EditCommand.java
@@ -33,12 +33,12 @@
* inserted into the first sequence, {@link DeleteCommand DeleteCommand} which
* correspond to an object of the first sequence being removed and
* {@link KeepCommand KeepCommand} which correspond to an object of the first
- * sequence which <code>equals</code> an object in the second sequence. It is
+ * sequence which {@code equals} an object in the second sequence. It is
* guaranteed that comparison is always performed this way (i.e. the
- * <code>equals</code> method of the object from the first sequence is used and
+ * {@code equals} method of the object from the first sequence is used and
* the object passed as an argument comes from the second sequence) ; this can
* be important if subclassing is used for some elements in the first sequence
- * and the <code>equals</code> method is specialized.
+ * and the {@code equals} method is specialized.
* </p>
*
* <p>
diff --git a/src/main/java/org/apache/commons/text/diff/EditScript.java b/src/main/java/org/apache/commons/text/diff/EditScript.java
index bf4b185..e179818 100644
--- a/src/main/java/org/apache/commons/text/diff/EditScript.java
+++ b/src/main/java/org/apache/commons/text/diff/EditScript.java
@@ -32,7 +32,7 @@
* commands} come from the second sequence and that the objects embedded in
* either the {@link DeleteCommand delete commands} or {@link KeepCommand keep
* commands} come from the first sequence. This can be important if subclassing
- * is used for some elements in the first sequence and the <code>equals</code>
+ * is used for some elements in the first sequence and the {@code equals}
* method is specialized.
*
* @see StringsComparator
diff --git a/src/main/java/org/apache/commons/text/diff/InsertCommand.java b/src/main/java/org/apache/commons/text/diff/InsertCommand.java
index f0337dc..f8eb0e0 100644
--- a/src/main/java/org/apache/commons/text/diff/InsertCommand.java
+++ b/src/main/java/org/apache/commons/text/diff/InsertCommand.java
@@ -44,7 +44,7 @@
}
/**
- * Accept a visitor. When an <code>InsertCommand</code> accepts a visitor,
+ * Accept a visitor. When an {@code InsertCommand} accepts a visitor,
* it calls its {@link CommandVisitor#visitInsertCommand visitInsertCommand}
* method.
*
diff --git a/src/main/java/org/apache/commons/text/diff/KeepCommand.java b/src/main/java/org/apache/commons/text/diff/KeepCommand.java
index 34c6fe7..efd4824 100644
--- a/src/main/java/org/apache/commons/text/diff/KeepCommand.java
+++ b/src/main/java/org/apache/commons/text/diff/KeepCommand.java
@@ -19,7 +19,7 @@
/**
* Command representing the keeping of one object present in both sequences.
* <p>
- * When one object of the first sequence <code>equals</code> another objects in
+ * When one object of the first sequence {@code equals} another objects in
* the second sequence at the right place, the {@link EditScript edit script}
* transforming the first sequence into the second sequence uses an instance of
* this class to represent the keeping of this object. The objects embedded in
@@ -46,7 +46,7 @@
}
/**
- * Accept a visitor. When a <code>KeepCommand</code> accepts a visitor, it
+ * Accept a visitor. When a {@code KeepCommand} accepts a visitor, it
* calls its {@link CommandVisitor#visitKeepCommand visitKeepCommand} method.
*
* @param visitor the visitor to be accepted
diff --git a/src/main/java/org/apache/commons/text/diff/ReplacementsHandler.java b/src/main/java/org/apache/commons/text/diff/ReplacementsHandler.java
index 3beb716..a00978c 100644
--- a/src/main/java/org/apache/commons/text/diff/ReplacementsHandler.java
+++ b/src/main/java/org/apache/commons/text/diff/ReplacementsHandler.java
@@ -37,8 +37,8 @@
* equals (if they exist). This property also holds for the objects after
* the two sub-sequences.
* <p>
- * The replacement is defined as replacing the <code>from</code>
- * sub-sequence into the <code>to</code> sub-sequence.
+ * The replacement is defined as replacing the {@code from}
+ * sub-sequence into the {@code to} sub-sequence.
*
* @param skipped number of tokens skipped since the last call (i.e. number of
* tokens that were in both sequences), this number should be strictly positive
diff --git a/src/main/java/org/apache/commons/text/diff/StringsComparator.java b/src/main/java/org/apache/commons/text/diff/StringsComparator.java
index fe96068..b3963e5 100644
--- a/src/main/java/org/apache/commons/text/diff/StringsComparator.java
+++ b/src/main/java/org/apache/commons/text/diff/StringsComparator.java
@@ -19,16 +19,16 @@
/**
* <p>
* It is guaranteed that the comparisons will always be done as
- * <code>o1.equals(o2)</code> where <code>o1</code> belongs to the first
- * sequence and <code>o2</code> belongs to the second sequence. This can
+ * {@code o1.equals(o2)} where {@code o1} belongs to the first
+ * sequence and {@code o2} belongs to the second sequence. This can
* be important if subclassing is used for some elements in the first
- * sequence and the <code>equals</code> method is specialized.
+ * sequence and the {@code equals} method is specialized.
* </p>
* <p>
* Comparison can be seen from two points of view: either as giving the smallest
* modification allowing to transform the first sequence into the second one, or
* as giving the longest sequence which is a subsequence of both initial
- * sequences. The <code>equals</code> method is used to compare objects, so any
+ * sequences. The {@code equals} method is used to compare objects, so any
* object can be put into sequences. Modifications include deleting, inserting
* or keeping one object, starting from the beginning of the first sequence.
* </p>
@@ -76,10 +76,10 @@
* </p>
* <p>
* It is <em>guaranteed</em> that the comparisons will always be done as
- * <code>o1.equals(o2)</code> where <code>o1</code> belongs to the first
- * sequence and <code>o2</code> belongs to the second sequence. This can be
+ * {@code o1.equals(o2)} where {@code o1} belongs to the first
+ * sequence and {@code o2} belongs to the second sequence. This can be
* important if subclassing is used for some elements in the first sequence
- * and the <code>equals</code> method is specialized.
+ * and the {@code equals} method is specialized.
* </p>
*
* @param left first character sequence to be compared
@@ -102,7 +102,7 @@
* embedded in either the {@link DeleteCommand delete commands} or
* {@link KeepCommand keep commands} come from the first sequence. This can
* be important if subclassing is used for some elements in the first
- * sequence and the <code>equals</code> method is specialized.
+ * sequence and the {@code equals} method is specialized.
* </p>
*
* @return The edit script resulting from the comparison of the two
diff --git a/src/main/java/org/apache/commons/text/lookup/AbstractStringLookup.java b/src/main/java/org/apache/commons/text/lookup/AbstractStringLookup.java
index 4dbdb65..8728521 100644
--- a/src/main/java/org/apache/commons/text/lookup/AbstractStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/AbstractStringLookup.java
@@ -41,7 +41,7 @@
protected static final String SPLIT_STR = String.valueOf(SPLIT_CH);
/**
- * Returns the substring after the first occurrence of <code>ch</code> in <code>value</code>.
+ * Returns the substring after the first occurrence of {@code ch} in {@code value}.
*
* @param value
* The source string.
@@ -55,7 +55,7 @@
}
/**
- * Returns the substring after the first occurrence of <code>ch</code> in <code>value</code>.
+ * Returns the substring after the first occurrence of {@code ch} in {@code value}.
*
* @param value
* The source string.
@@ -69,7 +69,7 @@
}
/**
- * Returns the substring after the first occurrence of <code>str</code> in <code>value</code>.
+ * Returns the substring after the first occurrence of {@code str} in {@code value}.
*
* @param value
* The source string.
diff --git a/src/main/java/org/apache/commons/text/lookup/EnvironmentVariableStringLookup.java b/src/main/java/org/apache/commons/text/lookup/EnvironmentVariableStringLookup.java
index 2b7f57c..1ad1a8d 100644
--- a/src/main/java/org/apache/commons/text/lookup/EnvironmentVariableStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/EnvironmentVariableStringLookup.java
@@ -64,7 +64,7 @@
*/
@Override
public String lookup(final String key) {
- // getenv throws NullPointerException if <code>name</code> is <code>null</code>
+ // getenv throws NullPointerException if {@code name} is {@code null}
return key != null ? System.getenv(key) : null;
}
}
diff --git a/src/main/java/org/apache/commons/text/lookup/JavaPlatformStringLookup.java b/src/main/java/org/apache/commons/text/lookup/JavaPlatformStringLookup.java
index 178f124..0d2cb32 100644
--- a/src/main/java/org/apache/commons/text/lookup/JavaPlatformStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/JavaPlatformStringLookup.java
@@ -58,17 +58,17 @@
*/
final class JavaPlatformStringLookup extends AbstractStringLookup {
- /** <code>locale</code> key for driving {@link JavaPlatformStringLookup#lookup(String)}. */
+ /** {@code locale} key for driving {@link JavaPlatformStringLookup#lookup(String)}. */
private static final String KEY_LOCALE = "locale";
- /** <code>hardware</code> key for driving {@link JavaPlatformStringLookup#lookup(String)}. */
+ /** {@code hardware} key for driving {@link JavaPlatformStringLookup#lookup(String)}. */
private static final String KEY_HARDWARE = "hardware";
- /** <code>os</code> key for driving {@link JavaPlatformStringLookup#lookup(String)}. */
+ /** {@code os} key for driving {@link JavaPlatformStringLookup#lookup(String)}. */
private static final String KEY_OS = "os";
- /** <code>vm</code> key for driving {@link JavaPlatformStringLookup#lookup(String)}. */
+ /** {@code vm} key for driving {@link JavaPlatformStringLookup#lookup(String)}. */
private static final String KEY_VM = "vm";
- /** <code>runtime</code> key for driving {@link JavaPlatformStringLookup#lookup(String)}. */
+ /** {@code runtime} key for driving {@link JavaPlatformStringLookup#lookup(String)}. */
private static final String KEY_RUNTIME = "runtime";
- /** <code>version</code> key for driving {@link JavaPlatformStringLookup#lookup(String)}. */
+ /** {@code version} key for driving {@link JavaPlatformStringLookup#lookup(String)}. */
private static final String KEY_VERSION = "version";
/**
diff --git a/src/main/java/org/apache/commons/text/matcher/AbstractStringMatcher.java b/src/main/java/org/apache/commons/text/matcher/AbstractStringMatcher.java
index 42bf02c..68c0ba1 100644
--- a/src/main/java/org/apache/commons/text/matcher/AbstractStringMatcher.java
+++ b/src/main/java/org/apache/commons/text/matcher/AbstractStringMatcher.java
@@ -110,14 +110,14 @@
static final class NoMatcher extends AbstractStringMatcher {
/**
- * Constructs a new instance of <code>NoMatcher</code>.
+ * Constructs a new instance of {@code NoMatcher}.
*/
NoMatcher() {
super();
}
/**
- * Always returns <code>false</code>.
+ * Always returns {@code false}.
*
* @param buffer
* the text content to match against, do not change
@@ -198,7 +198,7 @@
private static final int SPACE_INT = 32;
/**
- * Constructs a new instance of <code>TrimMatcher</code>.
+ * Constructs a new instance of {@code TrimMatcher}.
*/
TrimMatcher() {
super();
@@ -233,11 +233,11 @@
/**
* Returns the number of matching characters, zero for no match.
* <p>
- * This method is called to check for a match. The parameter <code>pos</code> represents the current position to be
- * checked in the string <code>buffer</code> (a character array which must not be changed). The API guarantees that
- * <code>pos</code> is a valid index for <code>buffer</code>.
+ * This method is called to check for a match. The parameter {@code pos} represents the current position to be
+ * checked in the string {@code buffer} (a character array which must not be changed). The API guarantees that
+ * {@code pos} is a valid index for {@code buffer}.
* <p>
- * The matching code may check one character or many. It may check characters preceding <code>pos</code> as well as
+ * The matching code may check one character or many. It may check characters preceding {@code pos} as well as
* those after.
* <p>
* It must return zero for no match, or a positive number if a match was found. The number indicates the number of
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 01e90dc..27454c1 100644
--- a/src/main/java/org/apache/commons/text/matcher/StringMatcher.java
+++ b/src/main/java/org/apache/commons/text/matcher/StringMatcher.java
@@ -27,14 +27,14 @@
/**
* Returns the number of matching characters, zero for no match.
* <p>
- * This method is called to check for a match. The parameter <code>pos</code> represents the current position to be
- * checked in the string <code>buffer</code> (a character array which must not be changed). The API guarantees that
- * <code>pos</code> is a valid index for <code>buffer</code>.
+ * This method is called to check for a match. The parameter {@code pos} represents the current position to be
+ * checked in the string {@code buffer} (a character array which must not be changed). The API guarantees that
+ * {@code pos} is a valid index for {@code buffer}.
* <p>
* The character array may be larger than the active area to be matched. Only values in the buffer between the
* specified indices may be accessed.
* <p>
- * The matching code may check one character or many. It may check characters preceding <code>pos</code> as well as
+ * The matching code may check one character or many. It may check characters preceding {@code pos} as well as
* those after, so long as no checks exceed the bounds specified.
* <p>
* It must return zero for no match, or a positive number if a match was found. The number indicates the number of
diff --git a/src/main/java/org/apache/commons/text/similarity/EditDistance.java b/src/main/java/org/apache/commons/text/similarity/EditDistance.java
index 5faf81f..d330f78 100644
--- a/src/main/java/org/apache/commons/text/similarity/EditDistance.java
+++ b/src/main/java/org/apache/commons/text/similarity/EditDistance.java
@@ -20,25 +20,25 @@
* Interface for <a href="http://en.wikipedia.org/wiki/Edit_distance">Edit Distances</a>.
*
* <p>
- * An edit distance is a formal metric on the Kleene closure (<code>X<sup>*</sup></code>) over an
- * alphabet (<code>X</code>). Note, that a <a href="https://en.wikipedia.org/wiki/Metric_(mathematics)">metric</a>
- * on a set <code>S</code> is a function <code>d: [S * S] -> [0, INFINITY)</code> such
- * that the following hold for <code>x,y,z</code> in
- * the set <code>S</code>:
+ * An edit distance is a formal metric on the Kleene closure ({@code X<sup>*</sup>}) over an
+ * alphabet ({@code X}). Note, that a <a href="https://en.wikipedia.org/wiki/Metric_(mathematics)">metric</a>
+ * on a set {@code S} is a function {@code d: [S * S] -> [0, INFINITY)} such
+ * that the following hold for {@code x,y,z} in
+ * the set {@code S}:
* </p>
* <ul>
- * <li><code>d(x,y) >= 0</code>, non-negativity or separation axiom</li>
- * <li><code>d(x,y) == 0</code>, if and only if, <code>x == y</code></li>
- * <li><code>d(x,y) == d(y,x)</code>, symmetry, and</li>
- * <li><code>d(x,z) <= d(x,y) + d(y,z)</code>, the triangle inequality</li>
+ * <li>{@code d(x,y) >= 0}, non-negativity or separation axiom</li>
+ * <li>{@code d(x,y) == 0}, if and only if, {@code x == y}</li>
+ * <li>{@code d(x,y) == d(y,x)}, symmetry, and</li>
+ * <li>{@code d(x,z) <= d(x,y) + d(y,z)}, the triangle inequality</li>
* </ul>
*
*
* <p>
* This is a BiFunction<CharSequence, CharSequence, R>.
- * The <code>apply</code> method
+ * The {@code apply} method
* accepts a pair of {@link CharSequence} parameters
- * and returns an <code>R</code> type similarity score.
+ * and returns an {@code R} type similarity score.
* </p>
*
* @param <R> The type of similarity score unit used by this EditDistance.
diff --git a/src/main/java/org/apache/commons/text/similarity/IntersectionResult.java b/src/main/java/org/apache/commons/text/similarity/IntersectionResult.java
index 1034c69..70536be 100644
--- a/src/main/java/org/apache/commons/text/similarity/IntersectionResult.java
+++ b/src/main/java/org/apache/commons/text/similarity/IntersectionResult.java
@@ -22,7 +22,7 @@
* Represents the intersection result between two sets.
*
* <p>Stores the size of set A, set B and the intersection of A and B
- * (<code>|A ∩ B|</code>).</p>
+ * ({@code |A ∩ B|}).</p>
*
* <p>This class is immutable.</p>
*
@@ -48,7 +48,7 @@
*
* @param sizeA the size of set A ({@code |A|})
* @param sizeB the size of set B ({@code |B|})
- * @param intersection the size of the intersection of A and B (<code>|A ∩ B|</code>)
+ * @param intersection the size of the intersection of A and B ({@code |A ∩ B|})
* @throws IllegalArgumentException if the sizes are negative or the intersection is greater
* than the minimum of the two set sizes
*/
@@ -88,7 +88,7 @@
/**
* Get the size of the intersection between set A and B.
*
- * @return <code>|A ∩ B|</code>
+ * @return {@code |A ∩ B|}
*/
public int getIntersection() {
return intersection;
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 a7de9bf..0f51906 100644
--- a/src/main/java/org/apache/commons/text/similarity/LongestCommonSubsequence.java
+++ b/src/main/java/org/apache/commons/text/similarity/LongestCommonSubsequence.java
@@ -24,7 +24,7 @@
* 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
- * <code>CharSequence</code>'s <code>left</code> and <code>right</code> respectively, the runtime of the
+ * {@code CharSequence}'s {@code left} and {@code right} respectively, the runtime of the
* algorithm is <i>O(m*n)</i>.
* </p>
*
@@ -43,7 +43,7 @@
public class LongestCommonSubsequence implements SimilarityScore<Integer> {
/**
- * Calculates longest common subsequence similarity score of two <code>CharSequence</code>'s passed as
+ * Calculates longest common subsequence similarity score of two {@code CharSequence}'s passed as
* input.
*
* @param left first character sequence
@@ -62,12 +62,12 @@
}
/**
- * Computes the longest common subsequence between the two <code>CharSequence</code>'s passed as input.
+ * Computes the longest common subsequence between the two {@code CharSequence}'s passed as input.
*
* <p>
- * Note, a substring and subsequence are not necessarily the same thing. Indeed, <code>abcxyzqrs</code> and
- * <code>xyzghfm</code> have both the same common substring and subsequence, namely <code>xyz</code>. However,
- * <code>axbyczqrs</code> and <code>abcxyzqtv</code> have the longest common subsequence <code>xyzq</code> because a
+ * Note, a substring and subsequence are not necessarily the same thing. Indeed, {@code abcxyzqrs} and
+ * {@code xyzghfm} have both the same common substring and subsequence, namely {@code xyz}. However,
+ * {@code axbyczqrs} and {@code abcxyzqtv} have the longest common subsequence {@code xyzq} because a
* subsequence need not have adjacent characters.
* </p>
*
@@ -92,13 +92,13 @@
}
/**
- * Computes the longest common subsequence between the two <code>CharSequence</code>'s passed as
+ * Computes the longest common subsequence between the two {@code CharSequence}'s passed as
* input.
*
* <p>
- * Note, a substring and subsequence are not necessarily the same thing. Indeed, <code>abcxyzqrs</code> and
- * <code>xyzghfm</code> have both the same common substring and subsequence, namely <code>xyz</code>. However,
- * <code>axbyczqrs</code> and <code>abcxyzqtv</code> have the longest common subsequence <code>xyzq</code> because a
+ * Note, a substring and subsequence are not necessarily the same thing. Indeed, {@code abcxyzqrs} and
+ * {@code xyzghfm} have both the same common substring and subsequence, namely {@code xyz}. However,
+ * {@code axbyczqrs} and {@code abcxyzqtv} have the longest common subsequence {@code xyzq} because a
* subsequence need not have adjacent characters.
* </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 a33f8b3..2974546 100644
--- a/src/main/java/org/apache/commons/text/similarity/LongestCommonSubsequenceDistance.java
+++ b/src/main/java/org/apache/commons/text/similarity/LongestCommonSubsequenceDistance.java
@@ -42,9 +42,9 @@
private final LongestCommonSubsequence longestCommonSubsequence = new LongestCommonSubsequence();
/**
- * Calculates an edit distance between two <code>CharSequence</code>'s <code>left</code> and
- * <code>right</code> as: <code>left.length() + right.length() - 2 * LCS(left, right)</code>, where
- * <code>LCS</code> is given in {@link LongestCommonSubsequence#apply(CharSequence, CharSequence)}.
+ * Calculates an edit distance between two {@code CharSequence}'s {@code left} and
+ * {@code right} as: {@code left.length() + right.length() - 2 * LCS(left, right)}, where
+ * {@code LCS} is given in {@link LongestCommonSubsequence#apply(CharSequence, CharSequence)}.
*
* @param left first character sequence
* @param right second character sequence
diff --git a/src/main/java/org/apache/commons/text/similarity/SimilarityScore.java b/src/main/java/org/apache/commons/text/similarity/SimilarityScore.java
index f3723be..2156c28 100644
--- a/src/main/java/org/apache/commons/text/similarity/SimilarityScore.java
+++ b/src/main/java/org/apache/commons/text/similarity/SimilarityScore.java
@@ -24,12 +24,12 @@
* allowing for exceptions, namely the Jaro-Winkler similarity score.
* </p>
* <p>
- * We Define a SimilarityScore to be a function <code>d: [X * X] -> [0, INFINITY)</code> with the
+ * We Define a SimilarityScore to be a function {@code d: [X * X] -> [0, INFINITY)} with the
* following properties:
* </p>
* <ul>
- * <li><code>d(x,y) >= 0</code>, non-negativity or separation axiom</li>
- * <li><code>d(x,y) == d(y,x)</code>, symmetry.</li>
+ * <li>{@code d(x,y) >= 0}, non-negativity or separation axiom</li>
+ * <li>{@code d(x,y) == d(y,x)}, symmetry.</li>
* </ul>
*
* <p>
@@ -39,9 +39,9 @@
*
* <p>
* Further, this intended to be BiFunction<CharSequence, CharSequence, R>.
- * The <code>apply</code> method
+ * The {@code apply} method
* accepts a pair of {@link CharSequence} parameters
- * and returns an <code>R</code> type similarity score. We have omitted the explicit
+ * and returns an {@code R} type similarity score. We have omitted the explicit
* statement of extending BiFunction due to it only being implemented in Java 1.8, and we
* wish to maintain Java 1.7 compatibility.
* </p>
diff --git a/src/main/java/org/apache/commons/text/translate/CharSequenceTranslator.java b/src/main/java/org/apache/commons/text/translate/CharSequenceTranslator.java
index dd719fe..44e3087 100644
--- a/src/main/java/org/apache/commons/text/translate/CharSequenceTranslator.java
+++ b/src/main/java/org/apache/commons/text/translate/CharSequenceTranslator.java
@@ -128,11 +128,11 @@
}
/**
- * <p>Returns an upper case hexadecimal <code>String</code> for the given
+ * <p>Returns an upper case hexadecimal {@code String} for the given
* character.</p>
*
* @param codepoint The codepoint to convert.
- * @return An upper case hexadecimal <code>String</code>
+ * @return An upper case hexadecimal {@code String}
*/
public static String hex(final int codepoint) {
return Integer.toHexString(codepoint).toUpperCase(Locale.ENGLISH);
diff --git a/src/main/java/org/apache/commons/text/translate/EntityArrays.java b/src/main/java/org/apache/commons/text/translate/EntityArrays.java
index 1a9c6b9..0c36c6f 100644
--- a/src/main/java/org/apache/commons/text/translate/EntityArrays.java
+++ b/src/main/java/org/apache/commons/text/translate/EntityArrays.java
@@ -23,7 +23,7 @@
/**
* Class holding various entity data for HTML and XML - generally for use with
* the LookupTranslator.
- * All Maps are generated using <code>java.util.Collections.unmodifiableMap()</code>.
+ * All Maps are generated using {@code java.util.Collections.unmodifiableMap()}.
*
* @since 1.0
*/
diff --git a/src/main/java/org/apache/commons/text/translate/JavaUnicodeEscaper.java b/src/main/java/org/apache/commons/text/translate/JavaUnicodeEscaper.java
index e30d77d..bc9a157 100644
--- a/src/main/java/org/apache/commons/text/translate/JavaUnicodeEscaper.java
+++ b/src/main/java/org/apache/commons/text/translate/JavaUnicodeEscaper.java
@@ -25,7 +25,7 @@
/**
* <p>
- * Constructs a <code>JavaUnicodeEscaper</code> above the specified value (exclusive).
+ * Constructs a {@code JavaUnicodeEscaper} above the specified value (exclusive).
* </p>
*
* @param codepoint
@@ -38,7 +38,7 @@
/**
* <p>
- * Constructs a <code>JavaUnicodeEscaper</code> below the specified value (exclusive).
+ * Constructs a {@code JavaUnicodeEscaper} below the specified value (exclusive).
* </p>
*
* @param codepoint
@@ -51,7 +51,7 @@
/**
* <p>
- * Constructs a <code>JavaUnicodeEscaper</code> between the specified values (inclusive).
+ * Constructs a {@code JavaUnicodeEscaper} between the specified values (inclusive).
* </p>
*
* @param codepointLow
@@ -66,7 +66,7 @@
/**
* <p>
- * Constructs a <code>JavaUnicodeEscaper</code> outside of the specified values (exclusive).
+ * Constructs a {@code JavaUnicodeEscaper} outside of the specified values (exclusive).
* </p>
*
* @param codepointLow
@@ -81,9 +81,9 @@
/**
* <p>
- * Constructs a <code>JavaUnicodeEscaper</code> for the specified range. This is the underlying method for the
- * other constructors/builders. The <code>below</code> and <code>above</code> boundaries are inclusive when
- * <code>between</code> is <code>true</code> and exclusive when it is <code>false</code>.
+ * Constructs a {@code JavaUnicodeEscaper} for the specified range. This is the underlying method for the
+ * other constructors/builders. The {@code below} and {@code above} boundaries are inclusive when
+ * {@code between} is {@code true} and exclusive when it is {@code false}.
* </p>
*
* @param below
diff --git a/src/main/java/org/apache/commons/text/translate/NumericEntityEscaper.java b/src/main/java/org/apache/commons/text/translate/NumericEntityEscaper.java
index f9bc7e7..c5e0661 100644
--- a/src/main/java/org/apache/commons/text/translate/NumericEntityEscaper.java
+++ b/src/main/java/org/apache/commons/text/translate/NumericEntityEscaper.java
@@ -33,10 +33,10 @@
/** range from lowest codepoint to highest codepoint. */
private final Range<Integer> range;
/**
- * <p>Constructs a <code>NumericEntityEscaper</code> for the specified range. This is
- * the underlying method for the other constructors/builders. The <code>below</code>
- * and <code>above</code> boundaries are inclusive when <code>between</code> is
- * <code>true</code> and exclusive when it is <code>false</code>. </p>
+ * <p>Constructs a {@code NumericEntityEscaper} for the specified range. This is
+ * the underlying method for the other constructors/builders. The {@code below}
+ * and {@code above} boundaries are inclusive when {@code between} is
+ * {@code true} and exclusive when it is {@code false}. </p>
*
* @param below int value representing the lowest codepoint boundary
* @param above int value representing the highest codepoint boundary
@@ -48,14 +48,14 @@
}
/**
- * <p>Constructs a <code>NumericEntityEscaper</code> for all characters. </p>
+ * <p>Constructs a {@code NumericEntityEscaper} for all characters. </p>
*/
public NumericEntityEscaper() {
this(0, Integer.MAX_VALUE, true);
}
/**
- * <p>Constructs a <code>NumericEntityEscaper</code> below the specified value (exclusive). </p>
+ * <p>Constructs a {@code NumericEntityEscaper} below the specified value (exclusive). </p>
*
* @param codepoint below which to escape
* @return The newly created {@code NumericEntityEscaper} instance
@@ -65,7 +65,7 @@
}
/**
- * <p>Constructs a <code>NumericEntityEscaper</code> above the specified value (exclusive). </p>
+ * <p>Constructs a {@code NumericEntityEscaper} above the specified value (exclusive). </p>
*
* @param codepoint above which to escape
* @return The newly created {@code NumericEntityEscaper} instance
@@ -75,7 +75,7 @@
}
/**
- * <p>Constructs a <code>NumericEntityEscaper</code> between the specified values (inclusive). </p>
+ * <p>Constructs a {@code NumericEntityEscaper} between the specified values (inclusive). </p>
*
* @param codepointLow above which to escape
* @param codepointHigh below which to escape
@@ -86,7 +86,7 @@
}
/**
- * <p>Constructs a <code>NumericEntityEscaper</code> outside of the specified values (exclusive). </p>
+ * <p>Constructs a {@code NumericEntityEscaper} outside of the specified values (exclusive). </p>
*
* @param codepointLow below which to escape
* @param codepointHigh above which to escape
diff --git a/src/main/java/org/apache/commons/text/translate/UnicodeEscaper.java b/src/main/java/org/apache/commons/text/translate/UnicodeEscaper.java
index 34dde03..7718a8a 100644
--- a/src/main/java/org/apache/commons/text/translate/UnicodeEscaper.java
+++ b/src/main/java/org/apache/commons/text/translate/UnicodeEscaper.java
@@ -34,7 +34,7 @@
private final boolean between;
/**
- * <p>Constructs a <code>UnicodeEscaper</code> for all characters.
+ * <p>Constructs a {@code UnicodeEscaper} for all characters.
* </p>
*/
public UnicodeEscaper() {
@@ -42,10 +42,10 @@
}
/**
- * <p>Constructs a <code>UnicodeEscaper</code> for the specified range. This is
- * the underlying method for the other constructors/builders. The <code>below</code>
- * and <code>above</code> boundaries are inclusive when <code>between</code> is
- * <code>true</code> and exclusive when it is <code>false</code>. </p>
+ * <p>Constructs a {@code UnicodeEscaper} for the specified range. This is
+ * the underlying method for the other constructors/builders. The {@code below}
+ * and {@code above} boundaries are inclusive when {@code between} is
+ * {@code true} and exclusive when it is {@code false}. </p>
*
* @param below int value representing the lowest codepoint boundary
* @param above int value representing the highest codepoint boundary
@@ -58,7 +58,7 @@
}
/**
- * <p>Constructs a <code>UnicodeEscaper</code> below the specified value (exclusive). </p>
+ * <p>Constructs a {@code UnicodeEscaper} below the specified value (exclusive). </p>
*
* @param codepoint below which to escape
* @return The newly created {@code UnicodeEscaper} instance
@@ -68,7 +68,7 @@
}
/**
- * <p>Constructs a <code>UnicodeEscaper</code> above the specified value (exclusive). </p>
+ * <p>Constructs a {@code UnicodeEscaper} above the specified value (exclusive). </p>
*
* @param codepoint above which to escape
* @return The newly created {@code UnicodeEscaper} instance
@@ -78,7 +78,7 @@
}
/**
- * <p>Constructs a <code>UnicodeEscaper</code> outside of the specified values (exclusive). </p>
+ * <p>Constructs a {@code UnicodeEscaper} outside of the specified values (exclusive). </p>
*
* @param codepointLow below which to escape
* @param codepointHigh above which to escape
@@ -89,7 +89,7 @@
}
/**
- * <p>Constructs a <code>UnicodeEscaper</code> between the specified values (inclusive). </p>
+ * <p>Constructs a {@code UnicodeEscaper} between the specified values (inclusive). </p>
*
* @param codepointLow above which to escape
* @param codepointHigh below which to escape
diff --git a/src/test/java/org/apache/commons/text/ExtendedMessageFormatTest.java b/src/test/java/org/apache/commons/text/ExtendedMessageFormatTest.java
index 626ae93..83d4fa1 100644
--- a/src/test/java/org/apache/commons/text/ExtendedMessageFormatTest.java
+++ b/src/test/java/org/apache/commons/text/ExtendedMessageFormatTest.java
@@ -347,7 +347,7 @@
}
/**
- * Test a built in format for the specified Locales, plus <code>null</code> Locale.
+ * Test a built in format for the specified Locales, plus {@code null} Locale.
* @param pattern MessageFormat pattern
* @param args MessageFormat arguments
* @param locales to test
@@ -357,7 +357,7 @@
}
/**
- * Test a built in format for the specified Locales, plus <code>null</code> Locale.
+ * Test a built in format for the specified Locales, plus {@code null} Locale.
* @param pattern MessageFormat pattern
* @param fmtRegistry FormatFactory registry to use
* @param args MessageFormat arguments
diff --git a/src/test/java/org/apache/commons/text/StrTokenizerTest.java b/src/test/java/org/apache/commons/text/StrTokenizerTest.java
index cf40b00..72bb788 100644
--- a/src/test/java/org/apache/commons/text/StrTokenizerTest.java
+++ b/src/test/java/org/apache/commons/text/StrTokenizerTest.java
@@ -611,7 +611,7 @@
/**
* Tests that the {@link StrTokenizer#clone()} clone method catches
- * {@link CloneNotSupportedException} and returns <code>null</code>.
+ * {@link CloneNotSupportedException} and returns {@code null}.
*/
@Test
public void testCloneNotSupportedException() {
diff --git a/src/test/java/org/apache/commons/text/StringTokenizerTest.java b/src/test/java/org/apache/commons/text/StringTokenizerTest.java
index 2cbbf6b..b6e3a3b 100644
--- a/src/test/java/org/apache/commons/text/StringTokenizerTest.java
+++ b/src/test/java/org/apache/commons/text/StringTokenizerTest.java
@@ -609,7 +609,7 @@
/**
* Tests that the {@link StringTokenizer#clone()} clone method catches {@link CloneNotSupportedException} and
- * returns <code>null</code>.
+ * returns {@code null}.
*/
@Test
public void testCloneNotSupportedException() {
