First sentence of a Javadoc comment does not need p tags

Use the same verb as the JRE for next methods: "Returns..." ->
"Generates..."
This commit is contained in:
Gary Gregory 2022-08-23 09:36:55 -04:00
parent d0270433db
commit 02de3b21ba
1 changed files with 10 additions and 10 deletions

View File

@ -37,7 +37,7 @@ import java.util.concurrent.ThreadLocalRandom;
public class RandomUtils { public class RandomUtils {
/** /**
* Returns a random boolean value. * Generates a random boolean value.
* *
* @return the random boolean * @return the random boolean
* @since 3.5 * @since 3.5
@ -47,7 +47,7 @@ public class RandomUtils {
} }
/** /**
* Creates an array of random bytes. * Generates an array of random bytes.
* *
* @param count * @param count
* the size of the returned array * the size of the returned array
@ -63,7 +63,7 @@ public class RandomUtils {
} }
/** /**
* Returns a random double within 0 - Double.MAX_VALUE. * Generates a random double within 0 - Double.MAX_VALUE.
* *
* @return the random double * @return the random double
* @see #nextDouble(double, double) * @see #nextDouble(double, double)
@ -74,7 +74,7 @@ public class RandomUtils {
} }
/** /**
* Returns a random double within the specified range. * Generates a random double within the specified range.
* *
* @param startInclusive * @param startInclusive
* the smallest value that can be returned, must be non-negative * the smallest value that can be returned, must be non-negative
@ -98,7 +98,7 @@ public class RandomUtils {
} }
/** /**
* Returns a random float within 0 - Float.MAX_VALUE. * Generates a random float within 0 - Float.MAX_VALUE.
* *
* @return the random float * @return the random float
* @see #nextFloat(float, float) * @see #nextFloat(float, float)
@ -109,7 +109,7 @@ public class RandomUtils {
} }
/** /**
* Returns a random float within the specified range. * Generates a random float within the specified range.
* *
* @param startInclusive * @param startInclusive
* the smallest value that can be returned, must be non-negative * the smallest value that can be returned, must be non-negative
@ -133,7 +133,7 @@ public class RandomUtils {
} }
/** /**
* Returns a random int within 0 - Integer.MAX_VALUE. * Generates a random int within 0 - Integer.MAX_VALUE.
* *
* @return the random integer * @return the random integer
* @see #nextInt(int, int) * @see #nextInt(int, int)
@ -144,7 +144,7 @@ public class RandomUtils {
} }
/** /**
* Returns a random integer within the specified range. * Generates a random integer within the specified range.
* *
* @param startInclusive * @param startInclusive
* the smallest value that can be returned, must be non-negative * the smallest value that can be returned, must be non-negative
@ -168,7 +168,7 @@ public class RandomUtils {
} }
/** /**
* Returns a random long within 0 - Long.MAX_VALUE. * Generates a random long within 0 - Long.MAX_VALUE.
* *
* @return the random long * @return the random long
* @see #nextLong(long, long) * @see #nextLong(long, long)
@ -199,7 +199,7 @@ public class RandomUtils {
} }
/** /**
* Returns a random long within the specified range. * Generates a random long within the specified range.
* *
* @param startInclusive * @param startInclusive
* the smallest value that can be returned, must be non-negative * the smallest value that can be returned, must be non-negative