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

[docs] Fix Doxygen warnings, add CI docs lint job (#3639)

Browse Source 
The CI docs lint build is configured to fail on Doxygen warnings.
This commit is contained in:
Tyler Veness
2021-10-14 18:09:38 -07:00
committed by GitHub
parent 4ad3a54026
commit 4647d09b50
125 changed files with 1723 additions and 1131 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
wpimath/src/main/native/include/frc/system/LinearSystem.h
View File

@@ -106,9 +106,9 @@ class LinearSystem {
* This is used by state observers directly to run updates based on state
* estimate.
*
* @param x The current state.
* @param u The control input.
* @param dt Timestep for model update.
* @param x The current state.
* @param clampedU The control input.
* @param dt Timestep for model update.
*/
Eigen::Vector<double, States> CalculateX(
const Eigen::Vector<double, States>& x,

1
wpimath/src/main/native/include/frc/system/LinearSystemLoop.h
View File

@@ -37,6 +37,7 @@ class LinearSystemLoop {
* call reset with the initial system state before enabling the loop. This
* constructor assumes that the input(s) to this system are voltage.
*
* @param plant State-space plant.
* @param controller State-space controller.
* @param observer State-space observer.
* @param maxVoltage The maximum voltage that can be applied. Commonly 12.