[wpilib] Document how to create LinearSystem object for physics sim classes (NFC) (#5488)

Fixes #4372.
This commit is contained in:
Tyler Veness
2023-07-31 19:18:17 -07:00
committed by GitHub
parent a01b6467d3
commit 6aa469ae45
10 changed files with 38 additions and 18 deletions

View File

@@ -21,7 +21,9 @@ class DCMotorSim : public LinearSystemSim<2, 1, 2> {
/**
* Creates a simulated DC motor mechanism.
*
* @param plant The linear system representing the DC motor.
* @param plant The linear system representing the DC motor. This
* system can be created with
* LinearSystemId::DCMotorSystem().
* @param gearbox The type of and number of motors in the DC motor
* gearbox.
* @param gearing The gearing of the DC motor (numbers greater than