Skip to content

Commit

Permalink
Javadoc: Replace <code></code> HTML tags with Javadoc {@code} notation.
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Dec 10, 2019
1 parent 404d678 commit 7bbbdd2
Show file tree
Hide file tree
Showing 72 changed files with 1,903 additions and 1,903 deletions.
4 changes: 2 additions & 2 deletions src/main/java/org/apache/commons/lang3/ArchUtils.java
Expand Up @@ -112,7 +112,7 @@ private static void addProcessors(final Processor processor, final String... key
* not of the operating system.
* </p>
*
* @return A {@link Processor} when supported, else <code>null</code>.
* @return A {@link Processor} when supported, else {@code null}.
*/
public static Processor getProcessor() {
return getProcessor(SystemUtils.OS_ARCH);
Expand All @@ -123,7 +123,7 @@ public static Processor getProcessor() {
* like a value returned by the os.arch System Property.
*
* @param value A {@link String} like a value returned by the os.arch System Property.
* @return A {@link Processor} when it exists, else <code>null</code>.
* @return A {@link Processor} when it exists, else {@code null}.
*/
public static Processor getProcessor(final String value) {
return ARCH_TO_PROCESSOR.get(value);
Expand Down
28 changes: 14 additions & 14 deletions src/main/java/org/apache/commons/lang3/ArrayUtils.java
Expand Up @@ -5267,7 +5267,7 @@ public static <T> T[] removeAll(final T[] array, final int... indices) {
* <p>
* All subsequent elements are shifted to the left (subtracts one from their indices).
* If the array doesn't contains such an element, no elements are removed from the array.
* <code>null</code> will be returned if the input array is <code>null</code>.
* {@code null} will be returned if the input array is {@code null}.
* </p>
*
* @param element the element to remove
Expand All @@ -5286,7 +5286,7 @@ public static boolean[] removeAllOccurences(final boolean[] array, final boolean
* <p>
* All subsequent elements are shifted to the left (subtracts one from their indices).
* If the array doesn't contains such an element, no elements are removed from the array.
* <code>null</code> will be returned if the input array is <code>null</code>.
* {@code null} will be returned if the input array is {@code null}.
* </p>
*
* @param element the element to remove
Expand All @@ -5305,7 +5305,7 @@ public static byte[] removeAllOccurences(final byte[] array, final byte element)
* <p>
* All subsequent elements are shifted to the left (subtracts one from their indices).
* If the array doesn't contains such an element, no elements are removed from the array.
* <code>null</code> will be returned if the input array is <code>null</code>.
* {@code null} will be returned if the input array is {@code null}.
* </p>
*
* @param element the element to remove
Expand All @@ -5324,7 +5324,7 @@ public static char[] removeAllOccurences(final char[] array, final char element)
* <p>
* All subsequent elements are shifted to the left (subtracts one from their indices).
* If the array doesn't contains such an element, no elements are removed from the array.
* <code>null</code> will be returned if the input array is <code>null</code>.
* {@code null} will be returned if the input array is {@code null}.
* </p>
*
* @param element the element to remove
Expand All @@ -5343,7 +5343,7 @@ public static double[] removeAllOccurences(final double[] array, final double el
* <p>
* All subsequent elements are shifted to the left (subtracts one from their indices).
* If the array doesn't contains such an element, no elements are removed from the array.
* <code>null</code> will be returned if the input array is <code>null</code>.
* {@code null} will be returned if the input array is {@code null}.
* </p>
*
* @param element the element to remove
Expand All @@ -5362,7 +5362,7 @@ public static float[] removeAllOccurences(final float[] array, final float eleme
* <p>
* All subsequent elements are shifted to the left (subtracts one from their indices).
* If the array doesn't contains such an element, no elements are removed from the array.
* <code>null</code> will be returned if the input array is <code>null</code>.
* {@code null} will be returned if the input array is {@code null}.
* </p>
*
* @param element the element to remove
Expand All @@ -5381,7 +5381,7 @@ public static int[] removeAllOccurences(final int[] array, final int element) {
* <p>
* All subsequent elements are shifted to the left (subtracts one from their indices).
* If the array doesn't contains such an element, no elements are removed from the array.
* <code>null</code> will be returned if the input array is <code>null</code>.
* {@code null} will be returned if the input array is {@code null}.
* </p>
*
* @param element the element to remove
Expand All @@ -5400,7 +5400,7 @@ public static long[] removeAllOccurences(final long[] array, final long element)
* <p>
* All subsequent elements are shifted to the left (subtracts one from their indices).
* If the array doesn't contains such an element, no elements are removed from the array.
* <code>null</code> will be returned if the input array is <code>null</code>.
* {@code null} will be returned if the input array is {@code null}.
* </p>
*
* @param element the element to remove
Expand All @@ -5419,7 +5419,7 @@ public static short[] removeAllOccurences(final short[] array, final short eleme
* <p>
* All subsequent elements are shifted to the left (subtracts one from their indices).
* If the array doesn't contains such an element, no elements are removed from the array.
* <code>null</code> will be returned if the input array is <code>null</code>.
* {@code null} will be returned if the input array is {@code null}.
* </p>
*
* @param <T> the type of object in the array
Expand Down Expand Up @@ -8637,9 +8637,9 @@ public static void swap(final short[] array, int offset1, int offset2, int len)
* <p>Note, this method makes only sense to provide arguments of the same type so that the
* compiler can deduce the type of the array itself. While it is possible to select the
* type explicitly like in
* <code>Number[] array = ArrayUtils.&lt;Number&gt;toArray(Integer.valueOf(42), Double.valueOf(Math.PI))</code>,
* {@code Number[] array = ArrayUtils.&lt;Number&gt;toArray(Integer.valueOf(42), Double.valueOf(Math.PI))},
* there is no real advantage when compared to
* <code>new Number[] {Integer.valueOf(42), Double.valueOf(Math.PI)}</code>.
* {@code new Number[] {Integer.valueOf(42), Double.valueOf(Math.PI)}}.
*
* @param <T> the array's element type
* @param items the varargs array items, null allowed
Expand Down Expand Up @@ -9289,7 +9289,7 @@ public static short[] toPrimitive(final Short[] array, final short valueForNull)
* <p>Multi-dimensional arrays are handled correctly, including
* multi-dimensional primitive arrays.
*
* <p>The format is that of Java source code, for example <code>{a,b}</code>.
* <p>The format is that of Java source code, for example {@code {a,b}}.
*
* @param array the array to get a toString for, may be {@code null}
* @return a String representation of the array, '{}' if null array input
Expand All @@ -9304,7 +9304,7 @@ public static String toString(final Object array) {
* <p>Multi-dimensional arrays are handled correctly, including
* multi-dimensional primitive arrays.
*
* <p>The format is that of Java source code, for example <code>{a,b}</code>.
* <p>The format is that of Java source code, for example {@code {a,b}}.
*
* @param array the array to get a toString for, may be {@code null}
* @param stringIfNull the String to return if the array is {@code null}
Expand Down Expand Up @@ -9372,7 +9372,7 @@ public static String[] toStringArray(final Object[] array, final String valueFor

/**
* <p>ArrayUtils instances should NOT be constructed in standard programming.
* Instead, the class should be used as <code>ArrayUtils.clone(new int[] {2})</code>.
* Instead, the class should be used as {@code ArrayUtils.clone(new int[] {2})}.
*
* <p>This constructor is public to permit tools that require a JavaBean instance
* to operate.
Expand Down
44 changes: 22 additions & 22 deletions src/main/java/org/apache/commons/lang3/CharSequenceUtils.java
Expand Up @@ -59,42 +59,42 @@ public static CharSequence subSequence(final CharSequence cs, final int start) {

//-----------------------------------------------------------------------
/**
* Returns the index within <code>cs</code> of the first occurrence of the
* Returns the index within {@code cs} of the first occurrence of the
* specified character, starting the search at the specified index.
* <p>
* If a character with value <code>searchChar</code> occurs in the
* character sequence represented by the <code>cs</code>
* object at an index no smaller than <code>start</code>, then
* If a character with value {@code searchChar} occurs in the
* character sequence represented by the {@code cs}
* object at an index no smaller than {@code start}, then
* the index of the first such occurrence is returned. For values
* of <code>searchChar</code> in the range from 0 to 0xFFFF (inclusive),
* of {@code searchChar} in the range from 0 to 0xFFFF (inclusive),
* this is the smallest value <i>k</i> such that:
* <blockquote><pre>
* (this.charAt(<i>k</i>) == searchChar) &amp;&amp; (<i>k</i> &gt;= start)
* </pre></blockquote>
* is true. For other values of <code>searchChar</code>, it is the
* is true. For other values of {@code searchChar}, it is the
* smallest value <i>k</i> such that:
* <blockquote><pre>
* (this.codePointAt(<i>k</i>) == searchChar) &amp;&amp; (<i>k</i> &gt;= start)
* </pre></blockquote>
* is true. In either case, if no such character occurs inm <code>cs</code>
* at or after position <code>start</code>, then
* <code>-1</code> is returned.
* is true. In either case, if no such character occurs inm {@code cs}
* at or after position {@code start}, then
* {@code -1} is returned.
*
* <p>
* There is no restriction on the value of <code>start</code>. If it
* There is no restriction on the value of {@code start}. If it
* is negative, it has the same effect as if it were zero: the entire
* <code>CharSequence</code> may be searched. If it is greater than
* the length of <code>cs</code>, it has the same effect as if it were
* equal to the length of <code>cs</code>: <code>-1</code> is returned.
* {@code CharSequence} may be searched. If it is greater than
* the length of {@code cs}, it has the same effect as if it were
* equal to the length of {@code cs}: {@code -1} is returned.
*
* <p>All indices are specified in <code>char</code> values
* <p>All indices are specified in {@code char} values
* (Unicode code units).
*
* @param cs the {@code CharSequence} to be processed, not null
* @param searchChar the char to be searched for
* @param start the start index, negative starts at the string start
* @return the index where the search char was found, -1 if not found
* @since 3.6 updated to behave more like <code>String</code>
* @since 3.6 updated to behave more like {@code String}
*/
static int indexOf(final CharSequence cs, final int searchChar, int start) {
if (cs instanceof String) {
Expand Down Expand Up @@ -147,30 +147,30 @@ static int indexOf(final CharSequence cs, final CharSequence searchChar, final i
}

/**
* Returns the index within <code>cs</code> of the last occurrence of
* Returns the index within {@code cs} of the last occurrence of
* the specified character, searching backward starting at the
* specified index. For values of <code>searchChar</code> in the range
* specified index. For values of {@code searchChar} in the range
* from 0 to 0xFFFF (inclusive), the index returned is the largest
* value <i>k</i> such that:
* <blockquote><pre>
* (this.charAt(<i>k</i>) == searchChar) &amp;&amp; (<i>k</i> &lt;= start)
* </pre></blockquote>
* is true. For other values of <code>searchChar</code>, it is the
* is true. For other values of {@code searchChar}, it is the
* largest value <i>k</i> such that:
* <blockquote><pre>
* (this.codePointAt(<i>k</i>) == searchChar) &amp;&amp; (<i>k</i> &lt;= start)
* </pre></blockquote>
* is true. In either case, if no such character occurs in <code>cs</code>
* at or before position <code>start</code>, then <code>-1</code> is returned.
* is true. In either case, if no such character occurs in {@code cs}
* at or before position {@code start}, then {@code -1} is returned.
*
* <p>All indices are specified in <code>char</code> values
* <p>All indices are specified in {@code char} values
* (Unicode code units).
*
* @param cs the {@code CharSequence} to be processed
* @param searchChar the char to be searched for
* @param start the start index, negative returns -1, beyond length starts at end
* @return the index where the search char was found, -1 if not found
* @since 3.6 updated to behave more like <code>String</code>
* @since 3.6 updated to behave more like {@code String}
*/
static int lastIndexOf(final CharSequence cs, final int searchChar, int start) {
if (cs instanceof String) {
Expand Down
18 changes: 9 additions & 9 deletions src/main/java/org/apache/commons/lang3/Functions.java
Expand Up @@ -285,7 +285,7 @@ public static <O, T extends Throwable> O call(FailableCallable<O, T> pCallable)
/**
* Consumes a consumer and rethrows any exception as a {@link RuntimeException}.
* @param pConsumer the consumer to consume
* @param pObject the object to consume by <code>pConsumer</code>
* @param pObject the object to consume by {@code pConsumer}
* @param <O> the type the consumer accepts
* @param <T> the type of checked exception the consumer may throw
*/
Expand All @@ -300,8 +300,8 @@ public static <O, T extends Throwable> void accept(FailableConsumer<O, T> pConsu
/**
* Consumes a consumer and rethrows any exception as a {@link RuntimeException}.
* @param pConsumer the consumer to consume
* @param pObject1 the first object to consume by <code>pConsumer</code>
* @param pObject2 the second object to consume by <code>pConsumer</code>
* @param pObject1 the first object to consume by {@code pConsumer}
* @param pObject2 the second object to consume by {@code pConsumer}
* @param <O1> the type of the first argument the consumer accepts
* @param <O2> the type of the second argument the consumer accepts
* @param <T> the type of checked exception the consumer may throw
Expand All @@ -317,7 +317,7 @@ public static <O1, O2, T extends Throwable> void accept(FailableBiConsumer<O1, O
/**
* Applies a function and rethrows any exception as a {@link RuntimeException}.
* @param pFunction the function to apply
* @param pInput the input to apply <code>pFunction</code> on
* @param pInput the input to apply {@code pFunction} on
* @param <I> the type of the argument the function accepts
* @param <O> the return type of the function
* @param <T> the type of checked exception the function may throw
Expand All @@ -334,8 +334,8 @@ public static <I, O, T extends Throwable> O apply(FailableFunction<I, O, T> pFun
/**
* Applies a function and rethrows any exception as a {@link RuntimeException}.
* @param pFunction the function to apply
* @param pInput1 the first input to apply <code>pFunction</code> on
* @param pInput2 the second input to apply <code>pFunction</code> on
* @param pInput1 the first input to apply {@code pFunction} on
* @param pInput2 the second input to apply {@code pFunction} on
* @param <I1> the type of the first argument the function accepts
* @param <I2> the type of the second argument the function accepts
* @param <O> the return type of the function
Expand All @@ -353,7 +353,7 @@ public static <I1, I2, O, T extends Throwable> O apply(FailableBiFunction<I1, I2
/**
* Tests a predicate and rethrows any exception as a {@link RuntimeException}.
* @param pPredicate the predicate to test
* @param pObject the input to test by <code>pPredicate</code>
* @param pObject the input to test by {@code pPredicate}
* @param <O> the type of argument the predicate tests
* @param <T> the type of checked exception the predicate may throw
* @return the boolean value returned by the predicate
Expand All @@ -369,8 +369,8 @@ public static <O, T extends Throwable> boolean test(FailablePredicate<O, T> pPre
/**
* Tests a predicate and rethrows any exception as a {@link RuntimeException}.
* @param pPredicate the predicate to test
* @param pObject1 the first input to test by <code>pPredicate</code>
* @param pObject2 the second input to test by <code>pPredicate</code>
* @param pObject1 the first input to test by {@code pPredicate}
* @param pObject2 the second input to test by {@code pPredicate}
* @param <O1> the type of the first argument the predicate tests
* @param <O2> the type of the second argument the predicate tests
* @param <T> the type of checked exception the predicate may throw
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/apache/commons/lang3/JavaVersion.java
Expand Up @@ -242,7 +242,7 @@ static JavaVersion get(final String nom) {
/**
* <p>The string value is overridden to return the standard name.</p>
*
* <p>For example, <code>"1.5"</code>.</p>
* <p>For example, {@code "1.5"}.</p>
*
* @return the name, not null
*/
Expand Down
Expand Up @@ -18,10 +18,10 @@

/**
* <p>Thrown to indicate that a block of code has not been implemented.
* This exception supplements <code>UnsupportedOperationException</code>
* This exception supplements {@code UnsupportedOperationException}
* by providing a more semantically rich description of the problem.</p>
*
* <p><code>NotImplementedException</code> represents the case where the
* <p>{@code NotImplementedException} represents the case where the
* author has yet to implement the logic at this point in the program.
* This can act as an exception based TODO tag. </p>
*
Expand Down
8 changes: 4 additions & 4 deletions src/main/java/org/apache/commons/lang3/RegExUtils.java
Expand Up @@ -74,7 +74,7 @@ public static String removeAll(final String text, final Pattern regex) {
*
* <p>Unlike in the {@link #removePattern(String, String)} method, the {@link Pattern#DOTALL} option
* is NOT automatically added.
* To use the DOTALL option prepend <code>"(?s)"</code> to the regex.
* To use the DOTALL option prepend {@code "(?s)"} to the regex.
* DOTALL is also known as single-line mode in Perl.</p>
*
* <pre>
Expand Down Expand Up @@ -155,7 +155,7 @@ public static String removeFirst(final String text, final Pattern regex) {
* <p>A {@code null} reference passed to this method is a no-op.</p>
*
* <p>The {@link Pattern#DOTALL} option is NOT automatically added.
* To use the DOTALL option prepend <code>"(?s)"</code> to the regex.
* To use the DOTALL option prepend {@code "(?s)"} to the regex.
* DOTALL is also known as single-line mode in Perl.</p>
*
* <pre>
Expand Down Expand Up @@ -276,7 +276,7 @@ public static String replaceAll(final String text, final Pattern regex, final St
*
* <p>Unlike in the {@link #replacePattern(String, String, String)} method, the {@link Pattern#DOTALL} option
* is NOT automatically added.
* To use the DOTALL option prepend <code>"(?s)"</code> to the regex.
* To use the DOTALL option prepend {@code "(?s)"} to the regex.
* DOTALL is also known as single-line mode in Perl.</p>
*
* <pre>
Expand Down Expand Up @@ -372,7 +372,7 @@ public static String replaceFirst(final String text, final Pattern regex, final
* <p>A {@code null} reference passed to this method is a no-op.</p>
*
* <p>The {@link Pattern#DOTALL} option is NOT automatically added.
* To use the DOTALL option prepend <code>"(?s)"</code> to the regex.
* To use the DOTALL option prepend {@code "(?s)"} to the regex.
* DOTALL is also known as single-line mode in Perl.</p>
*
* <pre>
Expand Down

0 comments on commit 7bbbdd2

Please sign in to comment.