Add explanation in function comments

This commit is contained in:
Blizzard Finnegan 2023-02-28 11:29:02 -05:00
parent 7b38d83366
commit d705a99011
No known key found for this signature in database
GPG key ID: DE547EDF547DDA49

View file

@ -397,7 +397,9 @@ public class MovementFacade
public int getFrequency() { return FREQUENCY; } public int getFrequency() { return FREQUENCY; }
/** /**
* Internal function to send the fixture to one limit switch or another. * Internal function to send the fixture to a given limit switch.
*
* Motor slows down after timeout is halfway through, to protect hardware.
* *
* @param moveUp Whether to send the fixture up or down. (True = up, False = down) * @param moveUp Whether to send the fixture up or down. (True = up, False = down)
* @param timeout How long (in seconds) to wait before timing out. * @param timeout How long (in seconds) to wait before timing out.