From cd8780939e5a806f34a03b86a3e10f26666180d1 Mon Sep 17 00:00:00 2001
From: Steve Brokenshire <sbrokenshire@xestia.co.uk>
Date: Fri, 11 Mar 2016 17:10:53 +0000
Subject: [PATCH] Added comments to functions in common/textprocessing.cpp

---
 source/common/textprocessing.cpp | 35 ++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/source/common/textprocessing.cpp b/source/common/textprocessing.cpp
index aeec7a8..b9832e5 100644
--- a/source/common/textprocessing.cpp
+++ b/source/common/textprocessing.cpp
@@ -26,6 +26,8 @@
 void EscapeString(wxString *ReceivedString, bool StripQuotes)
 {
 
+	// Escape a string that contains escapable characters.
+
 	ReceivedString->Replace(wxT("\\"), wxT("\\\\"), TRUE);
 	ReceivedString->Replace(wxT(","), wxT("\\,"), TRUE);
 	ReceivedString->Replace(wxT(";"), wxT("\\;"), TRUE);
@@ -43,6 +45,8 @@ void EscapeString(wxString *ReceivedString, bool StripQuotes)
 void GetEscapeString(wxTextCtrl *TextCtrl, wxString *ProcessString, bool StripQuotes)
 {
 
+	// Get an escaped string from a wxTextCtrl.
+
 	*ProcessString = TextCtrl->GetValue();
 	EscapeString(ProcessString, StripQuotes);
 
@@ -51,6 +55,8 @@ void GetEscapeString(wxTextCtrl *TextCtrl, wxString *ProcessString, bool StripQu
 void GetEscapeString(wxComboBox *ComboCtrl, wxString *ProcessString, bool StripQuotes)
 {
 
+	// Get an escaped string from a wxComboBox.
+
 	*ProcessString = ComboCtrl->GetValue();
 	EscapeString(ProcessString, StripQuotes);
 
@@ -59,6 +65,8 @@ void GetEscapeString(wxComboBox *ComboCtrl, wxString *ProcessString, bool StripQ
 void GetEscapeString(wxChoice *ChoiceCtrl, wxString *ProcessString, bool StripQuotes)
 {
 
+	// Get an escaped string from a wxChoice.
+
 	*ProcessString = ChoiceCtrl->GetString(ChoiceCtrl->GetSelection());
 	EscapeString(ProcessString, StripQuotes);
 
@@ -67,6 +75,8 @@ void GetEscapeString(wxChoice *ChoiceCtrl, wxString *ProcessString, bool StripQu
 void CaptureString(wxString *ProcessString, bool StripQuotes)
 {
 
+	// Capture a string for processing.
+
 	ProcessString->Replace(wxT("\\n"), wxT("\n"), TRUE);
 	ProcessString->Replace(wxT("\\;"), wxT(";"), TRUE);
 	ProcessString->Replace(wxT("\\,"), wxT(","), TRUE);
@@ -83,6 +93,8 @@ void CaptureString(wxString *ProcessString, bool StripQuotes)
 void ResetUnusedString(wxString *ProcessString)
 {
 
+	// Reset an unused string.
+
 	ProcessString->Replace(wxT("\\\\"), wxT("\\"), TRUE);
 	ProcessString->Replace(wxT("\n"), wxT(""), TRUE);
 	ProcessString->Replace(wxT("\\;"), wxT(";"), TRUE);
@@ -93,6 +105,9 @@ void ResetUnusedString(wxString *ProcessString)
 void ConvertToHTML(wxString *ProcessString)
 {
 
+	// Convert string into text that can be used with a 
+	// wxHTMLWindow.
+
 	ProcessString->Replace(wxT("&"), wxT("&amp;"), TRUE);
 	ProcessString->Replace(wxT("<"), wxT("&lt;"), TRUE);
 	ProcessString->Replace(wxT(">"), wxT("&gt;"), TRUE);
@@ -101,23 +116,41 @@ void ConvertToHTML(wxString *ProcessString)
 }
 
 void DeleteMapDataProcess(int IndexNum, std::map<int, std::string>* MapData){
+
+	// Delete map data (for map<int,string>).
+
 	MapData->erase(IndexNum);
+	
 }
 
 void DeleteMapDataProcess(int IndexNum, std::map<int, wxString>* MapData){
+
+	// Delete map data (for map<int,wxString>).
+
 	MapData->erase(IndexNum);
+	
 }
 
 void DeleteMapDataProcess(int IndexNum, std::map<int, int>* MapData){
+
+	// Delete map data (for map<int,int>).
+
 	MapData->erase(IndexNum);
+	
 }
 
 void DeleteMapDataProcess(int IndexNum, std::map<int, bool>* MapData){
+
+	// Delete map data (for map<int,bool>).
+
 	MapData->erase(IndexNum);
+	
 }
 
 bool MapDataExists(int *ItemIndex, std::map<int,wxString> *MapPtr){
 
+	// Check if map data exists (for map<int,wxString>).
+	
 	if (MapPtr->find(*ItemIndex) == MapPtr->end()){
 	
 		return FALSE;
@@ -132,6 +165,8 @@ bool MapDataExists(int *ItemIndex, std::map<int,wxString> *MapPtr){
 
 bool MapDataExists(int *ItemIndex, std::map<int,int> *MapPtr){
 
+	// Check if map data exists (for map<int,int>).
+
 	if (MapPtr->find(*ItemIndex) == MapPtr->end()){
 	
 		return FALSE;
-- 
2.39.5