(commons-rng) 08/31: Javadoc: add main description

[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 49a25c0034c50a363bba6e37377d2758ad9c4f19
Author: Alex Herbert <aherb...@apache.org>
AuthorDate: Wed Jul 3 14:33:15 2024 +0100

    Javadoc: add main description
---
 .../java/org/apache/commons/rng/core/RandomProviderDefaultState.java    | 2 ++
 .../main/java/org/apache/commons/rng/core/source32/RandomIntSource.java | 2 ++
 .../java/org/apache/commons/rng/core/source64/RandomLongSource.java     | 2 ++
 .../src/main/java/org/apache/commons/rng/core/source64/TwoCmres.java    | 2 ++
 4 files changed, 8 insertions(+)

diff --git 
a/commons-rng-core/src/main/java/org/apache/commons/rng/core/RandomProviderDefaultState.java
 
b/commons-rng-core/src/main/java/org/apache/commons/rng/core/RandomProviderDefaultState.java
index f21bf859..bf0eafe7 100644
--- 
a/commons-rng-core/src/main/java/org/apache/commons/rng/core/RandomProviderDefaultState.java
+++ 
b/commons-rng-core/src/main/java/org/apache/commons/rng/core/RandomProviderDefaultState.java
@@ -48,6 +48,8 @@ public class RandomProviderDefaultState implements 
RandomProviderState {
     }
 
     /**
+     * Get the state.
+     *
      * @return the internal state.
      */
     public byte[] getState() {
diff --git 
a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/RandomIntSource.java
 
b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/RandomIntSource.java
index 5f723299..337aff7e 100644
--- 
a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/RandomIntSource.java
+++ 
b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/RandomIntSource.java
@@ -24,6 +24,8 @@ package org.apache.commons.rng.core.source32;
  */
 public interface RandomIntSource {
     /**
+     * Return the next random value.
+     *
      * @return the next random value.
      */
     int next();
diff --git 
a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/RandomLongSource.java
 
b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/RandomLongSource.java
index 0b3a19dc..e2216d6b 100644
--- 
a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/RandomLongSource.java
+++ 
b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/RandomLongSource.java
@@ -24,6 +24,8 @@ package org.apache.commons.rng.core.source64;
  */
 public interface RandomLongSource {
     /**
+     * Return the next random value.
+     *
      * @return the next random value.
      */
     long next();
diff --git 
a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/TwoCmres.java
 
b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/TwoCmres.java
index 52705bad..2db4e2bd 100644
--- 
a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/TwoCmres.java
+++ 
b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/TwoCmres.java
@@ -106,6 +106,8 @@ public class TwoCmres extends LongProvider {
     }
 
     /**
+     * Get the number of subcycle generators.
+     *
      * @return the number of subcycle generators.
      */
     public static int numberOfSubcycleGenerators() {