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

[docs] Add wpiunits to JavaDocs (#5793)

Browse Source 
Co-authored-by: Sam Carlberg <sam.carlberg@gmail.com>
This commit is contained in:
Tyler Veness
2023-10-20 18:14:14 -07:00
committed by GitHub
parent 25dad5a531
commit bee32f080e
11 changed files with 120 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
wpiunits/src/main/java/edu/wpi/first/units/Units.java
View File

@@ -126,6 +126,7 @@ public final class Units {
* @param baseUnit the unit being derived from. This does not have to be the base unit of measure
* @param name the name of the new derived unit
* @param symbol the symbol of the new derived unit
* @return the milli-unit
*/
@SuppressWarnings({"PMD.MethodName", "checkstyle:methodname"})
public static <U extends Unit<U>> U Milli(Unit<U> baseUnit, String name, String symbol) {
@@ -137,6 +138,7 @@ public final class Units {
*
* @param <U> the type of the unit
* @param baseUnit the unit being derived from. This does not have to be the base unit of measure
* @return the milli-unit
*/
@SuppressWarnings({"PMD.MethodName", "checkstyle:methodname"})
public static <U extends Unit<U>> U Milli(Unit<U> baseUnit) {
@@ -152,6 +154,7 @@ public final class Units {
* @param baseUnit the unit being derived from. This does not have to be the base unit of measure
* @param name the name of the new derived unit
* @param symbol the symbol of the new derived unit
* @return the micro-unit
*/
@SuppressWarnings({"PMD.MethodName", "checkstyle:methodname"})
public static <U extends Unit<U>> U Micro(Unit<U> baseUnit, String name, String symbol) {
@@ -163,6 +166,7 @@ public final class Units {
*
* @param <U> the type of the unit
* @param baseUnit the unit being derived from. This does not have to be the base unit of measure
* @return the micro-unit
*/
@SuppressWarnings({"PMD.MethodName", "checkstyle:methodname"})
public static <U extends Unit<U>> U Micro(Unit<U> baseUnit) {
@@ -177,6 +181,7 @@ public final class Units {
* @param baseUnit the unit being derived from. This does not have to be the base unit of measure
* @param name the name of the new derived unit
* @param symbol the symbol of the new derived unit
* @return the kilo-unit
*/
@SuppressWarnings({"PMD.MethodName", "checkstyle:methodname"})
public static <U extends Unit<U>> U Kilo(Unit<U> baseUnit, String name, String symbol) {
@@ -188,6 +193,7 @@ public final class Units {
*
* @param <U> the type of the unit
* @param baseUnit the unit being derived from. This does not have to be the base unit of measure
* @return the kilo-unit
*/
@SuppressWarnings({"PMD.MethodName", "checkstyle:methodname"})
public static <U extends Unit<U>> U Kilo(Unit<U> baseUnit) {