Adding comments

Author: DarthRubik

Calculator/CalculatorMain.cpp

@@ -7,22 +7,29 @@ int main()
 {
 	while (1)
 	{
+		//Ask the user what they want
 		std::cout << "1) Basic Math\n"
 			  << "2) Average\n"
 			  << "3) Max and Min\n"
 			  << "4) Resistor Operations\n"
 			  << "Enter your choice (-1) to quit:" << std::endl;
 		int choice = GetIntFromUser(std::cout,std::cin);
+		//If this is null at the end we do not delete it 
 		int* array = 0;
 		int array_length;
+
+		//Places to hold the answers
 		float answer;
 		int max,min;
+
+		//If the error is still zero at the end then no error occured
 		int error = 0;
 
 		switch (choice)
 		{
 			case 1:
 				{
+					//Ask the user what they want
 					std::cout << "1) Addition\n"
 						  << "2) Subtraction\n"
 						  << "3) Multiplication\n"
@@ -31,6 +38,8 @@ int main()
 						  << "Enter your choice: " << std::endl;
 
 					int op = GetIntFromUser(std::cout,std::cin);
+
+					//Get the operands
 					std::cout << "Enter the operands: " << std::endl;
 					int op1 = GetIntFromUser(std::cout,std::cin);
 					int op2 = GetIntFromUser(std::cout,std::cin);
@@ -58,9 +67,13 @@ int main()
 			default:
 				return 0;
 		}
+		//If we got an array delete it
 		if (array != 0) delete[] array;
+
+		//If there is no error print the answers
 		if (!error)
 		{
+			//For a max and min we have two answers to display
 			if (choice == 3)
 			{
 				std::cout << "Max: " << max << " Min: " << min << std::endl;
@@ -70,6 +83,7 @@ int main()
 				std::cout << "The answer is: " << answer << std::endl;
 			}
 		}
+		//An error occured
 		else
 		{
 			std::cout << "An error occured, please try again...." << std::endl;

Utility/UserInput.cpp

@@ -2,31 +2,43 @@
 #include <cstdlib>
 
 
+//If the string is an integer then return true (else false)
 bool isInteger(const std::string& str)
 {
+	//Blank strings are not integers
 	if ("" == str) return false;
+
 	char* lastDigit;
+	//strtol will set "lastDigit" to the char it stopped parsing at
 	std::strtol(str.c_str(), &lastDigit, 10);
+
+
+	//If the last parsed char it parsed the whole string
 	return *lastDigit == 0;
 }
 int GetIntFromUser(std::ostream& ostream, std::istream& stream)
 {
 	std::string str;
 	std::getline(stream,str);
+	//Yell at the user until they enter the correct data
 	while (!isInteger(str))
 	{
 		ostream << "Try again" << std::endl;
 		std::getline(stream,str);
 	}
+	//Convert the string to an int
 	return std::strtol(str.c_str(),0,10);
 }
 void GetIntArrayFromUser(std::ostream &ostream, std::istream &stream,
                          int **array, int *length)
 {
 	ostream << "Enter array length:" << std::endl;
+
+	//Allocate array the length asked for
 	*length = GetIntFromUser(ostream,stream);
 	*array = new int[*length];
 
+	//Populate the array
 	ostream << std::string("Enter array:") << std::endl;
 
 	for (int x = 0; x < *length; x++)

Utility/UserInput.hpp

@@ -1,8 +1,16 @@
+#ifndef UTILITY_USERINPUT_HPP
+#define UTILITY_USERINPUT_HPP
 #include <iostream>
 #include <sstream>
 #include <string>
 
+//Gets a single integer from the user
 int GetIntFromUser(std::ostream& ostream,std::istream &stream);
+
+//Returns whether or not the string is an integer
 bool isInteger(const std::string &str);
+
+//Get an array from the user
 void GetIntArrayFromUser(std::ostream &ostream, std::istream &stream,
                          int **array, int *length);
+#endif