Bumped version number to 0.4.0b1 & added @sincev0.4.0b1

8 files changed, 60 insertions, 1 deletions

diff --git a/src/main/java/sevenUnitsGUI/ExpressionConversionView.java b/src/main/java/sevenUnitsGUI/ExpressionConversionView.java
index 872ca10..5c39788 100644
--- a/src/main/java/sevenUnitsGUI/ExpressionConversionView.java
+++ b/src/main/java/sevenUnitsGUI/ExpressionConversionView.java
@@ -20,17 +20,20 @@ package sevenUnitsGUI;
  * A View that can convert unit expressions
  * 
  * @author Adrien Hopkins
+ * @since v0.4.0
  * @since 2021-12-15
  */
 public interface ExpressionConversionView extends View {
 	/**
 	 * @return unit expression to convert <em>from</em>
+	 * @since v0.4.0
 	 * @since 2021-12-15
 	 */
 	String getFromExpression();
 	
 	/**
 	 * @return unit expression to convert <em>to</em>
+	 * @since v0.4.0
 	 * @since 2021-12-15
 	 */
 	String getToExpression();
@@ -39,6 +42,7 @@ public interface ExpressionConversionView extends View {
 	 * Shows the output of an expression conversion to the user.
 	 * 
 	 * @param uc unit conversion to show
+	 * @since v0.4.0
 	 * @since 2021-12-15
 	 */
 	void showExpressionConversionOutput(UnitConversionRecord uc);
diff --git a/src/main/java/sevenUnitsGUI/Main.java b/src/main/java/sevenUnitsGUI/Main.java
index b5a896f..998b373 100644
--- a/src/main/java/sevenUnitsGUI/Main.java
+++ b/src/main/java/sevenUnitsGUI/Main.java
@@ -19,12 +19,16 @@ package sevenUnitsGUI;
 /**
  * The main code for the 7Units GUI
  *
+ * @since v0.4.0
  * @since 2022-04-19
  */
 public final class Main {
 	
 	/**
-	 * @param args
+	 * The main method that starts 7Units
+	 *
+	 * @param args commandline arguments
+	 * @since v0.4.0
 	 * @since 2022-04-19
 	 */
 	public static void main(String[] args) {
diff --git a/src/main/java/sevenUnitsGUI/PrefixSearchRule.java b/src/main/java/sevenUnitsGUI/PrefixSearchRule.java
index 2928082..87f14a8 100644
--- a/src/main/java/sevenUnitsGUI/PrefixSearchRule.java
+++ b/src/main/java/sevenUnitsGUI/PrefixSearchRule.java
@@ -33,24 +33,31 @@ import sevenUnits.unit.UnitPrefix;
  * A search rule that applies a certain set of prefixes to a unit. It always
  * includes the original unit in the output map.
  *
+ * @since v0.4.0
  * @since 2022-07-06
  */
 public final class PrefixSearchRule implements
 		Function<Map.Entry<String, LinearUnit>, Map<String, LinearUnit>> {
 	/**
 	 * A rule that does not add any prefixed versions of units.
+	 *
+	 * @since v0.4.0
 	 */
 	public static final PrefixSearchRule NO_PREFIXES = getUniversalRule(
 			Set.of());
 	
 	/**
 	 * A rule that gives every unit a common set of prefixes.
+	 *
+	 * @since v0.4.0
 	 */
 	public static final PrefixSearchRule COMMON_PREFIXES = getCoherentOnlyRule(
 			Set.of(Metric.MILLI, Metric.KILO));
 	
 	/**
 	 * A rule that gives every unit all metric prefixes.
+	 *
+	 * @since v0.4.0
 	 */
 	public static final PrefixSearchRule ALL_METRIC_PREFIXES = getCoherentOnlyRule(
 			Metric.ALL_PREFIXES);
@@ -62,6 +69,7 @@ public final class PrefixSearchRule implements
 	 *
 	 * @param prefixes prefixes to apply
 	 * @return prefix rule
+	 * @since v0.4.0
 	 * @since 2022-07-06
 	 */
 	public static final PrefixSearchRule getCoherentOnlyRule(
@@ -75,6 +83,7 @@ public final class PrefixSearchRule implements
 	 *
 	 * @param prefixes prefixes to apply
 	 * @return prefix rule
+	 * @since v0.4.0
 	 * @since 2022-07-06
 	 */
 	public static final PrefixSearchRule getUniversalRule(
@@ -95,6 +104,7 @@ public final class PrefixSearchRule implements
 	/**
 	 * @param prefixes
 	 * @param metricOnly
+	 * @since v0.4.0
 	 * @since 2022-07-06
 	 */
 	public PrefixSearchRule(Set<UnitPrefix> prefixes,
@@ -140,6 +150,7 @@ public final class PrefixSearchRule implements
 	
 	/**
 	 * @return the allowUnit
+	 * @since v0.4.0
 	 * @since 2022-07-06
 	 */
 	public Predicate<LinearUnit> getAllowUnit() {
@@ -148,6 +159,7 @@ public final class PrefixSearchRule implements
 	
 	/**
 	 * @return the prefixes that are applied by this rule
+	 * @since v0.4.0
 	 * @since 2022-07-06
 	 */
 	public Set<UnitPrefix> getPrefixes() {
diff --git a/src/main/java/sevenUnitsGUI/StandardDisplayRules.java b/src/main/java/sevenUnitsGUI/StandardDisplayRules.java
index 0c0ba8e..cc69d31 100644
--- a/src/main/java/sevenUnitsGUI/StandardDisplayRules.java
+++ b/src/main/java/sevenUnitsGUI/StandardDisplayRules.java
@@ -28,12 +28,14 @@ import sevenUnits.utils.UncertainDouble;
  * A static utility class that can be used to make display rules for the
  * presenter.
  *
+ * @since v0.4.0
  * @since 2022-04-18
  */
 public final class StandardDisplayRules {
 	/**
 	 * A rule that rounds to a fixed number of decimal places.
 	 *
+	 * @since v0.4.0
 	 * @since 2022-04-18
 	 */
 	public static final class FixedDecimals
@@ -94,6 +96,7 @@ public final class StandardDisplayRules {
 	/**
 	 * A rule that rounds to a fixed number of significant digits.
 	 *
+	 * @since v0.4.0
 	 * @since 2022-04-18
 	 */
 	public static final class FixedPrecision
@@ -162,6 +165,7 @@ public final class StandardDisplayRules {
 	 * This means the output will have around as many significant figures as the
 	 * input.
 	 *
+	 * @since v0.4.0
 	 * @since 2022-04-18
 	 */
 	public static final class UncertaintyBased
@@ -188,6 +192,7 @@ public final class StandardDisplayRules {
 	/**
 	 * @param decimalPlaces decimal places to round to
 	 * @return a rounding rule that rounds to fixed number of decimal places
+	 * @since v0.4.0
 	 * @since 2022-04-18
 	 */
 	public static final FixedDecimals fixedDecimals(int decimalPlaces) {
@@ -198,6 +203,7 @@ public final class StandardDisplayRules {
 	 * @param significantFigures significant figures to round to
 	 * @return a rounding rule that rounds to a fixed number of significant
 	 *         figures
+	 * @since v0.4.0
 	 * @since 2022-04-18
 	 */
 	public static final FixedPrecision fixedPrecision(int significantFigures) {
@@ -211,6 +217,7 @@ public final class StandardDisplayRules {
 	 * @return display rule
 	 * @throws IllegalArgumentException if the provided string is not that of a
 	 *                                  standard rule.
+	 * @since v0.4.0
 	 * @since 2021-12-24
 	 */
 	public static final Function<UncertainDouble, String> getStandardRule(
@@ -236,6 +243,7 @@ public final class StandardDisplayRules {
 	
 	/**
 	 * @return an UncertainDouble-based rounding rule
+	 * @since v0.4.0
 	 * @since 2022-04-18
 	 */
 	public static final UncertaintyBased uncertaintyBased() {
diff --git a/src/main/java/sevenUnitsGUI/UnitConversionRecord.java b/src/main/java/sevenUnitsGUI/UnitConversionRecord.java
index f951f44..fa64ee9 100644
--- a/src/main/java/sevenUnitsGUI/UnitConversionRecord.java
+++ b/src/main/java/sevenUnitsGUI/UnitConversionRecord.java
@@ -24,6 +24,7 @@ import sevenUnits.unit.UnitValue;
 /**
  * A record of a conversion between units or expressions
  *
+ * @since v0.4.0
  * @since 2022-04-09
  */
 public final class UnitConversionRecord {
@@ -33,6 +34,7 @@ public final class UnitConversionRecord {
 	 * @param input  input unit & value
 	 * @param output output unit & value
 	 * @return unit conversion record
+	 * @since v0.4.0
 	 * @since 2022-04-09
 	 */
 	public static UnitConversionRecord fromLinearValues(LinearUnitValue input,
@@ -49,6 +51,7 @@ public final class UnitConversionRecord {
 	 * @param input  input unit & value
 	 * @param output output unit & value
 	 * @return unit conversion record
+	 * @since v0.4.0
 	 * @since 2022-04-09
 	 */
 	public static UnitConversionRecord fromValues(UnitValue input,
@@ -67,6 +70,7 @@ public final class UnitConversionRecord {
 	 * @param inputValueString  string representing input value
 	 * @param outputValueString string representing output value
 	 * @return unit conversion record
+	 * @since v0.4.0
 	 * @since 2022-04-09
 	 */
 	public static UnitConversionRecord valueOf(String fromName, String toName,
@@ -143,6 +147,7 @@ public final class UnitConversionRecord {
 	
 	/**
 	 * @return name of unit or expression that was converted from
+	 * @since v0.4.0
 	 * @since 2022-04-09
 	 */
 	public String fromName() {
@@ -166,6 +171,7 @@ public final class UnitConversionRecord {
 	
 	/**
 	 * @return string representing input value
+	 * @since v0.4.0
 	 * @since 2022-04-09
 	 */
 	public String inputValueString() {
@@ -174,6 +180,7 @@ public final class UnitConversionRecord {
 	
 	/**
 	 * @return string representing output value
+	 * @since v0.4.0
 	 * @since 2022-04-09
 	 */
 	public String outputValueString() {
@@ -182,6 +189,7 @@ public final class UnitConversionRecord {
 	
 	/**
 	 * @return name of unit or expression that was converted to
+	 * @since v0.4.0
 	 * @since 2022-04-09
 	 */
 	public String toName() {
diff --git a/src/main/java/sevenUnitsGUI/UnitConversionView.java b/src/main/java/sevenUnitsGUI/UnitConversionView.java
index 6a95aa5..0d07823 100644
--- a/src/main/java/sevenUnitsGUI/UnitConversionView.java
+++ b/src/main/java/sevenUnitsGUI/UnitConversionView.java
@@ -23,23 +23,27 @@ import java.util.Set;
  * A View that supports single unit-based conversion
  * 
  * @author Adrien Hopkins
+ * @since v0.4.0
  * @since 2021-12-15
  */
 public interface UnitConversionView extends View {
 	/**
 	 * @return dimensions available for filtering
+	 * @since v0.4.0
 	 * @since 2022-01-29
 	 */
 	Set<String> getDimensionNames();
 	
 	/**
 	 * @return name of unit to convert <em>from</em>
+	 * @since v0.4.0
 	 * @since 2021-12-15
 	 */
 	Optional<String> getFromSelection();
 	
 	/**
 	 * @return list of names of units available to convert from
+	 * @since v0.4.0
 	 * @since 2022-03-30
 	 */
 	Set<String> getFromUnitNames();
@@ -47,24 +51,28 @@ public interface UnitConversionView extends View {
 	/**
 	 * @return value to convert between the units (specifically, the numeric
 	 *         string provided by the user)
+	 * @since v0.4.0
 	 * @since 2021-12-15
 	 */
 	String getInputValue();
 	
 	/**
 	 * @return selected dimension
+	 * @since v0.4.0
 	 * @since 2021-12-15
 	 */
 	Optional<String> getSelectedDimensionName();
 	
 	/**
 	 * @return name of unit to convert <em>to</em>
+	 * @since v0.4.0
 	 * @since 2021-12-15
 	 */
 	Optional<String> getToSelection();
 	
 	/**
 	 * @return list of names of units available to convert to
+	 * @since v0.4.0
 	 * @since 2022-03-30
 	 */
 	Set<String> getToUnitNames();
@@ -73,6 +81,7 @@ public interface UnitConversionView extends View {
 	 * Sets the available dimensions for filtering.
 	 *
 	 * @param dimensionNames names of dimensions to use
+	 * @since v0.4.0
 	 * @since 2021-12-15
 	 */
 	void setDimensionNames(Set<String> dimensionNames);
@@ -83,6 +92,7 @@ public interface UnitConversionView extends View {
 	 * that allow the user to select units from a list.
 	 *
 	 * @param unitNames names of units to convert from
+	 * @since v0.4.0
 	 * @since 2021-12-15
 	 */
 	void setFromUnitNames(Set<String> unitNames);
@@ -93,6 +103,7 @@ public interface UnitConversionView extends View {
 	 * that allow the user to select units from a list.
 	 *
 	 * @param unitNames names of units to convert to
+	 * @since v0.4.0
 	 * @since 2021-12-15
 	 */
 	void setToUnitNames(Set<String> unitNames);
@@ -102,6 +113,7 @@ public interface UnitConversionView extends View {
 	 * 
 	 * @param input  input unit & value (obtained from this view)
 	 * @param output output unit & value
+	 * @since v0.4.0
 	 * @since 2021-12-24
 	 */
 	void showUnitConversionOutput(UnitConversionRecord uc);
diff --git a/src/main/java/sevenUnitsGUI/View.java b/src/main/java/sevenUnitsGUI/View.java
index b2d2b94..bb810ec 100644
--- a/src/main/java/sevenUnitsGUI/View.java
+++ b/src/main/java/sevenUnitsGUI/View.java
@@ -26,11 +26,13 @@ import sevenUnits.utils.NameSymbol;
  * An object that controls user interaction with 7Units
  * 
  * @author Adrien Hopkins
+ * @since v0.4.0
  * @since 2021-12-15
  */
 public interface View {
 	/**
 	 * @return a new tabbed view
+	 * @since v0.4.0
 	 * @since 2022-04-19
 	 */
 	static View createTabbedView() {
@@ -39,18 +41,21 @@ public interface View {
 	
 	/**
 	 * @return the presenter associated with this view
+	 * @since v0.4.0
 	 * @since 2022-04-19
 	 */
 	Presenter getPresenter();
 	
 	/**
 	 * @return name of prefix currently being viewed
+	 * @since v0.4.0
 	 * @since 2022-04-10
 	 */
 	Optional<String> getViewedPrefixName();
 	
 	/**
 	 * @return name of unit currently being viewed
+	 * @since v0.4.0
 	 * @since 2022-04-10
 	 */
 	Optional<String> getViewedUnitName();
@@ -60,6 +65,7 @@ public interface View {
 	 * viewer
 	 *
 	 * @param prefixNames prefix names to view
+	 * @since v0.4.0
 	 * @since 2022-04-10
 	 */
 	void setViewablePrefixNames(Set<String> prefixNames);
@@ -68,6 +74,7 @@ public interface View {
 	 * Sets the list of units that are available to be viewed in a unit viewer
 	 *
 	 * @param unitNames unit names to view
+	 * @since v0.4.0
 	 * @since 2022-04-10
 	 */
 	void setViewableUnitNames(Set<String> unitNames);
@@ -78,6 +85,7 @@ public interface View {
 	 * @param title   title of error message; on any view that uses an error
 	 *                dialog, this should be the title of the error dialog.
 	 * @param message error message
+	 * @since v0.4.0
 	 * @since 2021-12-15
 	 */
 	void showErrorMessage(String title, String message);
@@ -87,6 +95,7 @@ public interface View {
 	 *
 	 * @param name             name(s) and symbol of prefix
 	 * @param multiplierString string representation of prefix multiplier
+	 * @since v0.4.0
 	 * @since 2022-04-10
 	 */
 	void showPrefix(NameSymbol name, String multiplierString);
@@ -98,6 +107,7 @@ public interface View {
 	 * @param definition    unit's definition string
 	 * @param dimensionName name of unit's dimension
 	 * @param type          type of unit (metric/semi-metric/non-metric)
+	 * @since v0.4.0
 	 * @since 2022-04-10
 	 */
 	void showUnit(NameSymbol name, String definition, String dimensionName,
diff --git a/src/main/java/sevenUnitsGUI/ViewBot.java b/src/main/java/sevenUnitsGUI/ViewBot.java
index a3ba7a2..e7304c4 100644
--- a/src/main/java/sevenUnitsGUI/ViewBot.java
+++ b/src/main/java/sevenUnitsGUI/ViewBot.java
@@ -32,6 +32,7 @@ import sevenUnits.utils.Nameable;
  * for testing. Getters and setters work as expected.
  * 
  * @author Adrien Hopkins
+ * @since v0.4.0
  * @since 2022-01-29
  */
 public final class ViewBot