Diff: Lore/Lore.h

Revision:

45:fe5fc85a5c73

Parent:

41:e1fa36c0492e

Child:

47:5ae8668af63f

--- a/Lore/Lore.h	Wed May 08 16:46:21 2019 +0000
+++ b/Lore/Lore.h	Thu May 09 03:56:41 2019 +0000
@@ -5,19 +5,51 @@
 #include "N5110.h"
 #include "Gamepad.h"
 
+/** Lore Class
+@brief Library for displaying tips about the game after every round
+@author Ozoemena Adrian Ikenna
+@date 8th May 2019
+*/
 class Lore
 {
     public:
+    /** constructor */
     Lore();
+    /** destructor */
     ~Lore();
     
+    /** Displays a random tip about the game
+    *@param &lcd: pointer to the N5110 library used for the lcd display
+    *@param rand: random number generated in main function and scaled for use in class
+    */
     void display(N5110 &lcd, int rand);
+    /** Prints a tip about the enemy ship, seeker, on screen
+    *@param &lcd: pointer to the N5110 library used for the lcd display
+    */
     void seeker(N5110 &lcd);
+    /** Prints a tip about the enemy ship, shooter, on screen
+    *@param &lcd: pointer to the N5110 library used for the lcd display
+    */
     void shooter(N5110 &lcd);
+    /** Prints a tip about a player ship, imperion, on screen
+    *@param &lcd: pointer to the N5110 library used for the lcd display
+    */
     void imperion(N5110 &lcd);
+    /** Prints a tip about a player ship, kestrel, on screen
+    *@param &lcd: pointer to the N5110 library used for the lcd display
+    */
     void kestrel(N5110 &lcd);
+    /** Prints a tip about a player ship, orion, on screen
+    *@param &lcd: pointer to the N5110 library used for the lcd display
+    */
     void orion(N5110 &lcd);
+    /** Prints a tip about the menu on screen
+    *@param &lcd: pointer to the N5110 library used for the lcd display
+    */
     void menu1(N5110 &lcd);
+    /** Displays game intro
+    *@param &lcd: pointer to the N5110 library used for the lcd display
+    */
     void intro(N5110 &lcd);
 
     private: