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

PIDController: Mention unit for 'period' (#1305)

Browse Source
This commit is contained in:
Kay Kasemir
2018-09-12 00:38:19 -04:00
committed by Peter Johnson
parent 025af24523
commit 59700882f1
2 changed files with 20 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
wpilibj/src/main/java/edu/wpi/first/wpilibj/PIDController.java
View File

@@ -31,8 +31,10 @@ public class PIDController extends PIDBase implements Controller {
* @param Kf the feed forward term
* @param source The PIDSource object that is used to get values
* @param output The PIDOutput object that is set to the output percentage
* @param period the loop time for doing calculations. This particularly effects calculations of
* the integral and differential terms. The default is 50ms.
* @param period the loop time for doing calculations in seconds.
* This particularly affects calculations of
* the integral and differential terms.
* The default is 0.05 (50ms).
*/
@SuppressWarnings("ParameterName")
public PIDController(double Kp, double Ki, double Kd, double Kf, PIDSource source,
@@ -49,8 +51,10 @@ public class PIDController extends PIDBase implements Controller {
* @param Kd the derivative coefficient
* @param source the PIDSource object that is used to get values
* @param output the PIDOutput object that is set to the output percentage
* @param period the loop time for doing calculations. This particularly effects calculations of
* the integral and differential terms. The default is 50ms.
* @param period the loop time for doing calculations in seconds.
* This particularly affects calculations of
* the integral and differential terms.
* The default is 0.05 (50ms).
*/
@SuppressWarnings("ParameterName")
public PIDController(double Kp, double Ki, double Kd, PIDSource source, PIDOutput output,