From a966676c629f7f14fcbba82a9ada5e2cbeca8314 Mon Sep 17 00:00:00 2001
From: Adrien Hopkins <masterofnumbers17@gmail.com>
Date: Tue, 26 Nov 2019 15:20:04 -0500
Subject: Updated the documentation of existing classes.

---
 src/org/unitConverter/unit/UnitPrefix.java | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

(limited to 'src/org/unitConverter/unit/UnitPrefix.java')

diff --git a/src/org/unitConverter/unit/UnitPrefix.java b/src/org/unitConverter/unit/UnitPrefix.java
index 514fa1c..360b0c1 100644
--- a/src/org/unitConverter/unit/UnitPrefix.java
+++ b/src/org/unitConverter/unit/UnitPrefix.java
@@ -80,6 +80,11 @@ public final class UnitPrefix {
 		return valueOf(this.getMultiplier() / other.getMultiplier());
 	}
 
+	/**
+	 * {@inheritDoc}
+	 * 
+	 * Uses the prefix's multiplier to determine equality.
+	 */
 	@Override
 	public boolean equals(final Object obj) {
 		if (this == obj)
@@ -92,10 +97,19 @@ public final class UnitPrefix {
 		return DecimalComparison.equals(this.getMultiplier(), other.getMultiplier());
 	}
 
+	/**
+	 * @return prefix's multiplier
+	 * @since 2019-11-26
+	 */
 	public double getMultiplier() {
 		return this.multiplier;
 	}
 
+	/**
+	 * {@inheritDoc}
+	 * 
+	 * Uses the prefix's multiplier to determine a hash code.
+	 */
 	@Override
 	public int hashCode() {
 		return DecimalComparison.hash(this.getMultiplier());
@@ -139,8 +153,11 @@ public final class UnitPrefix {
 		return valueOf(Math.pow(this.getMultiplier(), exponent));
 	}
 
+	/**
+	 * @return a string describing the prefix and its multiplier
+	 */
 	@Override
 	public String toString() {
-		return String.format("Unit prefix equal to %s", this.multiplier);
+		return String.format("Unit prefix with multiplier %s", this.multiplier);
 	}
 }
-- 
cgit v1.2.3