From e6bf1131dcc4ca776a00220030fdffa0c7146908 Mon Sep 17 00:00:00 2001
From: Steve Brokenshire <sbrokenshire@xestia.co.uk>
Date: Sun, 13 Mar 2016 10:11:47 +0000
Subject: [PATCH] Added comments to describe functions in frmContactEditorRoles

---
 .../contacteditor/frmContactEditorRoles.cpp   | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/source/contacteditor/frmContactEditorRoles.cpp b/source/contacteditor/frmContactEditorRoles.cpp
index 81d21fc..30a20b4 100644
--- a/source/contacteditor/frmContactEditorRoles.cpp
+++ b/source/contacteditor/frmContactEditorRoles.cpp
@@ -26,21 +26,31 @@ frmContactEditorRoles::frmContactEditorRoles( wxWindow* parent )
 :
 frmContactEditorRolesADT( parent )
 {
+	
+	// Setup the window.
+	
 	EditorMode = FALSE;
 	sliPriority->Disable();
 }
 
 void frmContactEditorRoles::EnablePriority( wxCommandEvent& event )
 {
+	
+	// Enable/disable the priority setting.
+	
 	if (chkUsePref->IsChecked()){
 		sliPriority->Enable();
 	} else {
 		sliPriority->Disable();
 	}
+	
 }
 
 void frmContactEditorRoles::ProcessAction( wxCommandEvent& event )
 {
+	
+	// Process action.
+	
 	// Set if the editor is adding or editing an address.
 	// FALSE = Add
 	// TRUE = Edit
@@ -151,6 +161,9 @@ void frmContactEditorRoles::ProcessAction( wxCommandEvent& event )
 
 void frmContactEditorRoles::SetEditorMode(bool EditMode, SectionType SectType)
 {
+	
+	// Set the editor mode.
+	
 	// Set if the editor is adding or editing an address.
 	// FALSE = Add
 	// TRUE = Edit
@@ -206,7 +219,11 @@ void frmContactEditorRoles::SetEditorMode(bool EditMode, SectionType SectType)
 
 void frmContactEditorRoles::CloseWindow( wxCommandEvent& event )
 {
+	
+	// Close this window.
+	
 	this->Close();
+	
 }
 
 void frmContactEditorRoles::SetupPointers(std::map<int, wxString> *RolesList,
@@ -220,6 +237,8 @@ void frmContactEditorRoles::SetupPointers(std::map<int, wxString> *RolesList,
 	int RolesIndex )
 {
 
+	// Setup the pointers.
+	
 	RolesListPtr = RolesList;
 	RolesListLanguagePtr = RolesListLanguage;
 	RolesListAltIDPtr = RolesListAltID;
-- 
2.39.5