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

---
 .../contacteditor/frmContactEditorRelated.cpp  | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/source/contacteditor/frmContactEditorRelated.cpp b/source/contacteditor/frmContactEditorRelated.cpp
index 04cc162..6d94ef5 100644
--- a/source/contacteditor/frmContactEditorRelated.cpp
+++ b/source/contacteditor/frmContactEditorRelated.cpp
@@ -26,6 +26,8 @@ frmContactEditorRelated::frmContactEditorRelated( wxWindow* parent )
 frmContactEditorRelatedADT( parent )
 {
 	
+	// Setup the window.
+	
 	EditorMode = FALSE;
 	sliPriority->Disable();
 	
@@ -56,15 +58,22 @@ frmContactEditorRelatedADT( parent )
 
 void frmContactEditorRelated::EnablePriority( wxCommandEvent& event )
 {
+	
+	// Enable/disable the priority setting.
+	
 	if (chkUsePref->IsChecked()){
 		sliPriority->Enable();
 	} else {
 		sliPriority->Disable();
 	}
+	
 }
 
 void frmContactEditorRelated::SetEditorMode(bool EditMode, SectionType SectType)
 {
+	
+	// Set the editor mode.
+	
 	if (EditMode == FALSE){
 	
 		EditorMode = FALSE;
@@ -213,6 +222,9 @@ void frmContactEditorRelated::SetEditorMode(bool EditMode, SectionType SectType)
 
 void frmContactEditorRelated::ProcessData( wxCommandEvent& event )
 {
+	
+	// Process data.
+	
 	long ListCtrlIndex;
 	
 	if (EditorMode == FALSE){
@@ -502,7 +514,11 @@ void frmContactEditorRelated::ProcessData( wxCommandEvent& event )
 
 void frmContactEditorRelated::CloseWindow( wxCommandEvent& event )
 {
+	
+	// Close this window.
+	
 	this->Close();
+	
 }
 
 void frmContactEditorRelated::SetupPointers(std::map<int, wxString> *RelatedList,
@@ -516,6 +532,8 @@ void frmContactEditorRelated::SetupPointers(std::map<int, wxString> *RelatedList
 	int RelatedIndex )
 {
 
+	// Setup the pointers.
+	
 	RelatedListPtr = RelatedList;
 	RelatedListRelTypePtr = RelatedListRelType;	
 	RelatedListAltIDPtr = RelatedListAltID;
-- 
2.39.5