From fe3385cce8378a5577bad4eacb14111300eb611c Mon Sep 17 00:00:00 2001
From: Johannes Mockenhaupt <git@jotomo.de>
Date: Wed, 1 Nov 2017 23:54:18 +0100
Subject: [PATCH] Add Javadoc to RuffyCommands.

---
 .../main/java/de/jotomo/ruffy/spi/RuffyCommands.java | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/ruffy-spi/src/main/java/de/jotomo/ruffy/spi/RuffyCommands.java b/ruffy-spi/src/main/java/de/jotomo/ruffy/spi/RuffyCommands.java
index e955e64a0a..5f357afb92 100644
--- a/ruffy-spi/src/main/java/de/jotomo/ruffy/spi/RuffyCommands.java
+++ b/ruffy-spi/src/main/java/de/jotomo/ruffy/spi/RuffyCommands.java
@@ -5,24 +5,34 @@ import java.util.Date;
 import de.jotomo.ruffy.spi.history.PumpHistoryRequest;
 
 public interface RuffyCommands {
+    /** Issues a bolus issues updates on progress through via {@link BolusProgressReporter}. */
     CommandResult deliverBolus(double amount, BolusProgressReporter bolusProgressReporter);
 
+    /** Requests cancellation of an active bolus if possible. */
     void cancelBolus();
 
     CommandResult setTbr(int percent, int duration);
 
     CommandResult cancelTbr();
 
+    /** Confirms an active warning alert on the pump.
+     * @see PumpWarningCodes */
     CommandResult confirmAlert(int warningCode);
 
+    /** Indicate if the pump is ready to receive commands. */
     boolean isPumpAvailable();
 
+    /** Indicate of the pump is busy processing a command. */
     boolean isPumpBusy();
 
+    /** Read the state of the pump, which encompasses all information displayed on the main menu. */
     CommandResult readPumpState();
 
+    /** Read revervoir level and last bolus via Quick Info */
     CommandResult readReservoirLevelAndLastBolus();
 
+    /** Reads pump history via the My Data menu. The {@link PumpHistoryRequest} specifies
+     * what types of data and how far back data is returned. */
     CommandResult readHistory(PumpHistoryRequest request);
 
     CommandResult readBasalProfile(int number);
@@ -33,8 +43,10 @@ public interface RuffyCommands {
 
     CommandResult setDateAndTime(Date date);
 
+    // TODO below methods are drafts
     void requestPairing();
 
+    /** Send the key displayed on the pump during pairing/bonding. */
     void sendAuthKey(String key);
 
     void unpair();