From fc5045c4da18b6fd811c6748aa7b5184a80f6769 Mon Sep 17 00:00:00 2001 From: Adrien Hopkins Date: Sat, 17 May 2025 23:03:29 -0500 Subject: Setup automated javadoc ./gradlew javadoc --- .../java/sevenUnits/utils/ConditionalExistenceCollections.java | 1 - src/main/java/sevenUnits/utils/DecimalComparison.java | 7 ++++--- src/main/java/sevenUnits/utils/ObjectProduct.java | 2 +- src/main/java/sevenUnits/utils/SemanticVersionNumber.java | 2 +- src/main/java/sevenUnits/utils/UncertainDouble.java | 6 +++--- 5 files changed, 9 insertions(+), 9 deletions(-) (limited to 'src/main/java/sevenUnits/utils') diff --git a/src/main/java/sevenUnits/utils/ConditionalExistenceCollections.java b/src/main/java/sevenUnits/utils/ConditionalExistenceCollections.java index b71a4e0..cb3b8ce 100644 --- a/src/main/java/sevenUnits/utils/ConditionalExistenceCollections.java +++ b/src/main/java/sevenUnits/utils/ConditionalExistenceCollections.java @@ -54,7 +54,6 @@ import java.util.function.Predicate; * @author Adrien Hopkins * @since 2019-10-17 */ -// TODO add conditional existence Lists and Sorted/Navigable Sets/Maps public final class ConditionalExistenceCollections { /** * Elements in this collection only exist if they meet a condition. diff --git a/src/main/java/sevenUnits/utils/DecimalComparison.java b/src/main/java/sevenUnits/utils/DecimalComparison.java index 0515b6b..62c3720 100644 --- a/src/main/java/sevenUnits/utils/DecimalComparison.java +++ b/src/main/java/sevenUnits/utils/DecimalComparison.java @@ -69,7 +69,7 @@ public final class DecimalComparison { * @return whether they are equal * @since 2019-03-18 * @since v0.2.0 - * @see #hashCode(double) + * @see #hash(double) */ public static final boolean equals(final double a, final double b) { return DecimalComparison.equals(a, b, DOUBLE_EPSILON); @@ -194,7 +194,7 @@ public final class DecimalComparison { * @param b second value to test * @return whether they are equal * @since 2020-09-07 - * @see #hashCode(double) + * @see #hash(double) */ public static final boolean equals(final UncertainDouble a, final UncertainDouble b) { @@ -238,12 +238,13 @@ public final class DecimalComparison { /** * Takes the hash code of doubles. Values that are equal according to - * {@link #equals(double, double)} will have the same hash code. + * {@link #equals(double, double)} will probably have the same hash code. * * @param d double to hash * @return hash code of double * @since 2019-10-16 */ + // TODO reconsider using this public static final int hash(final double d) { return Float.hashCode((float) d); } diff --git a/src/main/java/sevenUnits/utils/ObjectProduct.java b/src/main/java/sevenUnits/utils/ObjectProduct.java index 4ed70be..d403bdc 100644 --- a/src/main/java/sevenUnits/utils/ObjectProduct.java +++ b/src/main/java/sevenUnits/utils/ObjectProduct.java @@ -265,7 +265,7 @@ public class ObjectProduct implements Nameable { * Returns this product to an exponent, where every dimension is rounded to * the nearest integer. * - * This function will send a warning (via {@link System.err}) if the rounding + * This function will send a warning (via standard error) if the rounding * significantly changes the value. * * @since 2024-08-22 diff --git a/src/main/java/sevenUnits/utils/SemanticVersionNumber.java b/src/main/java/sevenUnits/utils/SemanticVersionNumber.java index fc47baa..937d474 100644 --- a/src/main/java/sevenUnits/utils/SemanticVersionNumber.java +++ b/src/main/java/sevenUnits/utils/SemanticVersionNumber.java @@ -367,7 +367,7 @@ public final class SemanticVersionNumber * @return {@code SemanticVersionNumber} instance * @since v0.4.0 * @since 2022-02-19 - * @see {@link #toString} + * @see #toString */ public static final SemanticVersionNumber fromString(String versionString) { // parse & validate version string diff --git a/src/main/java/sevenUnits/utils/UncertainDouble.java b/src/main/java/sevenUnits/utils/UncertainDouble.java index 1f7ab79..ca94817 100644 --- a/src/main/java/sevenUnits/utils/UncertainDouble.java +++ b/src/main/java/sevenUnits/utils/UncertainDouble.java @@ -61,7 +61,7 @@ public final class UncertainDouble implements Comparable { } /** - * Parses a string in the form of {@link UncertainDouble#toString(boolean)} + * Parses a string in the form of {@link UncertainDouble#toString(boolean, RoundingMode)} * and returns the corresponding {@code UncertainDouble} instance. *

* This method allows some alternative forms of the string representation, @@ -346,8 +346,8 @@ public final class UncertainDouble implements Comparable { /** * Returns a string representation of this {@code UncertainDouble}. *

- * This method returns the same value as {@link #toString(boolean)}, but - * {@code showUncertainty} is true if and only if the uncertainty is + * This method returns the same value as {@link #toString(boolean, RoundingMode)}, + * but {@code showUncertainty} is true if and only if the uncertainty is * non-zero. * *

-- cgit v1.2.3