Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-07-01 02:41:48 +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

17
wpilibj/src/main/java/edu/wpi/first/wpilibj/livewindow/LiveWindow.java
View File

@@ -57,12 +57,17 @@ public class LiveWindow {
}
/**
* Set the enabled state of LiveWindow. If it's being enabled, turn off the scheduler and remove
* all the commands from the queue and enable all the components registered for LiveWindow. If
* it's being disabled, stop all the registered components and reenable the scheduler. TODO: add
* code to disable PID loops when enabling LiveWindow. The commands should reenable the PID loops
* themselves when they get rescheduled. This prevents arms from starting to move around, etc.
* after a period of adjusting them in LiveWindow mode.
* Set the enabled state of LiveWindow.
*
* <p>If it's being enabled, turn off the scheduler and remove all the commands from the queue and
* enable all the components registered for LiveWindow. If it's being disabled, stop all the
* registered components and reenable the scheduler.
*
* <p>TODO: add code to disable PID loops when enabling LiveWindow. The commands should reenable
* the PID loops themselves when they get rescheduled. This prevents arms from starting to move
* around, etc. after a period of adjusting them in LiveWindow mode.
*
* @param enabled True to enable LiveWindow.
*/
public static synchronized void setEnabled(boolean enabled) {
if (liveWindowEnabled != enabled) {