ELEC2645 (2018/19) / Mbed 2 deprecated ll16o2l_ELEC2645

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed Gamepad

Diff: Instuctions/Instruction.h

Revision:
15:807eba7c7811
Parent:
13:700ea0742b24
Child:
18:6ef07bf7770a
--- a/Instuctions/Instruction.h	Sun May 05 11:25:08 2019 +0000
+++ b/Instuctions/Instruction.h	Tue May 07 18:01:54 2019 +0000
@@ -5,22 +5,44 @@
 #include "N5110.h"
 #include "Gamepad.h"
 
-/** Instruction Class
-* @author Oliver Luong, University of Leeds
-* @brief Controls the functionality of the Dodge game 
-* @date 05/05/2019
+/** Health_Kit Class
+
+@brief Stores the instruction message and then writes it to the LCD.
+
+@brief Revisions 1.0
+
+
+@author Oliver Luong, University of Leeds
+@date 06/05/2019
 */ 
+
 class Instruction
 {
 public:
+    /** Contructor / Destructor */
     Instruction();
     ~Instruction();
+    
+// Methods
+    /**
+    This method will be used to initialise the value y.
+    */
     void init();
+    
+    /**
+    This method will be used to read the jostick and then to change the value of y.
+    */
     void write(N5110 &lcd);
+    
+    /**
+    This method will be used to write to the lcd.
+    */
     void control(Gamepad &pad);
     
 private:
     Direction d;
+    
+// Variables
     int y;
     int max_length;