diff options
author | Adrien Hopkins <adrien.p.hopkins@gmail.com> | 2025-06-04 18:39:03 -0500 |
---|---|---|
committer | Adrien Hopkins <adrien.p.hopkins@gmail.com> | 2025-06-04 18:39:03 -0500 |
commit | 25f972d198e50ad5a54fa175ec39887f02c33fdc (patch) | |
tree | 2807b0ee27a5594f0dfcab421e6840c1270a8e6c /src/main/java/sevenUnits/unit/BritishImperial.java | |
parent | ae0559a9432f85f9147eeb80b35f1b2947889acd (diff) |
Remove most comment warnings
In some cases I've used @SuppressWarnings, which Gradle doesn't seem to
respect, but I've solved all the other ones.
Diffstat (limited to 'src/main/java/sevenUnits/unit/BritishImperial.java')
-rw-r--r-- | src/main/java/sevenUnits/unit/BritishImperial.java | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/src/main/java/sevenUnits/unit/BritishImperial.java b/src/main/java/sevenUnits/unit/BritishImperial.java index 69a3c05..16255da 100644 --- a/src/main/java/sevenUnits/unit/BritishImperial.java +++ b/src/main/java/sevenUnits/unit/BritishImperial.java @@ -24,6 +24,9 @@ import sevenUnits.utils.NameSymbol; * @author Adrien Hopkins * @since 2019-10-21 */ +// this class is just constants, most of which are obvious from the variable name +// so no need to check for missing values +@SuppressWarnings("javadoc") public final class BritishImperial { /** * Imperial units that measure area @@ -55,11 +58,16 @@ public final class BritishImperial { public static final LinearUnit FOOT = YARD.dividedBy(3); public static final LinearUnit INCH = FOOT.dividedBy(12); public static final LinearUnit THOU = INCH.dividedBy(1000); + /** A chain, equal to 22 yards. */ public static final LinearUnit CHAIN = YARD.times(22); + /** A furlong, equal to 10 chains or 220 yards. */ public static final LinearUnit FURLONG = CHAIN.times(10); + /** A mile, equal to 8 furlongs or 1760 yards. */ public static final LinearUnit MILE = FURLONG.times(8); + /** A league, equal to 3 miles. */ public static final LinearUnit LEAGUE = MILE.times(3); + /** A nautical mile, around 1 arcminute around the Earth's circumference. */ public static final LinearUnit NAUTICAL_MILE = Metric.METRE.times(1852); public static final LinearUnit CABLE = NAUTICAL_MILE.dividedBy(10); public static final LinearUnit FATHOM = CABLE.dividedBy(100); |