Added comments to describe functions in common/timers.cpp

diff --git a/source/common/timers.cpp b/source/common/timers.cpp
index 739c29f..0184953 100644 (file)
--- a/source/common/timers.cpp
+++ b/source/common/timers.cpp
@@ -32,6 +32,8 @@
 
 void wxActTimer::Notify(){
 
+       // Notify function for wxActTimer.
+
        frmMain *frmMainPtrProc = static_cast<frmMain*>(frmMainPtr);
 
        wxCommandEvent shuffleevent(ACTMGR_SHUFFLE);
@@ -153,6 +155,8 @@ void wxActTimer::Notify(){
 void wxActTimer::SetBitmap(wxStaticBitmap *bitmap)
 {
     
+       // Set the bitmap for wxActTimer.
+    
        bmpActivity = bitmap;
     
 }
@@ -160,6 +164,8 @@ void wxActTimer::SetBitmap(wxStaticBitmap *bitmap)
 void wxActTimer::SetSleepBitmap(wxBitmap *SleepBitmap)
 {
     
+       // Set the sleep bitmap for wxActTimer.
+       
        SleepBitmapPtr = SleepBitmap;
     
 }
@@ -194,6 +200,8 @@ void wxActTimer::StartAnimation()
 void wxActTimer::ResetBitmap()
 {
     
+       // Reset the bitmap for wxActTimer.
+    
        intActivityProgress = 0;
     
 }
@@ -201,6 +209,8 @@ void wxActTimer::ResetBitmap()
 void wxActTimer::SetupPointer(void *frmMainPtrIn)
 {
     
+       // Setup the pointer for wxActTimer.
+    
        frmMainPtr = frmMainPtrIn;
     
 }
@@ -208,6 +218,8 @@ void wxActTimer::SetupPointer(void *frmMainPtrIn)
 void wxActProcessTimer::Notify()
 {
     
+       // Notify function for wxActProcessTimer.
+    
        // Pause the timer whilst processing to avoid problems.
     
        this->Stop();
@@ -221,12 +233,16 @@ void wxActProcessTimer::Notify()
 
 void wxActProcessTimer::SetupPointers(void *ActMgr){
     
+       // Setup pointers for the wxActProcessTimer.
+    
        ActMgrPtr = ActMgr;
     
 }
 
 void wxActListProcTimer::Notify(){
     
+       // Notify function for wxActListProcTimer.
+    
        // Setup Label and get task data (update SetupPointers subroutine).
     
        this->Stop();
@@ -337,6 +353,8 @@ void wxActListProcTimer::SetupPointers(std::map<int,int> *ActList, std::map<int,
                                        void *ActMgr, wxActTimer *ActTimer, wxActProcessTimer *ActProcessTimer,
                                        std::map<int,wxDateTime> *ActListFinDT, std::map<int, CardDAV*> *ActListConn){
     
+       // Setup the pointers for wxActListProcTimer.
+    
        ActListPtr = ActList;
        ActListUIPtr = ActListUI;
        ActListDetailPtr = ActListDetail;
@@ -354,12 +372,16 @@ void wxActListProcTimer::SetupPointers(std::map<int,int> *ActList, std::map<int,
 
 void wxActListProcTimer::EnableClearup(){
     
+       // Enable clearup of the wxActListProcTimer.
+    
        ClearupProcessed = TRUE;
     
 }
 
 void wxETagProcessTimer::Notify(){
     
+       // Notify function for wxETagProcessTimer.
+    
        // Check each ETagDB and see if writing to file is required.
     
        std::map<wxString,ETagDB>::iterator ETagIter;
@@ -435,6 +457,8 @@ void wxETagProcessTimer::ReloadAccounts(){
 
 ETagDB* wxETagProcessTimer::GetPointer(wxString AccountName){
     
+       // Get the pointer of the ETag Database.
+    
        ETagDB *ETagDBPtr = NULL;
     
        std::map<wxString,ETagDB>::iterator ETagIter;
@@ -453,6 +477,8 @@ ETagDB* wxETagProcessTimer::GetPointer(wxString AccountName){
 
 void wxContactFileMonitorTimer::Notify(){
     
+       // Notify function for wxContactFileMonitorTimer.
+    
        if (Filename.IsEmpty()){
         
                return;
@@ -478,6 +504,8 @@ void wxContactFileMonitorTimer::Notify(){
 
 void wxContactFileMonitorTimer::SetFilename(wxString FilenameInc){
     
+       // Set the filename for the wxContactFileMonitorTimer object.
+    
        Filename = FilenameInc;
     
        wxFileName FileCheck(Filename);
@@ -487,12 +515,16 @@ void wxContactFileMonitorTimer::SetFilename(wxString FilenameInc){
 
 void wxContactFileMonitorTimer::SetupPointers(frmContactEditor *frmCEPtrInc){
     
+       // Setup the pointers for the wxContactFileMonitorTimer object.
+    
        frmCEPtr = frmCEPtrInc;
     
 }
 
 void wxContactFileMonitorTimer::UpdateTimestamp(){
     
+       // Update the timestamp for the wxContactFileMonitorTimer object.
+    
        wxFileName FileCheck(Filename);
        FileDateTime = FileCheck.GetModificationTime();
     
@@ -500,16 +532,22 @@ void wxContactFileMonitorTimer::UpdateTimestamp(){
 
 void wxContactWindowMonitor::Notify(){
     
+       // Notify function for the wxContactWindowMonitor object.
+    
 }
 
 void wxContactWindowMonitor::SetupPointers(std::map<wxString, void*> *ContactWindowListPtrInc){
     
+       // Setup pointers for the wxContactWindowMonitor.
+    
        ContactWindowListPtr = ContactWindowListPtrInc;
     
 }
 
 void wxAccountSyncTimer::Notify(){
     
+       // Notify function for the wxAccountSyncTimer.
+    
        frmActivityMgr *ActMgrPtrProc = static_cast<frmActivityMgr*>(frmActMgrPtr);
     
        // Disable the timer. (Don't go updating unless needed).
@@ -539,6 +577,8 @@ void wxAccountSyncTimer::Notify(){
 void wxAccountSyncTimer::SetupData(wxString AccNameInc,
                                    wxString AccNameFullInc){
     
+       // Setup the data for the wxAccountSyncTimer object.
+    
        // Set the account name.
     
        AccName = AccNameInc;
@@ -549,7 +589,7 @@ void wxAccountSyncTimer::SetupData(wxString AccNameInc,
 void wxAccountSyncTimer::SetupPointers(void *frmMainPtrInc, 
                                        void *frmActMgrPtrInc, ETagDB *ETagDBPtrInc){
     
-       // Set the pointers.
+       // Setup the pointers for the wxAccountSyncTimer object.
     
        frmMainPtr = frmMainPtrInc;
        frmActMgrPtr = frmActMgrPtrInc;
@@ -559,6 +599,8 @@ void wxAccountSyncTimer::SetupPointers(void *frmMainPtrInc,
 
 void SleepFor(unsigned long longSleepNanoSecs){
     
+       // Sleep for specified nano seconds.
+    
 #ifdef __WIN32__
        ::Sleep((longSleepNanoSecs / 1000000));
 #elif __HAIKU__