Revision 8:2ced844d8292, committed 2017-05-03

Comitter:

musallambseiso

Date:

Wed May 03 20:03:46 2017 +0000

Parent:

7:3d951a743dbe

Commit message:

Removed redundant code, perfected Doxygen, added inline comments.

Changed in this revision

--- a/Enemy1.cpp	Tue May 02 22:13:59 2017 +0000
+++ b/Enemy1.cpp	Wed May 03 20:03:46 2017 +0000
@@ -2,24 +2,27 @@
 
 Enemy1::Enemy1()
 {
-
 }
 
 Enemy1::~Enemy1()
 {
+}
 
-}
+
+// Initializion method:
 
 void Enemy1::init(int speed)
 {   
-    int x = rand() % 63 + 84;
-    _x = x;
-    _y = 1;
+    _x = rand() % 63 + 84;  // Starting x position is randomized off screen. Creates a random ship generation.
+    _y = 1;                 // Starting y position (fixed, first lane)
 
-    _velocity.x = -speed;
+    _velocity.x = -speed;   // Velocity is based on the speed, which is input when method is used.
     _velocity.y = 0;
 }
 
+
+// Draws first enemy ship onto LCD:
+
 void Enemy1::draw(N5110 &lcd)
 {
     lcd.drawLine(_x,_y,_x,_y+5,1);
@@ -29,12 +32,19 @@
     lcd.drawLine(_x-4,_y+2,_x-4,_y+3,1);
 }
 
+
+// Updates first enemy ship's position:
+
 void Enemy1::update()
 {
+    // X and y positions depend on velocity:
     _x += _velocity.x;
     _y += _velocity.y;
 }
 
+
+// Obtains first enemy ship's current position:
+
 Vector2D Enemy1::get_pos()
 {
     Vector2D p = {_x,_y};

--- a/Enemy1.h	Tue May 02 22:13:59 2017 +0000
+++ b/Enemy1.h	Wed May 03 20:03:46 2017 +0000
@@ -6,6 +6,17 @@
 #include "Gamepad.h"
 #include "Friendly.h"
 
+/** Enemy1 Class
+@brief Used for generating the first enemy ship in the Nemesis game. Includes drawing and updating functions. 
+@brief Incorporates N5110.h file by Craig A. Evans.
+
+@brief Revision 1.0
+
+@author Musallam M. M. Bseiso
+@date   3rd May 2017
+*/
+
+
 class Enemy1
 {
 
@@ -31,6 +42,8 @@
     /** Draw Enemy1
     *   
     *   Draws the first enemy ship onto the LCD, in accordance with the parameters initialized in the "init" method.
+    *   @param N5110 - nokia LCD library
+    *   @param lcd - pointer to nokia LCD library
     */
     void draw(N5110 &lcd);