From: Steve Brokenshire <sbrokenshire@xestia.co.uk>
Date: Sun, 6 Mar 2016 23:12:01 +0000 (+0000)
Subject: Added basic comments to the functions of frmContact
X-Git-Tag: release-0.11~178
X-Git-Url: http://Server1/repobrowser/?a=commitdiff_plain;h=07a4acbcc7762d0f74847c809d9ea058dfdf861c;p=xestiaab%2F.git

Added basic comments to the functions of frmContact
---

diff --git a/source/frmContact.cpp b/source/frmContact.cpp
index a94c876..5df8728 100644
--- a/source/frmContact.cpp
+++ b/source/frmContact.cpp
@@ -39,6 +39,8 @@ void frmContact::CloseWindowProcessing(){
 
 void frmContact::CloseWindow( wxCommandEvent& event ){
 		
+	// Close this window.
+	
 	this->Close();
 
 }
@@ -50,6 +52,9 @@ void frmContact::CloseWindow( wxCloseEvent& event ){
 
 	wxFileSystem::AddHandler(new wxMemoryFSHandler);
 
+	// Check if frmContact is the main window, if not
+	// then do some clear up.
+	
 	if (StartupMode == false){
 	
 		if (MemoryFSListPtr->find(SessionID) == MemoryFSListPtr->end()){
@@ -95,6 +100,8 @@ void frmContact::CloseWindow( wxCloseEvent& event ){
 
 bool frmContact::SetupContactData(vCard *vCardObj){
 
+	// Setup the contact information.
+	
 	wxFileSystem::AddHandler(new wxMemoryFSHandler);
 	
 	for (std::map<wxString, wxString>::iterator striter = MemoryFSListPtr->begin();
@@ -144,24 +151,32 @@ bool frmContact::SetupContactData(vCard *vCardObj){
 
 void frmContact::SetMode(bool StartupModeIn){
 
+	// Set the mode which frmContact will be operating.
+	
 	StartupMode = StartupModeIn;
 	
 }
 
 void frmContact::SetupPointers(std::map<wxString,wxString> *MemoryFSListIncPtr){
 
+	// Set the pointer for the Memory Filesystem map.
+	
 	MemoryFSListPtr = MemoryFSListIncPtr;
 
 }
 
 void frmContact::SetUID(int UID){
 
+	// Set the UID of the contact window.
+	
 	ContactUID = UID;
 
 }
 
 wxString frmContact::GetFilename(){
 
+	// Get the filename of the contact being displayed.
+	
 	return vCardFilename;
 
 }
\ No newline at end of file