From ee6a9305a1009e6f1e3e99d5de3cfba5305a5d1b Mon Sep 17 00:00:00 2001 From: Ben Culkin Date: Sat, 13 Mar 2021 10:13:01 -0500 Subject: Update documentation Also, did the same thing for Die I did for DiePool, where I moved the specific classes to the same file as the interface. --- dice/src/main/java/bjc/dicelang/neodice/DiePool.java | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) (limited to 'dice/src/main/java/bjc/dicelang/neodice/DiePool.java') diff --git a/dice/src/main/java/bjc/dicelang/neodice/DiePool.java b/dice/src/main/java/bjc/dicelang/neodice/DiePool.java index 4513682..16bec48 100644 --- a/dice/src/main/java/bjc/dicelang/neodice/DiePool.java +++ b/dice/src/main/java/bjc/dicelang/neodice/DiePool.java @@ -8,7 +8,8 @@ import java.util.stream.*; * Represents a pool of dice. * * @author Ben Culkin - * + * + * @param The type of the sides of the contained dice. */ @FunctionalInterface public interface DiePool { @@ -55,6 +56,7 @@ public interface DiePool { * Returns a version of this die pool which returns its results in sorted * order. * + * @param comparer The comparator to use for the dice. * @param isDescending True to sort in descending order, false to sort in ascending order. * * @return The die pool, which returns its results in sorted order. @@ -152,6 +154,7 @@ public interface DiePool { /** * Return a die pool which rolls this one, then drops a number of the lowest values. * + * @param comparer The comparer to use for the sides. * @param number The number of lowest values to drop. * * @return A die pool which has the lowest entries dropped. @@ -163,6 +166,7 @@ public interface DiePool { /** * Return a die pool which rolls this one, then drops a number of the lowest values. * + * @param comparer The comparer to use for the sides. * @param number The number of lowest values to drop. * * @return A die pool which has the lowest entries dropped. @@ -174,6 +178,7 @@ public interface DiePool { /** * Return a die pool which rolls this one, then keeps a number of the lowest values. * + * @param comparer The comparer to use for the sides. * @param number The number of lowest values to keep. * * @return A die pool which has the lowest entries kept. @@ -185,6 +190,7 @@ public interface DiePool { /** * Return a die pool which rolls this one, then keeps a number of the highest values. * + * @param comparer The comparer to use for the sides. * @param number The number of highest values to keep. * * @return A die pool which has the highest entries kept. -- cgit v1.2.3