Setup automated javadoc

./gradlew javadoc

13 files changed, 24 insertions, 23 deletions

diff --git a/build.gradle b/build.gradle
index b775b70..929f1c2 100644
--- a/build.gradle
+++ b/build.gradle
@@ -44,6 +44,9 @@ jacocoTestReport {
 
 javadoc {
 	destinationDir = file("${buildDir}/docs/javadoc")
+	// https://gist.github.com/claudioaltamura/aba1f6506a53b9f5499fd507abd572df
+        (options as StandardJavadocDocletOptions)
+            .tags("apiNote:a:API Note:", "implSpec:a:Implementation Requirements:", "implNote:a:Implementation Note:")
 }
 
 run {
diff --git a/src/main/java/sevenUnits/unit/LinearUnitValue.java b/src/main/java/sevenUnits/unit/LinearUnitValue.java
index e239b49..678c59c 100644
--- a/src/main/java/sevenUnits/unit/LinearUnitValue.java
+++ b/src/main/java/sevenUnits/unit/LinearUnitValue.java
@@ -58,7 +58,6 @@ public final class LinearUnitValue {
 	 * 
 	 * @param unit        unit to express with
 	 * @param value       value to express
-	 * @param uncertainty absolute uncertainty of value
 	 * @return uncertain {@code LinearUnitValue} instance
 	 * @since 2020-07-26
 	 */
diff --git a/src/main/java/sevenUnits/unit/MultiUnit.java b/src/main/java/sevenUnits/unit/MultiUnit.java
index 950c547..c6d3b97 100644
--- a/src/main/java/sevenUnits/unit/MultiUnit.java
+++ b/src/main/java/sevenUnits/unit/MultiUnit.java
@@ -101,7 +101,7 @@ public final class MultiUnit extends Unitlike<List<Double>> {
 	 *           output of this method.
 	 * 
 	 * @param other unit to convert to
-	 * @param value value to convert
+	 * @param values values to convert
 	 * @return converted value
 	 * @since 2020-10-03
 	 * @throws IllegalArgumentException if {@code other} is incompatible for
@@ -129,7 +129,7 @@ public final class MultiUnit extends Unitlike<List<Double>> {
 	 *           output of this method.
 	 * 
 	 * @param other unit to convert to
-	 * @param value value to convert
+	 * @param values values to convert
 	 * @return converted value
 	 * @since 2020-10-03
 	 * @throws IllegalArgumentException if {@code other} is incompatible for
diff --git a/src/main/java/sevenUnits/unit/UnitDatabase.java b/src/main/java/sevenUnits/unit/UnitDatabase.java
index 690430b..444b366 100644
--- a/src/main/java/sevenUnits/unit/UnitDatabase.java
+++ b/src/main/java/sevenUnits/unit/UnitDatabase.java
@@ -1947,7 +1947,7 @@ public final class UnitDatabase {
 	 * 
 	 * @param file file to read
 	 * @throws NullPointerException if file is null
-	 * @returns list of errors that happened when loading file
+	 * @return list of errors that happened when loading file
 	 * @since 2019-01-13
 	 * @since v0.1.0
 	 */
@@ -2017,7 +2017,7 @@ public final class UnitDatabase {
 	 * 
 	 * @param file file to read
 	 * @throws NullPointerException if file is null
-	 * @returns list of errors that happened when loading file
+	 * @return list of errors that happened when loading file
 	 * @since 2019-01-13
 	 * @since v0.1.0
 	 */
@@ -2113,11 +2113,11 @@ public final class UnitDatabase {
 	 * <p>
 	 * Specifically, the operations that will throw an IllegalStateException if
 	 * the map is infinite in size are:
+	 * </p>
 	 * <ul>
 	 * <li>{@code unitMap.entrySet().toArray()} (either overloading)</li>
 	 * <li>{@code unitMap.keySet().toArray()} (either overloading)</li>
 	 * </ul>
-	 * </p>
 	 * <p>
 	 * Because of ambiguities between prefixes (i.e. kilokilo = mega), the map's
 	 * {@link PrefixedUnitMap#containsValue containsValue} and
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<T> 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<UncertainDouble> {
 	}
 	
 	/**
-	 * 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.
 	 * <p>
 	 * This method allows some alternative forms of the string representation,
@@ -346,8 +346,8 @@ public final class UncertainDouble implements Comparable<UncertainDouble> {
 	/**
 	 * Returns a string representation of this {@code UncertainDouble}.
 	 * <p>
-	 * 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.
 	 * 
 	 * <p>
diff --git a/src/main/java/sevenUnitsGUI/Presenter.java b/src/main/java/sevenUnitsGUI/Presenter.java
index 0dc7ea0..e383b2c 100644
--- a/src/main/java/sevenUnitsGUI/Presenter.java
+++ b/src/main/java/sevenUnitsGUI/Presenter.java
@@ -1205,7 +1205,7 @@ public final class Presenter {
 	 * @param oneWayConversionEnabled whether not one-way conversion should be
 	 *                                enabled
 	 * @since 2022-03-30
-	 * @see {@link #isOneWayConversionEnabled}
+	 * @see #oneWayConversionEnabled
 	 */
 	public void setOneWayConversionEnabled(boolean oneWayConversionEnabled) {
 		this.oneWayConversionEnabled = oneWayConversionEnabled;
diff --git a/src/main/java/sevenUnitsGUI/UnitConversionRecord.java b/src/main/java/sevenUnitsGUI/UnitConversionRecord.java
index fa64ee9..da1a9d2 100644
--- a/src/main/java/sevenUnitsGUI/UnitConversionRecord.java
+++ b/src/main/java/sevenUnitsGUI/UnitConversionRecord.java
@@ -31,8 +31,8 @@ public final class UnitConversionRecord {
 	/**
 	 * Gets a {@code UnitConversionRecord} from two linear unit values
 	 *
-	 * @param input  input unit & value
-	 * @param output output unit & value
+	 * @param input  input unit &amp; value
+	 * @param output output unit &amp; value
 	 * @return unit conversion record
 	 * @since v0.4.0
 	 * @since 2022-04-09
@@ -48,8 +48,8 @@ public final class UnitConversionRecord {
 	/**
 	 * Gets a {@code UnitConversionRecord} from two unit values
 	 *
-	 * @param input  input unit & value
-	 * @param output output unit & value
+	 * @param input  input unit &amp; value
+	 * @param output output unit &amp; value
 	 * @return unit conversion record
 	 * @since v0.4.0
 	 * @since 2022-04-09
diff --git a/src/main/java/sevenUnitsGUI/UnitConversionView.java b/src/main/java/sevenUnitsGUI/UnitConversionView.java
index b9077f7..e3fb28f 100644
--- a/src/main/java/sevenUnitsGUI/UnitConversionView.java
+++ b/src/main/java/sevenUnitsGUI/UnitConversionView.java
@@ -111,8 +111,7 @@ public interface UnitConversionView extends View {
 	/**
 	 * Shows the output of a unit conversion.
 	 * 
-	 * @param input  input unit & value (obtained from this view)
-	 * @param output output unit & value
+	 * @param uc record of unit conversion
 	 * @since v0.4.0
 	 * @since 2021-12-24
 	 */
diff --git a/src/main/java/sevenUnitsGUI/ViewBot.java b/src/main/java/sevenUnitsGUI/ViewBot.java
index 8fff46d..aea30bb 100644
--- a/src/main/java/sevenUnitsGUI/ViewBot.java
+++ b/src/main/java/sevenUnitsGUI/ViewBot.java
@@ -387,7 +387,7 @@ public final class ViewBot
 	}
 
 	/**
-	 * @param selectedDimension the selectedDimension to set
+	 * @param selectedDimensionName the selectedDimensionName to set
 	 * @since 2022-01-29
 	 */
 	public void setSelectedDimensionName(