diff options
author | Adrien Hopkins <adrien.p.hopkins@gmail.com> | 2019-04-13 10:05:08 -0400 |
---|---|---|
committer | Adrien Hopkins <adrien.p.hopkins@gmail.com> | 2019-04-13 10:05:08 -0400 |
commit | 8e613844ae19a4dea2089ac34c1f0ae650eaeae7 (patch) | |
tree | 43f3fcf2fc7fafb840156a6fe0a5596ba091a904 /src/org/unitConverter/unit/LinearUnit.java | |
parent | ec036fdad931fbbd7dec28b864150f8668e91b41 (diff) |
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.
Diffstat (limited to 'src/org/unitConverter/unit/LinearUnit.java')
-rw-r--r-- | src/org/unitConverter/unit/LinearUnit.java | 10 |
1 files changed, 10 insertions, 0 deletions
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 |