Diff: structure_2/structure_2.h

Revision:

2:fb9c05867677

Parent:

0:3887ebee1b37

Child:

3:d9c2fc1d5984

diff -r 8672e52115e3 -r fb9c05867677 structure_2/structure_2.h
--- a/structure_2/structure_2.h	Sat May 04 10:24:57 2019 +0000
+++ b/structure_2/structure_2.h	Sun May 05 18:46:58 2019 +0000
@@ -2,30 +2,47 @@
 #include "N5110.h"
 #include "Gamepad.h"
 
-
+/**
+*@brief Data struct includes the structure position.
+*/
 
 struct Data2{
-    int mm; //障碍物左上角的点的横坐标
-    int nn; // 障碍物间隔左上角点的纵坐标
-    int qq; //the second
-    int oo; // the third
-    int pp; // the second  heng zuobiao
-    int ee; // the third  heng zuobiao
-    int tt;// 分数
+    int mm; /**<int the position of the first structure */
+    int nn; /**<int the position of the first channel */
+    int qq; /**<int the position of the second structure */
+    int oo; /**<int the position of the second channel */
+    int pp; /**<int the position of the third structure */
+    int ee; /**<int the position of the third channel */
+    int tt;/**<int the position of the third channel */
     };
-    
-    
-    
+/** Cylinder Class
+*@brief Data used to make the structure
+*@anthor Zhou Yongzhi
+*@data May 2019
+*/   
 class structure_2
 {
 public:
-   
+     /**
+   *@brief initialise the parameters
+   *@param size,speed
+   */
    void init(int size,int speed);
+   /**
+   *@brief initialise the parameters
+   *@param lcd
+   *@details The function in N5110 is used
+   */
    void draw(N5110 &lcd);
+   /**
+   *@brief initialise the parameters
+   */
    void init();
+        /**
+   *@brief The data which are sent to main.cpp
+   */
    Data2 get_data2();
-   void update();
- 
+
     
 private:
   int _mm; //障碍物左上角的点的横坐标