(commons-rng) 02/07: Javadoc test helper methods

[aherbert]

This is an automated email from the ASF dual-hosted git repository.

aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-rng.git

commit 013b1e2fb2e1a35129a7a755099737dc399fdde9
Author: Alex Herbert <aherb...@apache.org>
AuthorDate: Tue Jul 9 15:35:45 2024 +0100

    Javadoc test helper methods
---
 .../src/test/java/org/apache/commons/rng/sampling/RandomAssert.java | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git 
a/commons-rng-sampling/src/test/java/org/apache/commons/rng/sampling/RandomAssert.java
 
b/commons-rng-sampling/src/test/java/org/apache/commons/rng/sampling/RandomAssert.java
index 3387d964..f43d23bd 100644
--- 
a/commons-rng-sampling/src/test/java/org/apache/commons/rng/sampling/RandomAssert.java
+++ 
b/commons-rng-sampling/src/test/java/org/apache/commons/rng/sampling/RandomAssert.java
@@ -180,6 +180,7 @@ public final class RandomAssert {
      *
      * @return the uniform random provider
      * @see RandomSource#create()
+     * @see #createRNG(int)
      */
     public static UniformRandomProvider createRNG() {
         return 
SOURCES[ThreadLocalRandom.current().nextInt(SOURCES.length)].create();
@@ -206,6 +207,7 @@ public final class RandomAssert {
      * @return the uniform random provider
      * @see RandomSource#create()
      * @see RandomSource#createSeed()
+     * @see #createRNG()
      */
     public static UniformRandomProvider[] createRNG(int count) {
         final RandomSource source = 
SOURCES[ThreadLocalRandom.current().nextInt(SOURCES.length)];
@@ -236,8 +238,8 @@ public final class RandomAssert {
      *
      * <p>It should be noted that repeat invocations of a failing test by the 
surefire plugin
      * will receive an instance with the same seed. If a test may fail due to 
stochastic conditions
-     * then consider using {@link RandomAssert#createRNG()} which will obtain 
a different RNG
-     * for repeat test executions.
+     * then consider using {@link RandomAssert#createRNG()} or {@link 
#createRNG(int)} which will
+     * obtain a different RNG for repeat test executions. 
      *
      * @return the uniform random provider
      * @see RandomSource#create()