Documented ConsoleInterface

1 files changed, 11 insertions, 0 deletions

diff --git a/src/Generic/ConsoleInterface/Command.h b/src/Generic/ConsoleInterface/Command.h
index d00b277..f1eb55b 100644
--- a/src/Generic/ConsoleInterface/Command.h
+++ b/src/Generic/ConsoleInterface/Command.h
@@ -1,13 +1,24 @@
 #ifndef HEADER_CONSOLEINTERFACE_COMMAND
 #define HEADER_CONSOLEINTERFACE_COMMAND
 
+/*! \file Command.h
+ *  \brief Stores the declaration of class Command
+ */
+
+/*! \brief Stores a 256 character name and a function pointer to be executed when calling run()
+ *
+ * Menu uses this class for a more generic implementation of it's navigate function.
+ */
 class Command {
 	char nameInMenu[256];
 	void (*exec)();
 
 public:
+	//! Leaves name empty and exec function pointer to nullptr
 	Command();
+	//! Copies contents of nameInMenu and stores exec
 	Command(const char* nameInMenu, void (*exec)());
+	//! Executes the stored function pointer
 	void run() const;
 
 	const char* get_nameInMenu() const;