From e1b63a4a74cf11f1de0c3f792529ff298555d050 Mon Sep 17 00:00:00 2001 From: Johannes Mockenhaupt Date: Wed, 26 Jul 2017 15:50:07 +0200 Subject: [PATCH] Command doc. --- .../java/de/jotomo/ruffyscripter/commands/Command.java | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/app/src/main/java/de/jotomo/ruffyscripter/commands/Command.java b/app/src/main/java/de/jotomo/ruffyscripter/commands/Command.java index c18ce48c07..33d10fc223 100644 --- a/app/src/main/java/de/jotomo/ruffyscripter/commands/Command.java +++ b/app/src/main/java/de/jotomo/ruffyscripter/commands/Command.java @@ -5,6 +5,13 @@ import java.util.List; import de.jotomo.ruffyscripter.PumpState; import de.jotomo.ruffyscripter.RuffyScripter; +/** + * Interface for all commands to be executed by the pump. + * + * Note on cammond methods and timing: a method shall wait before and after executing + * as necessary to not cause timing issues, so the caller can just call methods in + * sequence, letting the methods take care of waits. + */ public interface Command { CommandResult execute(RuffyScripter ruffyScripter, PumpState initialPumpState); List validateArguments();