Fix malformed Javadoc comments

Author: garydgregory

commons-rng-client-api/src/main/java/org/apache/commons/rng/UniformRandomProviderSupport.java

@@ -167,19 +167,19 @@ static void validateRange(double origin, double bound) {
      * <p>The sub-range is defined to be out of bounds if any of the following inequalities
      * is true:
      * <ul>
-     * <li>{@code fromIndex < 0}
-     * <li>{@code size < 0}
-     * <li>{@code fromIndex + size > length}, taking into account integer overflow
-     * <li>{@code length < 0}, which is implied from the former inequalities
+     * <li>{@code fromIndex < 0}</li>
+     * <li>{@code size < 0}</li>
+     * <li>{@code fromIndex + size > length}, taking into account integer overflow</li>
+     * <li>{@code length < 0}, which is implied from the former inequalities</li>
      * </ul>
      *
      * <p>Note: This is not an exact implementation of the functionality of
      * {@code Objects.checkFromIndexSize}. The following changes have been made:
      * <ul>
      * <li>The method signature has been changed to avoid the return of {@code fromIndex};
-     * this value is not used within this package.
+     * this value is not used within this package.</li>
      * <li>No checks are made for {@code length < 0} as this is assumed to be derived from
-     * an array length.
+     * an array length.</li>
      * </ul>
      *
      * @param fromIndex the lower-bound (inclusive) of the sub-interval

commons-rng-core/src/main/java/org/apache/commons/rng/core/BaseProvider.java

@@ -296,8 +296,8 @@ private static long scrambleWell(long n,
      * Extend the seed to the specified minimum length. If the seed is equal or greater than the
      * minimum length, return the same seed unchanged. Otherwise:
      * <ol>
-     *  <li>Create a new array of the specified length
-     *  <li>Copy all elements of the seed into the array
+     *  <li>Create a new array of the specified length</li>
+     *  <li>Copy all elements of the seed into the array</li>
      *  <li>Fill the remaining values. The additional values will have at most one occurrence
      *   of zero. If the original seed is all zero, the first extended value will be non-zero.
      *  </li>
@@ -355,8 +355,8 @@ protected static long[] extendSeed(long[] seed, int length) {
      * Extend the seed to the specified minimum length. If the seed is equal or greater than the
      * minimum length, return the same seed unchanged. Otherwise:
      * <ol>
-     *  <li>Create a new array of the specified length
-     *  <li>Copy all elements of the seed into the array
+     *  <li>Create a new array of the specified length</li>
+     *  <li>Copy all elements of the seed into the array</li>
      *  <li>Fill the remaining values. The additional values will have at most one occurrence
      *   of zero. If the original seed is all zero, the first extended value will be non-zero.
      *  </li>

commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/IntProvider.java

@@ -202,10 +202,10 @@ static void nextBytesFill(RandomIntSource source,
      * <p>The sub-range is defined to be out of bounds if any of the following inequalities
      * is true:
      * <ul>
-     * <li>{@code fromIndex < 0}
-     * <li>{@code size < 0}
-     * <li>{@code fromIndex + size > length}, taking into account integer overflow
-     * <li>{@code length < 0}, which is implied from the former inequalities
+     * <li>{@code fromIndex < 0}</li>
+     * <li>{@code size < 0}</li>
+     * <li>{@code fromIndex + size > length}, taking into account integer overflow</li>
+     * <li>{@code length < 0}, which is implied from the former inequalities</li>
      * </ul>
      *
      * @param fromIndex the lower-bound (inclusive) of the sub-interval

commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/MiddleSquareWeylSequence.java

@@ -63,9 +63,9 @@ public class MiddleSquareWeylSequence extends IntProvider {
      * The seed elements are used to set:</p>
      *
      * <ol>
-     *   <li>The state of the generator
-     *   <li>The state of the Weyl sequence
-     *   <li>The increment of the Weyl sequence
+     *   <li>The state of the generator</li>
+     *   <li>The state of the Weyl sequence</li>
+     *   <li>The increment of the Weyl sequence</li>
      * </ol>
      *
      * <p>The third element is set to odd to ensure a period of at least 2<sup>64</sup>. If the

commons-rng-core/src/main/java/org/apache/commons/rng/core/util/RandomStreams.java

@@ -96,10 +96,10 @@ public static <T> Stream<T> generateWithSeed(long streamSize,
      * Creates a seed to prepend to a counter. The seed is created to satisfy the following
      * requirements:
      * <ul>
-     * <li>The least significant bit is set
-     * <li>The seed is composed of characters from an n-bit alphabet
-     * <li>The character used in the least significant bits is unique
-     * <li>The other characters are sampled uniformly from the remaining (n-1) characters
+     * <li>The least significant bit is set</li>
+     * <li>The seed is composed of characters from an n-bit alphabet</li>
+     * <li>The character used in the least significant bits is unique</li>
+     * <li>The other characters are sampled uniformly from the remaining (n-1) characters</li>
      * </ul>
      *
      * <p>The composed seed is created using {@code ((seed << shift) | count)}

commons-rng-examples/examples-jmh/src/main/java/org/apache/commons/rng/examples/jmh/core/BaselineGenerationPerformance.java

@@ -41,8 +41,8 @@
  * baseline will:</p>
  *
  * <ul>
- *  <li>Run as fast as possible
- *  <li>Not be removed from the execution path
+ *  <li>Run as fast as possible</li>
+ *  <li>Not be removed from the execution path</li>
  * </ul>
  *
  * <p>The results of this benchmark should be plotted for each method using [numValues] vs [run time]
@@ -62,12 +62,12 @@ public class BaselineGenerationPerformance {
      *
      * <ul>
      *   <li>The number of bytes will be allocated when testing so the allocation overhead
-     *   should be small.
+     *   should be small.</li>
      *   <li>The number must be set so that filling the bytes from an {@code int} or {@code long}
      *   source has no advantage for the 32-bit source, e.g. the same number of underlying bits have
-     *   to be generated. Note: 127 / 4 ~ 32 ints or 127 / 8 ~ 16 longs.
+     *   to be generated. Note: 127 / 4 ~ 32 ints or 127 / 8 ~ 16 longs.</li>
      *   <li>The number should not be a factor of 4 to prevent filling completely using a 32-bit
-     *   source. This tests the edge case of partial fill.
+     *   source. This tests the edge case of partial fill.</li>
      * </ul>
      */
     static final int NEXT_BYTES_SIZE = 127;

commons-rng-examples/examples-jmh/src/main/java/org/apache/commons/rng/examples/jmh/core/LXMBenchmark.java

@@ -647,17 +647,17 @@ public static class LCG128Source {
          *
          * <p>Notes:
          * <ul>
-         * <li>Final LCG additive parameters make no significant difference.
-         * <li>Inlining the compareUnsigned operation is a marginal improvement.
+         * <li>Final LCG additive parameters make no significant difference.</li>
+         * <li>Inlining the compareUnsigned operation is a marginal improvement.</li>
          * <li>Using the conditional load of the addition is of benefit when the add parameter
          *     is close to 2^63. When close to 0 or 2^64 then branch prediction is good and
-         *     this path is fast.
+         *     this path is fast.</li>
          * <li>Using the full branchless version creates code with a constant time cost which
          *     is fast. The branch code is faster when the branch is ~100% predictable, but can
-         *     be much slower.
+         *     be much slower.</li>
          * <li>The branchless version assuming the add parameter is odd is constant time cost
          *     and fastest. The code is very small and putting it in a method will be inlined
-         *     and allows code reuse.
+         *     and allows code reuse.</li>
          * </ul>
          */
         @Param({
@@ -695,10 +695,10 @@ public static class LCG128Source {
         /**
          * Range for a random addition to the additive parameter.
          * <ul>
-         * <li>{@code range == 0}: no addition
-         * <li>{@code range == Long.MIN_VALUE}: random addition
-         * <li>{@code range > 0}: random in [0, range)
-         * <li>{@code range < 0}: random in [0, -range) + 2^63
+         * <li>{@code range == 0}: no addition</li>
+         * <li>{@code range == Long.MIN_VALUE}: random addition</li>
+         * <li>{@code range > 0}: random in [0, range)</li>
+         * <li>{@code range < 0}: random in [0, -range) + 2^63</li>
          * </ul>
          */
         @Param({

commons-rng-examples/examples-jmh/src/main/java/org/apache/commons/rng/examples/jmh/package-info.java

@@ -26,10 +26,10 @@
  * </p>
  *
  * <ul>
- *   <li>The {@link org.apache.commons.rng.examples.jmh.RandomSourceValues RandomSourceValues} class
- *   <li>The {@link org.apache.commons.rng.examples.jmh.core.BaselineSources BaselineSources} class
+ *   <li>The {@link org.apache.commons.rng.examples.jmh.RandomSourceValues RandomSourceValues} class</li>
+ *   <li>The {@link org.apache.commons.rng.examples.jmh.core.BaselineSources BaselineSources} class</li>
  *   <li>The {@link org.apache.commons.rng.examples.jmh.simple.ConstructionPerformance
- *       ConstructionPerformance} class
+ *       ConstructionPerformance} class</li>
  * </ul>
  */
 package org.apache.commons.rng.examples.jmh;

commons-rng-examples/examples-jmh/src/main/java/org/apache/commons/rng/examples/jmh/sampling/ArrayShuffleBenchmark.java

@@ -47,7 +47,7 @@
  * <ul>
  * <li>Nevin Brackett-Rozinsky, Daniel Lemire,
  * Batched Ranged Random Integer Generation, Software: Practice and Experience (to appear)
- * <a href="https://arxiv.org/abs/2408.06213">arXiv:2408.06213M</a>
+ * <a href="https://arxiv.org/abs/2408.06213">arXiv:2408.06213M</a></li>
  * </ul>
  */
 @BenchmarkMode(Mode.AverageTime)

commons-rng-examples/examples-jmh/src/main/java/org/apache/commons/rng/examples/jmh/sampling/distribution/StableSamplerPerformance.java

@@ -65,12 +65,12 @@ public class StableSamplerPerformance {
      * This is a translation of the FORTRAN routine RSTAB; it computes a rearrangement
      * of the original formula to use double-angle identities and output a 0-parameterization
      * stable deviate.
-     *
+     *</li>
      * <li>The implementation uses the Chambers-Mallows-Stuck (CMS) method using
      * the formula proven in Weron (1996) "On the Chambers-Mallows-Stuck method for
      * simulating skewed stable random variables". Statistics &amp; Probability
      * Letters. 28 (2): 165–171. This outputs a 1-parameterization stable deviate and
-     * has been modified to the 0-parameterization using a translation.
+     * has been modified to the 0-parameterization using a translation.</li>
      * </ol>
      *
      * <p>The code has been copied from o.a.c.rng.sampling.distributions.StableSampler.
@@ -1088,9 +1088,9 @@ public void setup() {
          * a result in {@code [0, inf]}.
          *
          * <ul>
-         * <li>For {@code x=-inf} this returns {@code 0}.
-         * <li>For {@code x=0} this returns {@code 1}.
-         * <li>For {@code x=inf} this returns {@code inf}.
+         * <li>For {@code x=-inf} this returns {@code 0}.</li>
+         * <li>For {@code x=0} this returns {@code 1}.</li>
+         * <li>For {@code x=inf} this returns {@code inf}.</li>
          * </ul>
          *
          * <p> This corrects {@code 0 / 0} and {@code inf / inf} division from