ELEC2645 (2018/19) / Mbed 2 deprecated el17ri

Doxygen comments added

Dependencies:   mbed Gamepad N5110

Pipes/Pipes.h@10:75de0f4da176, 2019-05-08 (annotated)

Committer:
rafeh
Date:
Wed May 08 20:59:02 2019 +0000
Revision:
10:75de0f4da176
Parent:
7:05f433e196d6
Child:
11:c85abe88ad7a
doxygen comments added

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rafeh 3:5409b50b01b0 1 #ifndef PIPES_H
rafeh 3:5409b50b01b0 2 #define PIPES_H
rafeh 3:5409b50b01b0 3
rafeh 3:5409b50b01b0 4 #include "mbed.h"
rafeh 3:5409b50b01b0 5 #include "N5110.h"
rafeh 3:5409b50b01b0 6 #include "Gamepad.h"
rafeh 10:75de0f4da176 7 /** Pipes Class
rafeh 10:75de0f4da176 8 @brief Class for generating and drawing pipes
rafeh 10:75de0f4da176 9 @author Rafeh Ishtiaq
rafeh 10:75de0f4da176 10 @date May 2019
rafeh 10:75de0f4da176 11 */
rafeh 3:5409b50b01b0 12
rafeh 3:5409b50b01b0 13 class Pipes {
rafeh 3:5409b50b01b0 14 public:
rafeh 10:75de0f4da176 15 /** Constructor */
rafeh 10:75de0f4da176 16 Pipes();
rafeh 10:75de0f4da176 17 /** Destructor */
rafeh 10:75de0f4da176 18 ~Pipes();
rafeh 10:75de0f4da176 19 /* Initialises the x position and height of the pipes
rafeh 10:75de0f4da176 20 @param x @details the horizontal coordinate of the pipes
rafeh 10:75de0f4da176 21 @param height @details the height of the top pipe
rafeh 10:75de0f4da176 22 */
rafeh 3:5409b50b01b0 23 void init(int x, int height);
rafeh 10:75de0f4da176 24
rafeh 10:75de0f4da176 25 /* Draws the pipes on the lcd
rafeh 10:75de0f4da176 26 */
rafeh 3:5409b50b01b0 27 void draw(N5110 &lcd);
rafeh 10:75de0f4da176 28 /* Generates a height for the top pipe
rafeh 10:75de0f4da176 29 @returns random height (an integer between 1 and 25)
rafeh 10:75de0f4da176 30 */
rafeh 7:05f433e196d6 31 int generate_height();
rafeh 10:75de0f4da176 32
rafeh 3:5409b50b01b0 33 private:
rafeh 3:5409b50b01b0 34
rafeh 3:5409b50b01b0 35 int _x;
rafeh 3:5409b50b01b0 36 int _height;
rafeh 7:05f433e196d6 37 int _random_height;
rafeh 3:5409b50b01b0 38 };
rafeh 3:5409b50b01b0 39
rafeh 3:5409b50b01b0 40
rafeh 3:5409b50b01b0 41
rafeh 3:5409b50b01b0 42
rafeh 3:5409b50b01b0 43
rafeh 3:5409b50b01b0 44
rafeh 3:5409b50b01b0 45
rafeh 3:5409b50b01b0 46
rafeh 3:5409b50b01b0 47
rafeh 3:5409b50b01b0 48
rafeh 3:5409b50b01b0 49
rafeh 3:5409b50b01b0 50
rafeh 3:5409b50b01b0 51
rafeh 3:5409b50b01b0 52 #endif