Diff: Models/models.h

Revision:

30:d454d0cb72bc

Parent:

29:579e00b7f118

Child:

32:5403bb974294

--- a/Models/models.h	Mon Apr 15 12:59:51 2019 +0000
+++ b/Models/models.h	Tue Apr 16 21:16:33 2019 +0000
@@ -9,15 +9,23 @@
 extern const int enemy2_width;
 
 
-/** @brief a function to put a sprite and its data in one variable.
-  * @details A struct that alows to create an object containing a sprite, its width and height.
-  * It is used with another function located in main.h. 
-  */
+/** @struct Sprite
+ * @brief A function to put a sprite and its data in one variable.
+ * @details A struct that alows to create an object containing a sprite, its width and height.
+ * It is used with another function located in main.h.
+ * @var Sprire::width .
+ * Member 'width' contains witdh of the sprite.
+ * @var Sprire::height.
+ * Member 'height' contains height of the sprite.
+ * @var Sprire::data.
+ * Member 'data' contains the array of 1s and 0s of the sprite.
+ */
 struct Sprite {
+    /*@{*/
     Sprite(int _width, int _height, const int* _data) : width(_width), height(_height), data(_data) {}
-    int width;
-    int height;
-    const int* data;
+    int width; /**< The width of the sprite*/
+    int height; /**< The height of the sprite*/
+    const int* data;  /**< The array of 1s and 0s of the sprite.*/
 };
 
 /** Sprite Objects to use for other files. */
@@ -42,10 +50,12 @@
 // Game Over and You Died sprites.
 extern const Sprite game_over_sprite;
 extern const Sprite you_died_sprite;
-// Tutorial Arrows sprites.
+// Tutorial Arrows and Menu sprites.
 extern const Sprite tutorial_arrow_right_sprite;
 extern const Sprite tutorial_arrow_left_sprite;
+extern const Sprite menu_cursor_sprite;
 // Player sprites.
 extern const Sprite player_spaceship1_sprite;
+extern const Sprite player_spaceship1_shield_sprite;
 
 #endif
\ No newline at end of file