Javadoc, no need to abbreviate in documentation

This commit is contained in:
Gary Gregory 2023-10-17 08:43:46 -04:00
parent 88879df3a9
commit f9e851690c
5 changed files with 14 additions and 14 deletions

View File

@ -744,7 +744,7 @@ public class Conversion {
* Converts an array of Char into a long using the default (little endian, Lsb0) byte and * Converts an array of Char into a long using the default (little endian, Lsb0) byte and
* bit ordering. * bit ordering.
* *
* @param src the hex string to convert * @param src the hexadecimal string to convert
* @param srcPos the position in {@code src}, in Char unit, from where to start the * @param srcPos the position in {@code src}, in Char unit, from where to start the
* conversion * conversion
* @param dstInit initial value of the destination long * @param dstInit initial value of the destination long
@ -775,7 +775,7 @@ public class Conversion {
* Converts an array of Char into an int using the default (little endian, Lsb0) byte and bit * Converts an array of Char into an int using the default (little endian, Lsb0) byte and bit
* ordering. * ordering.
* *
* @param src the hex string to convert * @param src the hexadecimal string to convert
* @param srcPos the position in {@code src}, in Char unit, from where to start the * @param srcPos the position in {@code src}, in Char unit, from where to start the
* conversion * conversion
* @param dstInit initial value of the destination int * @param dstInit initial value of the destination int
@ -805,7 +805,7 @@ public class Conversion {
* Converts an array of Char into a short using the default (little endian, Lsb0) byte and * Converts an array of Char into a short using the default (little endian, Lsb0) byte and
* bit ordering. * bit ordering.
* *
* @param src the hex string to convert * @param src the hexadecimal string to convert
* @param srcPos the position in {@code src}, in Char unit, from where to start the * @param srcPos the position in {@code src}, in Char unit, from where to start the
* conversion * conversion
* @param dstInit initial value of the destination short * @param dstInit initial value of the destination short
@ -836,7 +836,7 @@ public class Conversion {
* Converts an array of Char into a byte using the default (little endian, Lsb0) byte and * Converts an array of Char into a byte using the default (little endian, Lsb0) byte and
* bit ordering. * bit ordering.
* *
* @param src the hex string to convert * @param src the hexadecimal string to convert
* @param srcPos the position in {@code src}, in Char unit, from where to start the * @param srcPos the position in {@code src}, in Char unit, from where to start the
* conversion * conversion
* @param dstInit initial value of the destination byte * @param dstInit initial value of the destination byte

View File

@ -743,7 +743,7 @@ public class ObjectUtils {
} }
/** /**
* Returns the hex hash code for the given object per {@link Objects#hashCode(Object)}. * Returns the hexadecimal hash code for the given object per {@link Objects#hashCode(Object)}.
* <p> * <p>
* Short hand for {@code Integer.toHexString(Objects.hashCode(object))}. * Short hand for {@code Integer.toHexString(Objects.hashCode(object))}.
* </p> * </p>
@ -792,7 +792,7 @@ public class ObjectUtils {
} }
/** /**
* Returns the hex hash code for the given object per {@link System#identityHashCode(Object)}. * Returns the hexadecimal hash code for the given object per {@link System#identityHashCode(Object)}.
* <p> * <p>
* Short hand for {@code Integer.toHexString(System.identityHashCode(object))}. * Short hand for {@code Integer.toHexString(System.identityHashCode(object))}.
* </p> * </p>

View File

@ -930,7 +930,7 @@ public class NumberUtils {
/** /**
* Convert a {@link String} to a {@link Integer}, handling * Convert a {@link String} to a {@link Integer}, handling
* hex (0xhhhh) and octal (0dddd) notations. * hexadecimal (0xhhhh) and octal (0dddd) notations.
* N.B. a leading zero means octal; spaces are not trimmed. * N.B. a leading zero means octal; spaces are not trimmed.
* *
* <p>Returns {@code null} if the string is {@code null}.</p> * <p>Returns {@code null} if the string is {@code null}.</p>
@ -949,7 +949,7 @@ public class NumberUtils {
/** /**
* Convert a {@link String} to a {@link Long}; * Convert a {@link String} to a {@link Long};
* since 3.1 it handles hex (0Xhhhh) and octal (0ddd) notations. * since 3.1 it handles hexadecimal (0Xhhhh) and octal (0ddd) notations.
* N.B. a leading zero means octal; spaces are not trimmed. * N.B. a leading zero means octal; spaces are not trimmed.
* *
* <p>Returns {@code null} if the string is {@code null}.</p> * <p>Returns {@code null} if the string is {@code null}.</p>
@ -967,7 +967,7 @@ public class NumberUtils {
/** /**
* Convert a {@link String} to a {@link BigInteger}; * Convert a {@link String} to a {@link BigInteger};
* since 3.2 it handles hex (0x or #) and octal (0) notations. * since 3.2 it handles hexadecimal (0x or #) and octal (0) notations.
* *
* <p>Returns {@code null} if the string is {@code null}.</p> * <p>Returns {@code null} if the string is {@code null}.</p>
* *
@ -1587,7 +1587,7 @@ public class NumberUtils {
* *
* @param str the {@link String} to check * @param str the {@link String} to check
* @return {@code true} if the string is a correctly formatted number * @return {@code true} if the string is a correctly formatted number
* @since 3.3 the code supports hex {@code 0Xhhh} an * @since 3.3 the code supports hexadecimal {@code 0Xhhh} an
* octal {@code 0ddd} validation * octal {@code 0ddd} validation
* @deprecated This feature will be removed in Lang 4, * @deprecated This feature will be removed in Lang 4,
* use {@link NumberUtils#isCreatable(String)} instead * use {@link NumberUtils#isCreatable(String)} instead

View File

@ -92,11 +92,11 @@ public class JavaUnicodeEscaper extends UnicodeEscaper {
} }
/** /**
* Converts the given code point to a hex string of the form {@code "\\uXXXX\\uXXXX"} * Converts the given code point to a hexadecimal string of the form {@code "\\uXXXX\\uXXXX"}
* *
* @param codePoint * @param codePoint
* a Unicode code point * a Unicode code point
* @return the hex string for the given code point * @return the hexadecimal string for the given code point
*/ */
@Override @Override
protected String toUtf16Escape(final int codePoint) { protected String toUtf16Escape(final int codePoint) {

View File

@ -126,11 +126,11 @@ public class UnicodeEscaper extends CodePointTranslator {
} }
/** /**
* Converts the given code point to a hex string of the form {@code "\\uXXXX"} * Converts the given code point to a hexadecimal string of the form {@code "\\uXXXX"}
* *
* @param codePoint * @param codePoint
* a Unicode code point * a Unicode code point
* @return the hex string for the given code point * @return the hexadecimal string for the given code point
* *
* @since 3.2 * @since 3.2
*/ */