Diff: StateMachine/TestingState.h

Branch:

Drift

Revision:

86:51048c1f132f

Parent:

82:992ba6f31e24

Child:

97:0ed9ede9a995

--- a/StateMachine/TestingState.h	Tue Apr 18 22:27:14 2017 +0000
+++ b/StateMachine/TestingState.h	Wed Apr 19 03:46:21 2017 +0000
@@ -1,3 +1,9 @@
+/**
+ * @file TestingState.h
+ * @brief The header file for the TestingState class.
+ * @author Jordan Brack <jabrack@mix.wvu.edu>, Haofan Zheng <hazheng@mix.wvu.edu>
+ * 
+ */
 #pragma once
 #ifndef TESTING_STATE_H
 #define TESTING_STATE_H
@@ -5,22 +11,54 @@
 #include <mbed.h>
 #include "States.h"
 
+/**
+ * @class TestingState
+ * @brief The class for testing state. It is a child class of the States class.
+ * 
+ */
 class TestingState : public States
 {
 public:
+    /**
+    * @brief This is the constructor for the TestingState class
+    */
     TestingState();
+    /**
+    * @brief This is the destructor for the TestingState class
+    */
     ~TestingState();
     
+    /**
+    * @brief Draw the user interface. This function is called only once, whenever the testing state becomes the current state.
+    */
     virtual void DrawUserInterface();
     
+    /**
+    * @brief This functino will be called during every tick, only if the testing state is the current state. 
+    * @param deltaTime The time interval between last tick and current tick.
+    */
     virtual void Update(float deltaTime);
     
+    /**
+    * @brief Return wether or not the testing state has a position callback function for the touch screen.
+    * @return 0 for not, 1 for yes.
+    */
     virtual uint8_t HasTouchPosFunction() const;
     
+    /**
+    * @brief Return wether or not the testing state has a interrupt callback function for the touch screen.
+    * @return 0 for not, 1 for yes.
+    */
     virtual uint8_t HasTouchIrqFunction() const;
     
+    /**
+    * @brief The position callback function for the touch screen. Based on the touch position, the corresponding functionality will be executed. 
+    */
     virtual void TouchPosCallback(int16_t x, int16_t y);
     
+    /**
+    * @brief The interrupt callback function for the touch screen.
+    */
     virtual void TouchIrqCallback();
 };