Allow javadoc warnings in the JMH module master
authorAlex Herbert <aherbert@apache.org>
Fri, 5 Aug 2022 19:39:56 +0000 (20:39 +0100)
committerAlex Herbert <aherbert@apache.org>
Fri, 5 Aug 2022 19:39:56 +0000 (20:39 +0100)
Enables building on JDK 17

.github/workflows/coverage.yml
.github/workflows/maven.yml
commons-rng-client-api/src/main/java/org/apache/commons/rng/UniformRandomProvider.java
commons-rng-core/src/main/java/org/apache/commons/rng/core/BaseProvider.java
commons-rng-examples/examples-jmh/pom.xml
commons-rng-examples/examples-stress/src/main/java/org/apache/commons/rng/examples/stress/OutputCommand.java
commons-rng-examples/examples-stress/src/main/java/org/apache/commons/rng/examples/stress/RngDataOutput.java
commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/FastLoadedDiceRollerDiscreteSampler.java
commons-rng-simple/src/main/java/org/apache/commons/rng/simple/internal/Conversions.java
commons-rng-simple/src/main/java/org/apache/commons/rng/simple/internal/MixFunctions.java
pom.xml

index 825a387728e533bbd96ee6021caf3f5fcef56da8..dc4ef945e1ae7caace7b21afc27a3f92e95839be 100644 (file)
@@ -33,7 +33,7 @@ jobs:
     - name: Set up JDK ${{ matrix.java }}
       uses: actions/setup-java@v3
       with:
-        distribution: adopt
+        distribution: temurin
         java-version: ${{ matrix.java }}
         cache: 'maven'
     - name: Build with Maven including the docs-archive module using a profile
index 53d4f8d85178d7625262fea303881338b52347a2..3099397d03cd86f126651cc2abfefb38eb4fd3c4 100644 (file)
@@ -33,7 +33,7 @@ jobs:
     - name: Set up JDK ${{ matrix.java }}
       uses: actions/setup-java@v3
       with:
-        distribution: adopt
+        distribution: temurin
         java-version: ${{ matrix.java }}
         cache: 'maven'
     - name: Build with Maven
