Fully documented UserInterface

2 files changed, 11 insertions, 0 deletions

diff --git a/src/UserInterface/VenueConsoleUI.cpp b/src/UserInterface/VenueConsoleUI.cpp
index a7fc699..6a40f77 100644
--- a/src/UserInterface/VenueConsoleUI.cpp
+++ b/src/UserInterface/VenueConsoleUI.cpp
@@ -277,6 +277,12 @@ void init() {
 	reportsMenu.addCommand(Command("Bought Tickets", command_boughtTickets));
 }
 
+/*!
+ * Stores EventService and HallService pointers in internal global variables,
+ * calls EventService and HallService load() functions,
+ * initializes all menus, navigates the main menu and
+ * finally calls EventService and HallService save() functions
+ */
 void runUI(EventService* eventService, HallService* hallService) {
 	es = eventService;
 	hs = hallService;
diff --git a/src/UserInterface/VenueConsoleUI.h b/src/UserInterface/VenueConsoleUI.h
index 1362878..5511fe6 100644
--- a/src/UserInterface/VenueConsoleUI.h
+++ b/src/UserInterface/VenueConsoleUI.h
@@ -1,9 +1,14 @@
 #ifndef HEADER_VENUECONSOLEUI
 #define HEADER_VENUECONSOLEUI
 
+/*! \file VenueConsoleUI.h
+ *  \brief Stores declaration of runUI function
+ */
+
 #include "../Services/EventService.h"
 #include "../Services/HallService.h"
 
+//! Runs the console interface for the ticket system
 void runUI(EventService* eventService, HallService* hallService);
 
 #endif