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

[wpimath] Fix API docs for DCMotorSim and LinearSystemId (#6904)

Browse Source
This commit is contained in:
Gold856
2024-08-01 19:41:57 -04:00
committed by GitHub
parent ad45dc89ef
commit 2fc55b86a2
3 changed files with 11 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
wpilibc/src/main/native/include/frc/simulation/DCMotorSim.h
View File

@@ -22,8 +22,9 @@ class DCMotorSim : public LinearSystemSim<2, 1, 2> {
* Creates a simulated DC motor mechanism.
*
* @param plant The linear system representing the DC motor. This
* system can be created with
* LinearSystemId::DCMotorSystem().
* system can be created with LinearSystemId::DCMotorSystem(). If
* LinearSystemId::DCMotorSystem(kV, kA) is used, the distance unit must be
* radians.
* @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