Diff: GCHeatControl.cpp

Revision:

1:a5258871b33d

Parent:

0:47c880c1463d

--- a/GCHeatControl.cpp	Wed Jan 13 13:17:05 2016 +0000
+++ b/GCHeatControl.cpp	Thu Jul 20 08:42:29 2017 +0000
@@ -1,8 +1,20 @@
 #include "GCHeatControl.h"
 
+/*
+    A class to 'encapsulate' the heat control on the GC
+    
+    Requires a pointer to the USBHostGC instance that corresponds to the GC,
+             a pointer to the USBDeviceConnected instance that (also) corresponds to the GC
+
+*/
+
+// Defined in main.cpp
 extern void EasyGUIDebugPrint(char *stuffToPrint, short X, short Y);
 
     
+/*
+    Constructor - passed the USBHostGC and USBDeviceConnected instances for the GC
+*/    
 GCHeatControl::GCHeatControl(USBDeviceConnected* newUsbDevice, USBHostGC* newUsbHostGC)
 {
     usbDevice = newUsbDevice;
@@ -13,6 +25,11 @@
 #endif
 }
 
+/*
+    Tells the caller if the heat is currently on.
+    
+    Returns true if it is on, false if not.
+*/
 bool GCHeatControl::IsHeatOn(void)
 {
 #ifdef DEBUG_TEST
@@ -32,6 +49,11 @@
 #endif
 }
         
+/*
+    Turns the heat on. Returns true if this was successful, false if not.
+    
+    Note that it will return false if the heat is already on.
+*/      
 bool GCHeatControl::TurnHeatOn(void)
 {
 #ifdef DEBUG_TEST
@@ -63,6 +85,11 @@
 #endif
 }
     
+/*
+    Turns the heat off. Returns true if this was successful, false if not.
+    
+    Note that it will return false if the heat is already off.
+*/      
 bool GCHeatControl::TurnHeatOff(void)
 {
 #ifdef DEBUG_TEST