From 8e613844ae19a4dea2089ac34c1f0ae650eaeae7 Mon Sep 17 00:00:00 2001
From: Adrien Hopkins <adrien.p.hopkins@gmail.com>
Date: Sat, 13 Apr 2019 10:05:08 -0400
Subject: The dimension selector now loads dimensions from a file.

The dimension selector does nothing, as its purpose is to filter a
list which does not exist yet, but it does correctly load the options.
---
 src/org/unitConverter/unit/LinearUnit.java | 10 ++++++++++
 1 file changed, 10 insertions(+)

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

diff --git a/src/org/unitConverter/unit/LinearUnit.java b/src/org/unitConverter/unit/LinearUnit.java
index c755f79..5b2680b 100644
--- a/src/org/unitConverter/unit/LinearUnit.java
+++ b/src/org/unitConverter/unit/LinearUnit.java
@@ -23,6 +23,16 @@ import org.unitConverter.math.DecimalComparison;
 
 /**
  * A unit that is equal to a certain number multiplied by its base.
+ * <p>
+ * {@code LinearUnit} does not have any public constructors or static factories. In order to obtain a {@code LinearUnit}
+ * instance, multiply its base by the conversion factor. Example:
+ * 
+ * <pre>
+ * LinearUnit foot = METRE.times(0.3048);
+ * </pre>
+ * 
+ * (where {@code METRE} is a {@code BaseUnit} instance)
+ * </p>
  * 
  * @author Adrien Hopkins
  * @since 2018-12-22
-- 
cgit v1.2.3