Diff: Animations.cpp

Revision:

1:bf0f64c26a0a

Parent:

0:45606d84dad8

--- a/Animations.cpp	Wed May 03 21:14:08 2017 +0000
+++ b/Animations.cpp	Thu May 04 14:02:17 2017 +0000
@@ -1,24 +1,24 @@
-/*
- 
- @file Animations.cpp
- 
- (c) Max Houghton 13.04.17
- Roller Maze Project, ELEC2645, Univeristy of Leeds
- 
- */
-
 #include "Animations.h"
 
+/**
+ *  @details - constructor
+ */
 Animations::Animations()
 {
     
 }
 
+/**
+ *  @details - destructor
+ */
 Animations::~Animations()
 {
     
 }
 
+/**
+ *  @details - Function to draw transparent-filled ball rolling across the screen.
+ */
 void Animations::rollingEmptyBall(N5110 &lcd)
 {
     // shows ball rolling across the screen
@@ -33,7 +33,9 @@
     }
 }
 
-
+/**
+ *  @details - Function to draw solid-filled ball rolling across the screen.
+ */
 void Animations::rollingSolidBall(N5110 &lcd)
 {
     // shows ball rolling across the screen
@@ -48,7 +50,9 @@
     
 }
 
-
+/**
+ *  @details - Short intro animation to be used during the loading of the game.
+ */
 void Animations::intro(N5110 &lcd, Gamepad &pad)
 {
     // animation sequence
@@ -193,6 +197,9 @@
     }
 }
 
+/**
+ *  @details - Function to display a switch.
+ */
 void Animations::soundSwitch(N5110 &lcd, Gamepad &pad, bool tone)
 {
     int exit = 0;
@@ -227,6 +234,9 @@
     }
 }
 
+/**
+ *  @details - Function to draw vertical joystick image.
+ */
 void Animations::drawVerticalJoystick(N5110 &lcd)
 {
     for (int i = 33; i < 57; i++){
@@ -288,6 +298,9 @@
     }
 }
 
+/**
+ *  @details - Function to draw joystick image tilting to the left.
+ */
 void Animations::drawLeftJoystick(N5110 &lcd)
 {
     for (int i = 33; i < 57; i++){
@@ -374,6 +387,9 @@
     lcd.setPixel(41, 25);
 }
 
+/**
+ *  @details - Function to draw joystick image tilting to the right.
+ */
 void Animations::drawRightJoystick(N5110 &lcd)
 {
     for (int i = 33; i < 57; i++){
@@ -457,6 +473,9 @@
     lcd.setPixel(49, 26);
 }
 
+/**
+ *  @details - Function to draw gamepad image tilting to the left.
+ */
 void Animations::drawLeftGamepad(N5110 &lcd)
 {
     for (int i = 33; i < 42; i++){
@@ -525,6 +544,9 @@
     lcd.clearPixel(32, 45);
 }
 
+/**
+ *  @details - Function to draw vertical gamepad image.
+ */
 void Animations::drawVerticalGamepad(N5110 &lcd)
 {
     for (int i = 38; i < 48; i++){
@@ -583,6 +605,9 @@
     lcd.clearPixel(48, 45);
 }
 
+/**
+ *  @details - Function to draw gamepad image tilting to the right.
+ */
 void Animations::drawRightGamepad(N5110 &lcd)
 {
     for (int i = 43; i < 52; i++){
@@ -654,12 +679,18 @@
     }
 }
 
+/**
+ *  @details - Short animation to be used maze is completed.
+ */
 void Animations::mazeCompleted(N5110 &lcd)
 {
     lcd.printString("  MAZE", 0, 2);
     lcd.printString("  DONE!", 0, 3);
 }
 
+/**
+ *  @details - First animation in a series to create a jumping man.
+ */
 void Animations::stickmanOne(N5110 &lcd)
 {
     lcd.clear();
@@ -693,7 +724,9 @@
     
 }
 
-
+/**
+ *  @details - Second animation in a series to create a jumping man.
+ */
 void Animations::stickmanTwo(N5110 &lcd)
 {
     lcd.clear();
@@ -718,6 +751,9 @@
     
 }
 
+/**
+ *  @details - Third animation in a series to create a jumping man.
+ */
 void Animations::stickmanThree(N5110 &lcd)
 {
     lcd.clear();
@@ -740,6 +776,9 @@
     
 }
 
+/**
+ *  @details - Fourth animation in a series to create a jumping man.
+ */
 void Animations::stickmanFour(N5110 &lcd)
 {
     lcd.clear();
@@ -764,6 +803,9 @@
     
 }
 
+/**
+ *  @details - Fifth animation in a series to create a jumping man.
+ */
 void Animations::stickmanFive(N5110 &lcd)
 {
     lcd.clear();
@@ -785,6 +827,9 @@
     
 }
 
+/**
+ *  @details - Sixth animation in a series to create a jumping man.
+ */
 void Animations::stickmanSix(N5110 &lcd)
 {
     lcd.clear();