Diff: UserInteraction/UX.h

Revision:

32:1bc731f03a30

Parent:

31:eefa1d23a843

Child:

33:9d34ef219fff

--- a/UserInteraction/UX.h	Wed May 08 12:13:28 2019 +0000
+++ b/UserInteraction/UX.h	Wed May 08 13:15:45 2019 +0000
@@ -6,22 +6,18 @@
 #include "Gamepad.h"
 
 /** Ball UX
-@author Shahid Zubin Sajid
-@brief Class for menus and display's user convenience
-@date May 2019
+* @author Shahid Zubin Sajid
+* @brief Class for menus and display's user convenience
+* @date May 2019
 */
 
 class UX
 {
 
 public:
-    /**
-    * @brief Constructor for the Ball Class
-    */
+    /** Constructor */
     UX();
-    /**
-    * @brief Deconstructor for the Ball Class
-    */
+    /** Deconstructor */
     ~UX();
     /**
     * @brief Initlialises the UX class
@@ -94,7 +90,7 @@
     void reset();
 
 private:
-    /*Seperate Gamepad has been used in this class because Gamepad obect
+    /**Seperate Gamepad has been used in this class because Gamepad obect
      from the main class had issues with the CHECK_EVENT Function. The function was not responsive
      and could not be resolved and as a result the only suitable solution was to create another object
      this explains why a ux object was passed in the Bat class to check if ball was hit or lofted as the
@@ -102,7 +98,7 @@
     */
     Gamepad _bat_pad;
 
-    // boolean variable used in get_a_pressed() get_l_pressed() to check if button is pressed
+    /** boolean variable used in get_a_pressed() get_l_pressed() to check if button is pressed*/
     bool _button_pressed;
 };
 #endif