Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-19 00:41:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

[wpiunits] Documentation improvements (#5932)

Browse Source
This commit is contained in:
Andrew Gasser
2023-11-23 12:57:58 -06:00
committed by GitHub
parent 423fd75fa8
commit 95716eb0cb
18 changed files with 113 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
wpiunits/src/main/java/edu/wpi/first/units/Measure.java
View File

@@ -6,7 +6,7 @@ package edu.wpi.first.units;
/**
* A measure holds the magnitude and unit of some dimension, such as distance, time, or speed. Two
* measures with the same <i>unit</i> and <i>magnitude</i> are effectively the same object.
* measures with the same <i>unit</i> and <i>magnitude</i> are effectively equivalent objects.
*
* @param <U> the unit type of the measure
*/
@@ -371,7 +371,7 @@ public interface Measure<U extends Unit<U>> extends Comparable<Measure<U>> {
/**
* Returns a string representation of this measurement in a longhand form. The name of the backing
* unit is used, rather than its symbol, and the magnitude is represented in a full string, no
* unit is used, rather than its symbol, and the magnitude is represented in a full string, not
* scientific notation. (Very large values may be represented in scientific notation, however)
*
* @return the long form representation of this measurement