[wpiunits] Documentation improvements (#5932)

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

View File

@@ -4,6 +4,15 @@
package edu.wpi.first.units;
/**
* Unit of energy dimension.
*
* <p>This is the base type for units of energy dimension. It is also used to specify the dimension
* for {@link Measure}: <code>Measure&lt;Energy&gt;</code>.
*
* <p>Actual units (such as {@link Units#Joules} and {@link Units#Kilojoules}) can be found in the
* {@link Units} class.
*/
public class Energy extends Unit<Energy> {
protected Energy(
UnaryFunction toBaseConverter, UnaryFunction fromBaseConverter, String name, String symbol) {