[wpimath] Better document trackwidth parameters (NFC) (#4324)

This commit is contained in:
Tyler Veness
2022-07-01 06:42:49 -07:00
committed by GitHub
parent 5eb44e22a9
commit 82fac41244
4 changed files with 36 additions and 24 deletions

View File

@@ -35,8 +35,9 @@ class WPILIB_DLLEXPORT LTVDifferentialDriveController {
/**
* Constructs a linear time-varying differential drive controller.
*
* @param plant The drivetrain velocity plant.
* @param trackwidth The drivetrain's trackwidth.
* @param plant The differential drive velocity plant.
* @param trackwidth The distance between the differential drive's left and
* right wheels.
* @param Qelems The maximum desired error tolerance for each state.
* @param Relems The maximum desired control effort for each input.
* @param dt Discretization timestep.