Diff: bird/bird.h

Revision:

2:fb9c05867677

Parent:

1:8672e52115e3

Child:

3:d9c2fc1d5984

--- a/bird/bird.h	Sat May 04 10:24:57 2019 +0000
+++ b/bird/bird.h	Sun May 05 18:46:58 2019 +0000
@@ -2,25 +2,52 @@
 #include "N5110.h"
 #include "Gamepad.h"
 
-    
+/**
+*@brief Data struct includes the bird position.
+*/    
     
     
 struct Data{
     int y;
     };      
-    
+
+
+/** Cylinder Class
+*@brief Data used to make the bird
+*@anthor Zhou Yongzhi
+*@data May 2019
+*/   
 class bird
 {
 
     
 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
+   *@param lcd,pad
+   *@details The function in N5110 and Gamepad is used
+   */
     void check(Gamepad &pad, N5110 &lcd);
+       /**
+   *@brief initialise the parameters
+   */
     void init();
+            /**
+   *@brief The data which are sent to main.cpp
+   */
     Data get_data();
-    void update();
+
 
 private:
     int _y;