Diff: Leds/LEDs.h

Revision:

12:74f31212292f

Parent:

7:2ce6e90f6d47

Child:

13:28138043b471

--- a/Leds/LEDs.h	Sat Mar 28 10:31:41 2020 +0000
+++ b/Leds/LEDs.h	Sat Mar 28 11:40:28 2020 +0000
@@ -1,3 +1,9 @@
+/** LEDs Class
+* @brief Controls the LEDs on the device
+* @author Henry W Triff
+* @date Mar, 2020
+*/
+
 #ifndef LEDS_H
 #define LEDS_H
 
@@ -14,11 +20,27 @@
 
 class LEDs
 {
-    public:
+public:
+    /** Changes the state of the LEDs depending on the speed of the vehicle
+    * @param leds_on If LEDs are enabled in settings (bool)
+    * @param speed The speed of the player (float)
+    * @param max_speed The maximum speed of the players chosen vehicle (float)
+    * @param Device The object for the gamepad class (object)
+    */
     void Speed(bool leds_on, float speed, float max_speed, Gamepad &Device);
+    
+    /** Changes the state of the LEDs for race count down
+    * @param leds_on If LEDs are enabled in settings (bool)
+    * @param state The current number during countdown (int)
+    * @param Device The object for the gamepad class (object)
+    */
     void Start_Sequence(bool leds_on,  int state, Gamepad &Device);
+    
+    /** Turns off all LEDs
+    * @param Device The object for the gamepad class (object)
+    */
     void Clear(Gamepad &Device);
-    private:
+private:
 };
 
 #endif
\ No newline at end of file