From 6c31ce8db2f8b969f030e5d9d04c9ae511333a06 Mon Sep 17 00:00:00 2001
From: Syndamia <kamen.d.mladenov@protonmail.com>
Date: Sun, 8 May 2022 16:12:55 +0300
Subject: Documented ConsoleInterface

---
 src/Generic/ConsoleInterface/Toolbox.hpp | 55 +++++++++++++++++++++++++-------
 1 file changed, 44 insertions(+), 11 deletions(-)

(limited to 'src/Generic/ConsoleInterface/Toolbox.hpp')

diff --git a/src/Generic/ConsoleInterface/Toolbox.hpp b/src/Generic/ConsoleInterface/Toolbox.hpp
index a1a310b..ea1bba1 100644
--- a/src/Generic/ConsoleInterface/Toolbox.hpp
+++ b/src/Generic/ConsoleInterface/Toolbox.hpp
@@ -3,74 +3,107 @@
 
 #include <iostream>
 
+/*! \file Toolbox.hpp
+ *  \brief Stores a wide range of functions for simpler/more automated printing.
+ *
+ * Adds a lot of functions for printing.
+ *
+ * \remark iostream is included by necessity (templated functions), you should only use the provided functions, if you can.
+ */
+
 #define MAX_LINE_WIDTH 1024
 
+//! Clears the console screen (Linux-only)
 void clear();
+//! Prints a title box
 void titleBox(const char* title);
+//! Prints a title sub box
 void subTitleBox(const char* title);
 
+//! Prints a success box
 void successBox(const char* message);
+//! Prints a success box as a sub box
 void successSubBox(const char* message);
+//! Prints a warning box
 void warningBox(const char* message);
+//! Prints a warning box as a sub box
 void warningSubBox(const char* message);
+//! Prints an error box
 void errorBox(const char* message);
+//! Prints an error box as a sub box
 void errorSubBox(const char* message);
 
+//! Prints label, gets a whole line of input and stores it to output
 void inputLineBox(const char* label, char* output, unsigned maxWidth, bool ignore = true);
+//! Prints label as a sub box, gets a whole line of input and stores it to output
 void inputLineSubBox(const char* label, char* output, unsigned maxWidth, bool ignore = true);
+//! Waits for user to press enter
 void pressEnterToContinue(bool ignore = true);
 
+//! Resets the ordered list starting number
 void resetOrderedList(int starter = 1);
 
+//! Prints a string as a table
 void table(unsigned startNumber, unsigned columns, const char* items);
 
+//! Semi-internal function that prints the spacing for sub boxes
 void _printSubBoxSpacing();
+//! Semi-internal function that prints the label of an input box
 void _printInputBoxLabel(const char* label);
+//! Semi-internal function that prints the latest ordered list index
 void _printOrderedListBeginning();
 
-template <class T>
+//! Reads user input and stores it
+template <typename T>
 void read(T* storage) {
 	std::cin >> storage;
 }
 
-template <class T>
+//! Reads user input and stores it
+template <typename T>
 void read(T& storage) {
 	std::cin >> storage;
 }
 
-template <class T>
+//! Prints given item
+template <typename T>
 void print(const T* item) {
 	std::cout << item;
 }
 
-template <class T>
-void printLine(const T* item) {
-	std::cout << item << std::endl;
-}
-
-template <class T>
+//! Prints given item
+template <typename T>
 void print(const T& item) {
 	std::cout << item;
 }
 
-template <class T>
-void printLine(const T& item) {
+//! Prints given item and an endline character
+template <typename T>
+void printLine(const T* item) {
 	std::cout << item << std::endl;
 }
 
+//! Prints given item and an endline character
+template <typename T>
+void printLine(const T& item) {
+	std::cout << item << std::endl;
+}
 
+//! Prints the element as the latest list item
 template <typename T>
 void printOrderedListElem(const T& elem) {
 	_printOrderedListBeginning();
 	printLine(elem);
 }
 
+//! Prints a label and then reads user input and stores it
 template <typename T>
 void inputBox(const char* label, T* output) {
 	_printInputBoxLabel(label);
 	std::cin >> *output;
 }
 
+//! Prints a label with sub box spacing and then reads user input and stores it
 template <typename T>
 void inputSubBox(const char* label, T* output) {
 	_printSubBoxSpacing();
-- 
cgit v1.3.1-23-gd82d