Diff: main.cpp

Revision:

11:db27d3838514

Parent:

10:58cf89dd878c

--- a/main.cpp	Mon May 06 10:11:42 2019 +0000
+++ b/main.cpp	Mon May 06 14:43:01 2019 +0000
@@ -44,7 +44,9 @@
 void you_win();
 int main();
 
-// initialies all classes and libraries
+/**
+* @brief initialies all classes and libraries
+*/ 
 void init()
 {
     // need to initialise LCD and Gamepad
@@ -56,7 +58,10 @@
     game.init();
 
 }
-// simple splash screen displayed on start-up
+
+/**
+* @brief simple splash screen displayed on start-up
+*/ 
 void welcome()
 {
 
@@ -75,7 +80,9 @@
     }
 
 }
-
+/**
+* @brief You Win! Screen
+*/ 
 void you_win()
 {
     // Draws Win Screen
@@ -93,8 +100,9 @@
     main();
 
 }
-
-
+/**
+* @brief Displays instructions on how to play.
+*/ 
 void how_to_play()
 {
     // Gives instructions on how to play
@@ -111,10 +119,11 @@
     while ( !pad.check_event(Gamepad::A_PRESSED) ) {}
 
     // Return to menu
-    menu();  // TRY it without this
-
+    menu(); 
 }
-
+/**
+* @brief Displays main menu
+*/
 void menu()
 {
     // Main Menu
@@ -150,8 +159,9 @@
 }
 
 
-
-
+/**
+* @brief Main Loop
+*/
 int main()
 {