Added documentation

Headers/Vigenere.hpp

@@ -19,20 +19,20 @@ protected:
 	std::string keyword;        //This is the keyword that is the resposible for determining the offsets that you change each character by
 	std::vector<unsigned int> offset;   //This holds the offsets computed from each character in the keyword
 	void setOffset();	//Uses keyword to calculate the offset for the Caesar cipher for each character
-	void setInputString(std::string input);
+	void setInputString(std::string input);	//Sets inputString
-	void setKeyword(std::string key);
+	void setKeyword(std::string key);	//Sets keyword
-	std::string encode();
+	std::string encode();	//Encodes inputString and stores the result in outputString
-	std::string decode();
+	std::string decode();	//Decoded inputString and stores the result in outputString
 public:
 	Vigenere();
 	~Vigenere();
-	std::string getInputString() const;
+	std::string getInputString() const;		//Returns the current inputString
-	std::string getOutputString() const;	
+	std::string getOutputString() const;	//Returns the current outputString
-	std::string getKeyword() const;
+	std::string getKeyword() const;			//Returns the current keyword
-	std::vector<unsigned int> getOffsets() const;
+	std::vector<unsigned int> getOffsets() const;	//Returns the current offsets (Used mostly in bug fixing)
-	std::string encode(std::string key, std::string input);
+	std::string encode(std::string key, std::string input);	//Encodes input using key and returns the result
-	std::string decode(std::string key, std::string input);
+	std::string decode(std::string key, std::string input);	//Decodes input using key and returns the result
-	void reset();
+	void reset();	//Makes sure all of the variables are empty
 };
 
 #endif //VIGENERE_HPP