Diff: structure/structure.h

Revision:

2:fb9c05867677

Parent:

0:3887ebee1b37

Child:

3:d9c2fc1d5984

--- a/structure/structure.h	Sat May 04 10:24:57 2019 +0000
+++ b/structure/structure.h	Sun May 05 18:46:58 2019 +0000
@@ -1,28 +1,49 @@
 #include "bird.h"
 
-
+/**
+*@brief Data struct includes the structure position.
+*/
 
 struct Data1{
-    int m; //障碍物左上角的点的横坐标
-    int n; // 障碍物间隔左上角点的纵坐标
-    int q; //the second
-    int o; // the third
-    int p; // the second  heng zuobiao
-    int e; // the third  heng zuobiao
-    int t;// 分数
+    int m; /**<int the position of the first structure */
+    int n; /**<int the position of the first channel */
+    int q; /**<int the position of the second structure */
+    int o; /**<int the position of the second channel */
+    int p; /**<int the position of the third structure */
+    int e; /**<int the position of the third channel */
+    int t; /**<int the score of the player*/
     };
+/** Cylinder Class
+*@brief Data used to make the structure
+*@anthor Zhou Yongzhi
+*@data May 2019
+*/
     
     
     
 class structure
 {
 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
+   */
    Data1 get_data1();
-   void update();
+
  
     
 private: