code: a lot more documentation

Author: benja2998

src/main.cpp

@@ -45,6 +45,7 @@ std::string checked6 = "[ ]";
 void initialize();
 
 void banner() {
+    /* Using raw string literals for multiline strings. */
     const char* banner = R"(
               .__   __  .__  __                .__                           
   _____  __ __|  |_/  |_|__|/  |_  ____   ____ |  |      .__         .__     )";
@@ -57,6 +58,7 @@ void banner() {
 |__|_|  /____/|____/__| |__||__|  \____/ \____/|____/    |__|        |__|    
       \/                                                                     )";
 
+    /* Print using ansi color codes for a fade effect from white to blue. */
     std::cout << ansi::BG_BLACK;
     std::cout << ansi::BOLD << ansi::WHITE << banner << ansi::RESET;
     std::cout << ansi::BG_BLACK;
@@ -180,8 +182,10 @@ void menu() {
 
 void read() {
     char check = char_utils::get_char();
+    /* Removed  this line below since it looks bad. */
     //std::cout << ansi::CYAN << "Validating choice... " << ansi::RESET;
 
+    /* This is the least efficient way to do it, but i don't want to use things like ncurses. */
     if (check == 'w' || check == 'W') {
         if (checked2 == "[x]") {
             checked2 = "[ ]";
@@ -248,7 +252,9 @@ void read() {
             std::cout << ansi::GREEN << "Valid choice!" << ansi::RESET << "\n";
             std::cout << ansi::BOLD << ansi::ITALIC << ansi::CYAN << "Welcome to the calculator shell, type 'help' for commands.\n" << ansi::RESET;
             option_shell();
-            initialize();
+            initialize(); /* Workaround for not being able to call initialize() in the header file. 
+                * Since option_shell() runs in the same thread, initialize() will only run after the user exits the calculator shell.
+            */
         }
     }
     else {
@@ -258,6 +264,8 @@ void read() {
     }
 }
 
+/* Probably the most useful function in the program. */
+/* Helps a lot for returning to the main menu. */
 void initialize() {
     console::clear();
     menu();
@@ -268,6 +276,7 @@ void checkCurlIsInstalled() {
 #ifdef _WIN32
     int curl = system("curl --version >nul 2>&1");
     if (curl != 0) {
+        /* Either the user is not intelligent life and removed curl.exe or they are running an old version of Windows. */
         std::cout << "Curl not installed. Install it by running: winget install cURL.cURL\n";
         exit(1);
     }