index f2f5c31426aa8d599908bf5656606ef062f8dd17..d650cd6d05a4c34516e03d59ebd4dd1b49dfb067 100644 (file)
@@ -30,8 +30,7 @@ public interface UniformRandomProvider {
     /**
      * Generates {@code byte} values and places them into a user-supplied array.
      *
-     * <p>The number of random bytes produced is equal to the length of the
-     * the byte array.
+     * <p>The number of random bytes produced is equal to the length of the byte array.
      *
      * @param bytes Byte array in which to put the random bytes.
      * Cannot be {@code null}.
index ed6d6a3530fba53230ebf910572a8360ca1ac901..e78dbea245cbf565bee3242f3dfb3dde7d39ff4f 100644 (file)
@@ -27,14 +27,14 @@ import org.apache.commons.rng.RandomProviderState;
 public abstract class BaseProvider
     implements RestorableUniformRandomProvider {
     /**
-     * The fractional part of the the golden ratio, phi, scaled to 64-bits and rounded to odd.
+     * The fractional part of the golden ratio, phi, scaled to 64-bits and rounded to odd.
      * <pre>
      * phi = (sqrt(5) - 1) / 2) * 2^64
      * </pre>
      * @see <a href="https://en.wikipedia.org/wiki/Golden_ratio">Golden ratio</a>
      */
     private static final long GOLDEN_RATIO_64 = 0x9e3779b97f4a7c15L;
-    /** The fractional part of the the golden ratio, phi, scaled to 32-bits and rounded to odd. */
+    /** The fractional part of the golden ratio, phi, scaled to 32-bits and rounded to odd. */
     private static final int GOLDEN_RATIO_32 = 0x9e3779b9;
 
     /** {@inheritDoc} */
index c68f24c47287dd86acdb6d0de71d740a8e4d5654..ae492fc271a5fe4d99ae48feb058422dee96386d 100644 (file)
           <sourceFileExcludes>
             <sourceFileExclude>**/jmh_generated/*.java</sourceFileExclude>
           </sourceFileExcludes>
+          <failOnWarnings>false</failOnWarnings>
         </configuration>
       </plugin>
       <plugin>
           <sourceFileExcludes>
             <sourceFileExclude>**/jmh_generated/*.java</sourceFileExclude>
           </sourceFileExcludes>
+          <failOnWarnings>false</failOnWarnings>
         </configuration>
       </plugin>
       <plugin>
index bb2a7bcc06712a2d7aefa7e39dc274f2f4a56f82..56f0d02015ef5628e327c6290caf59f30a8c100e 100644 (file)
@@ -459,7 +459,7 @@ class OutputCommand implements Callable<Void> {
     }
 
     /**
-     * Write an {@code long} value to the the output. The native Java value will be
+     * Write an {@code long} value to the output. The native Java value will be
      * written to the writer on a single line using: a binary string representation
      * of the bytes; the unsigned integer; and the signed integer.
      *
@@ -497,7 +497,7 @@ class OutputCommand implements Callable<Void> {
     }
 
     /**
-     * Write an {@code int} value to the the output. The native Java value will be
+     * Write an {@code int} value to the output. The native Java value will be
      * written to the writer on a single line using: a binary string representation
      * of the bytes; the unsigned integer; and the signed integer.
      *
index 5abeccfd604ea4aaaba0f875e469541cfe7d58de..ab3da59046452ef617338aababf8ccb33129450e 100644 (file)
@@ -56,7 +56,7 @@ import java.nio.ByteOrder;
  * {@link java.io.DataOutputStream#writeInt(int) DataOutputStream#writeInt(int)}.</p>
  *
  * <p>This class has adaptors to write the long output from a RNG to two int values.
- * To match the caching implementation in the the core LongProvider class this is tested
+ * To match the caching implementation in the core LongProvider class this is tested
  * to output int values in the same order as an instance of the LongProvider. Currently
  * this outputs in order: low 32-bits, high 32-bits.
  */
index 625a73c16f989db7b2f43f0a75079dd8e58999af..e921373a8f549a0ee032e10ec6b3410138bf2034 100644 (file)
@@ -705,7 +705,7 @@ public abstract class FastLoadedDiceRollerDiscreteSampler
     }
 
     /**
-     * Creates the sampler. Frequencies are are represented as a 53-bit value with a
+     * Creates the sampler. Frequencies are represented as a 53-bit value with a
      * left-shift offset.
      * <pre>
      * BigInteger.valueOf(value).shiftLeft(offset)
index e107c92f65ee7f04a9cdd0b773668cbe8f3cc8ea..a09784c61a512ad378984941cdbf0f24f32f9e72 100644 (file)
@@ -28,7 +28,7 @@ package org.apache.commons.rng.simple.internal;
  */
 final class Conversions {
     /**
-     * The fractional part of the the golden ratio, phi, scaled to 64-bits and rounded to odd.
+     * The fractional part of the golden ratio, phi, scaled to 64-bits and rounded to odd.
      * <pre>
      * phi = (sqrt(5) - 1) / 2) * 2^64
      * </pre>
index eb8f4fc702b3a8f5a8caee823da3c175c125852f..4f4be9e533a4a486c2446c53cdcbbe68bf2789ae 100644 (file)
@@ -23,14 +23,14 @@ package org.apache.commons.rng.simple.internal;
  */
 final class MixFunctions {
     /**
-     * The fractional part of the the golden ratio, phi, scaled to 64-bits and rounded to odd.
+     * The fractional part of the golden ratio, phi, scaled to 64-bits and rounded to odd.
      * This can be used as an increment for a Weyl sequence.
      *
      * @see <a href="https://en.wikipedia.org/wiki/Golden_ratio">Golden ratio</a>
      */
     static final long GOLDEN_RATIO_64 = 0x9e3779b97f4a7c15L;
     /**
-     * The fractional part of the the golden ratio, phi, scaled to 32-bits and rounded to odd.
+     * The fractional part of the golden ratio, phi, scaled to 32-bits and rounded to odd.
      * This can be used as an increment for a Weyl sequence.
      *
      * @see <a href="https://en.wikipedia.org/wiki/Golden_ratio">Golden ratio</a>
diff --git a/pom.xml b/pom.xml
index 778968c882899f4927d4ed146b588cbc20e26aeb..d6c3f6551bca5761ac3988d497c447c8dbad72d0 100644 (file)
--- a/pom.xml
+++ b/pom.xml
@@ -759,6 +759,9 @@ This is avoided by creating an empty directory when svn is not available.
      <contributor>
       <name>Abhishek Singh Dhadwal</name>
     </contributor>
+    <contributor>
+      <name>Arturo Bernal</name>
+    </contributor>
   </contributors>
 
 </project>