Revision 4:bc02594c4902, committed 2017-05-03

Comitter:

musallambseiso

Date:

Wed May 03 20:04:08 2017 +0000

Parent:

3:ed7f3ee41871

Commit message:

Removed redundant code, perfected Doxygen, added inline comments.

Changed in this revision

diff -r ed7f3ee41871 -r bc02594c4902 Enemy3.cpp
--- a/Enemy3.cpp	Tue May 02 22:14:22 2017 +0000
+++ b/Enemy3.cpp	Wed May 03 20:04:08 2017 +0000
@@ -2,24 +2,27 @@
 
 Enemy3::Enemy3()
 {
-
 }
 
 Enemy3::~Enemy3()
 {
+}
 
-}
+
+// Initializion method:
 
 void Enemy3::init(int speed)
 {
-    int x = rand() % 63 + 84;
-    _x = x;
-    _y = 13;
+    _x = rand() % 63 + 84;  // Starting x position is randomized off screen. Creates a random ship generation.
+    _y = 13;                // Starting y position (fixed, third lane)
 
-    _velocity.x = -speed;
+    _velocity.x = -speed;   // Velocity is based on the speed, which is input when method is used.
     _velocity.y = 0;
 }
 
+
+// Draws third enemy ship onto LCD:
+
 void Enemy3::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 third enemy ship's position:
+
 void Enemy3::update()
 {
+    // X and y positions depend on velocity:
     _x += _velocity.x;
     _y += _velocity.y;
 }
 
+
+// Obtains third enemy ship's current position:
+
 Vector2D Enemy3::get_pos()
 {
     Vector2D p = {_x,_y};

diff -r ed7f3ee41871 -r bc02594c4902 Enemy3.h
--- a/Enemy3.h	Tue May 02 22:14:22 2017 +0000
+++ b/Enemy3.h	Wed May 03 20:04:08 2017 +0000
@@ -6,6 +6,17 @@
 #include "Gamepad.h"
 #include "Friendly.h"
 
+/** Enemy3 Class
+@brief Used for generating the third 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 Enemy3
 {
 
@@ -31,6 +42,8 @@
     /** Draw Enemy3
     *   
     *   Draws the third 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);