Diff: Bird/Bird.h

Revision:

10:75de0f4da176

Parent:

6:bc580b480ac8

Child:

11:c85abe88ad7a

--- a/Bird/Bird.h	Tue May 07 22:39:48 2019 +0000
+++ b/Bird/Bird.h	Wed May 08 20:59:02 2019 +0000
@@ -5,16 +5,29 @@
 #include "N5110.h"
 #include "Gamepad.h"
 
-//Gamepad pad;
-
 class Bird {
-    
+    /** Bird Class
+    @brief Class to control the movement of the bird 
+    @author Rafeh Ishtiaq
+    @date May 2019
+    */
     public:
-    
-    //Bird();
-    //~Bird();
+    /* Constructor */
+    Bird();
+    /* Destructor */
+    ~Bird();
+    /* initialises and sets the horizonal and verical position of the bird
+    @param xpos @details Horizonal position of the bird
+    @param ypos @details vertical position of the bird
+    */
     void init(int xpos, int ypos);
+    /* Draws the bird on the lcd
+    */
     void draw(N5110 &lcd);
+    /* Gets the updated vertical positon of the bird
+    @param y @details the old vertical position of the bird
+    @returns y @details new vertical position of the bird (depends on button being pressed on Gamepad)
+    */
     int get_position(int y, Gamepad &pad);
     
     private: