Diff: cxkEngine/cxkEngine.h

Revision:

13:45354ed42401

Parent:

12:f8eb397226bc

--- a/cxkEngine/cxkEngine.h	Mon May 06 04:11:38 2019 +0000
+++ b/cxkEngine/cxkEngine.h	Mon May 06 06:42:41 2019 +0000
@@ -8,17 +8,46 @@
 #include "CXK.h"
 
 
+/** cxkEngine Class
+* @brief the diagram of the ball and others 
+* @author Zhang Xinyu
+* @school EE of  SWJTU &leeds joint school
+* @date  MAY  2019
+*/ 
 
 class cxkEngine
 {
 
 public:
+
+/** Constructor */
     cxkEngine();
+    
+    /** Destrctor */
     ~cxkEngine();
 
+ /** Set the cxkEngineinit  
+       * @ param value of the cxk feature of the CXK file (CXK_width, CXK_height)
+        * @ param value of the ball size of the ballfile (ball_size)
+         * @ param value of the move speed of the CXKand ball file (speed)
+    */
     void init(int CXK_width,int CXK_height,int ball_size,int speed);
+    
+    /** Set the cxkEread_Iinput
+      * @ details use CXK and BAll to read the value of direction and maganitude of joystick
+    */
     void read_input(Gamepad &pad);
+    
+
+    /** Set the cxkEupdate 
+      * @ details updated the d and vara from the read_input
+    */
     void update(Gamepad &pad);
+    
+     /** Set the CXKdraw  
+       * @ param  the score player get (cxkp_score)
+       * @ details draw the wall and basket to the game
+       */
     void draw(N5110 &lcd);
     
 private: