Diff: move/Move.h

Revision:

1:538386e72e40

Parent:

0:07c4fef6c0af

Child:

2:c7976a633ba0

diff -r 07c4fef6c0af -r 538386e72e40 move/Move.h
--- a/move/Move.h	Wed May 08 21:44:02 2019 +0000
+++ b/move/Move.h	Wed May 08 22:10:38 2019 +0000
@@ -5,6 +5,13 @@
 #include "N5110.h"
 #include "Gamepad.h"
 
+/** Move Class
+@brief Class for main engine for the snake game
+@author Zhou Jiaxin
+@date 8th May 2019
+*/
+
+
 struct SnakeBody{
     char _xx[4000];
     char _yy[4000];
@@ -20,15 +27,42 @@
 class Move
 {
 public:
-
+    /** Constructor */
     Move();
+    /** Destructor */
     ~Move();
+    
+    /** 
+    * @brief initial all the parameter for the snake and food.
+    */
     void initial();
+    /** 
+    * @brief Print snake, walls and food on LCD.
+    * @param N5110 *lcd @details pointer to the N5110 object in main, address of this pointer is saved to make availability to the entire class, without passing address to each function.
+    */
     void onlcd(N5110 &lcd);
+    /** 
+    * @brief Update new direction and snake head.
+    * @param Gamepad *pad @details pointer to the gamepad object in main, address of this pointer is saved to make availability to the entire class, without passing address to each function.
+    */
     void update(Gamepad &pad);
+    /** 
+    * @brief Update whole snakebody. 
+    */
     void updatebody();
+    /** 
+    * @brief Use random number to generate a new food on screen while old food has benn eaten.
+    */
     void getfood();
+    /** 
+    * @brief check if snake head collide the wall or its body.
+    * @param N5110 *lcd @details pointer to the N5110 object in main, address of this pointer is saved to make availability to the entire class, without passing address to each function.
+    * @param Gamepad *pad @details pointer to the gamepad object in main, address of this pointer is saved to make availability to the entire class, without passing address to each function.
+    */
     void die(N5110 &lcd ,Gamepad &pad);
+    /** 
+    * @brief check if snake head hit the food.
+    */
     void eatfood();
     
 private: