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] Add missing JavaDocs (#6125)

Browse Source
This commit is contained in:
Tyler Veness
2024-01-01 22:56:23 -08:00
committed by GitHub
parent 5579219716
commit ad0859a8c9
137 changed files with 1202 additions and 204 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
wpimath/src/main/native/include/frc/controller/ControlAffinePlantInversionFeedforward.h
View File

@@ -34,8 +34,8 @@ namespace frc {
* For more on the underlying math, read
* https://file.tavsys.net/control/controls-engineering-in-frc.pdf.
*
* @tparam States The number of states.
* @tparam Inputs the number of inputs.
* @tparam States Number of states.
* @tparam Inputs Number of inputs.
*/
template <int States, int Inputs>
class ControlAffinePlantInversionFeedforward {

3
wpimath/src/main/native/include/frc/controller/ImplicitModelFollower.h
View File

@@ -24,6 +24,9 @@ namespace frc {
*
* For more on the underlying math, read appendix B.3 in
* https://file.tavsys.net/control/controls-engineering-in-frc.pdf.
*
* @tparam States Number of states.
* @tparam Inputs Number of inputs.
*/
template <int States, int Inputs>
class ImplicitModelFollower {

6
wpimath/src/main/native/include/frc/controller/LinearPlantInversionFeedforward.h
View File

@@ -26,8 +26,8 @@ namespace frc {
* For more on the underlying math, read
* https://file.tavsys.net/control/controls-engineering-in-frc.pdf.
*
* @tparam States The number of states.
* @tparam Inputs The number of inputs.
* @tparam States Number of states.
* @tparam Inputs Number of inputs.
*/
template <int States, int Inputs>
class LinearPlantInversionFeedforward {
@@ -38,7 +38,7 @@ class LinearPlantInversionFeedforward {
/**
* Constructs a feedforward with the given plant.
*
* @tparam Outputs The number of outputs.
* @tparam Outputs Number of outputs.
* @param plant The plant being controlled.
* @param dt Discretization timestep.
*/

1
wpimath/src/main/native/include/frc/controller/LinearQuadraticRegulator.h
View File

@@ -40,6 +40,7 @@ class LinearQuadraticRegulator {
* https://docs.wpilib.org/en/stable/docs/software/advanced-controls/state-space/state-space-intro.html#lqr-tuning
* for how to select the tolerances.
*
* @tparam Outputs Number of outputs.
* @param plant The plant being controlled.
* @param Qelems The maximum desired error tolerance for each state.
* @param Relems The maximum desired control effort for each input.