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

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

@@ -97,7 +97,7 @@ class ControlAffinePlantInversionFeedforward {
/**
* Returns an element of the previously calculated feedforward.
*
* @param row Row of uff.
* @param i Row of uff.
*
* @return The row of the calculated feedforward.
*/

2
wpimath/src/main/native/include/frc/controller/HolonomicDriveController.h
View File

@@ -54,7 +54,7 @@ class WPILIB_DLLEXPORT HolonomicDriveController {
* Sets the pose error which is considered tolerable for use with
* AtReference().
*
* @param poseTolerance Pose error which is tolerable.
* @param tolerance Pose error which is tolerable.
*/
void SetTolerance(const Pose2d& tolerance);

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

@@ -31,8 +31,8 @@ class LinearPlantInversionFeedforward {
/**
* Constructs a feedforward with the given plant.
*
* @param plant The plant being controlled.
* @param dtSeconds Discretization timestep.
* @param plant The plant being controlled.
* @param dt Discretization timestep.
*/
template <int Outputs>
LinearPlantInversionFeedforward(
@@ -42,9 +42,9 @@ class LinearPlantInversionFeedforward {
/**
* Constructs a feedforward with the given coefficients.
*
* @param A Continuous system matrix of the plant being controlled.
* @param B Continuous input matrix of the plant being controlled.
* @param dtSeconds Discretization timestep.
* @param A Continuous system matrix of the plant being controlled.
* @param B Continuous input matrix of the plant being controlled.
* @param dt Discretization timestep.
*/
LinearPlantInversionFeedforward(
const Eigen::Matrix<double, States, States>& A,
@@ -64,7 +64,7 @@ class LinearPlantInversionFeedforward {
/**
* Returns an element of the previously calculated feedforward.
*
* @param row Row of uff.
* @param i Row of uff.
*
* @return The row of the calculated feedforward.
*/

2
wpimath/src/main/native/include/frc/controller/PIDController.h
View File

@@ -159,7 +159,7 @@ class WPILIB_DLLEXPORT PIDController
* Sets the error which is considered tolerable for use with AtSetpoint().
*
* @param positionTolerance Position error which is tolerable.
* @param velociytTolerance Velocity error which is tolerable.
* @param velocityTolerance Velocity error which is tolerable.
*/
void SetTolerance(
double positionTolerance,