Doxygen comments added
Dependencies: mbed Gamepad N5110
Diff: Bird/Bird.h
- Revision:
- 11:c85abe88ad7a
- Parent:
- 10:75de0f4da176
- Child:
- 12:736e8561b81e
diff -r 75de0f4da176 -r c85abe88ad7a Bird/Bird.h --- a/Bird/Bird.h Wed May 08 20:59:02 2019 +0000 +++ b/Bird/Bird.h Wed May 08 21:10:18 2019 +0000 @@ -12,19 +12,19 @@ @date May 2019 */ public: - /* Constructor */ + /** Constructor */ Bird(); - /* Destructor */ + /** Destructor */ ~Bird(); - /* initialises and sets the horizonal and verical position of the 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 + /** Draws the bird on the lcd */ void draw(N5110 &lcd); - /* Gets the updated vertical positon of the bird + /** 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) */