From d705a990117cab866a32a57b03c1adb3ab62594a Mon Sep 17 00:00:00 2001 From: Blizzard Finnegan Date: Tue, 28 Feb 2023 11:29:02 -0500 Subject: [PATCH] Add explanation in function comments --- src/main/java/org/baxter/disco/ocr/MovementFacade.java | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/main/java/org/baxter/disco/ocr/MovementFacade.java b/src/main/java/org/baxter/disco/ocr/MovementFacade.java index 52dcd83..c959c9e 100644 --- a/src/main/java/org/baxter/disco/ocr/MovementFacade.java +++ b/src/main/java/org/baxter/disco/ocr/MovementFacade.java @@ -397,7 +397,9 @@ public class MovementFacade 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 timeout How long (in seconds) to wait before timing out.