Diff: main.h

Revision:

100:6403c1705a08

Parent:

99:4841f326200f

Child:

101:5108621b207f

--- a/main.h	Thu May 09 10:10:10 2019 +0000
+++ b/main.h	Thu May 09 11:10:06 2019 +0000
@@ -40,18 +40,36 @@
  
  
 ///////////// prototypes //////////////
-//Initialises main.cpp
+/**
+* @brief Initialises main.cpp and all the libraries and classes used.
+*/
 void init();
-//calls functions using class objects to display menu.
+
+/**
+* @brief Calls functions using class objects to display menu.
+*/
 void menu();
-//Constantly reads and writes stats from and to the SD card.
+
+/**
+* @brief Constantly reads and writes stats from and to the SD card.
+*/
 void read_write_stats();
-//sets game mode and game speed into snakevsblocks class by reading these from startscreen.
+
+/**
+* @brief Sets game mode and game speed into snakevsblocks class by reading these from startscreen.
+*/
 void _set_mode_speed();
-//this is executed when the player starts the game.
+
+/**
+* @brief This is executed when the player starts the game.
+*/
 void gameLoop();
-//refreshes display and draws game objects using snakevsblock class.
+
+/**
+* @brief Refreshes display and draws game objects using snakevsblock class.
+*/
 void refresh_game();
+
 //void deinit();
 
 #endif
\ No newline at end of file