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

Fix documentation warnings generated by JavaDoc (NFC) (#3428)

Browse Source 
Some C++ Doxygen comments were updated to reflect any wording changes.

See `rg "(@return|@param \w+) TODO" | less` for list of incomplete docs.
This commit is contained in:
Tyler Veness
2021-06-10 20:46:47 -07:00
committed by GitHub
parent 9e1b7e0464
commit 4d9ff76433
108 changed files with 1113 additions and 429 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/PIDBase.java
View File

@@ -307,6 +307,8 @@ public class PIDBase implements PIDInterface, PIDOutput, Sendable, AutoCloseable
* setpoint for the output. If a position PID controller is being used, the F term should be set
* to 1 over the maximum speed for the output measured in setpoint units per this controller's
* update period (see the default period in this class's constructor).
*
* @return The feedforward value.
*/
protected double calculateFeedForward() {
if (m_pidInput.getPIDSourceType().equals(PIDSourceType.kRate)) {

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

@@ -137,7 +137,11 @@ public class PIDController extends PIDBase implements Controller {
}
}
/** Set the enabled state of the PIDController. */
/**
* Set the enabled state of the PIDController.
*
* @param enable True to enable the PIDController.
*/
public void setEnabled(boolean enable) {
if (enable) {
enable();
@@ -146,7 +150,11 @@ public class PIDController extends PIDBase implements Controller {
}
}
/** Return true if PIDController is enabled. */
/**
* Return true if PIDController is enabled.
*
* @return True if PIDController is enabled.
*/
public boolean isEnabled() {
m_thisMutex.lock();
try {