Detailed method documentation

Author: wizard97

src/ProcessScheduler/Includes.h

@@ -11,9 +11,12 @@ class Process;
 
 typedef enum ProcessWarning
 {
+    // This Process is scheduled to often
     WARNING_PROC_OVERSCHEDULED = 0,
 
 #ifdef _PROCESS_TIMEOUT_INTERRUPTS
+    // The scheduler interrupted your process service routine because it was taking longer than timeout set
+    // This will likley leave you Process in an unknown state, perhaps call restart()
     WARNING_PROC_TIMED_OUT
 #endif
 } ProcessWarning;

src/ProcessScheduler/Process.cpp

@@ -3,23 +3,31 @@
 
     /*********** PUBLIC *************/
     Process::Process(Scheduler &scheduler, ProcPriority priority, uint32_t period,
-            int iterations, int16_t overSchedThresh)
+            int iterations, uint16_t overSchedThresh)
     : _scheduler(scheduler), _pLevel(priority)
     {
         this->_enabled = false;
         this->_period = period;
         this->_iterations = iterations;
-        this->_scheduledTS = _scheduler.getCurrTS();
-        this->_actualTS = _scheduler.getCurrTS();
         this->_force = false;
         this->_overSchedThresh = overSchedThresh;
-        this->_pBehind = 0;
+        resetTimeStamps();
+
 #ifdef _PROCESS_TIMEOUT_INTERRUPTS
         setTimeout(PROCESS_NO_TIMEOUT);
 #endif
     }
 
-
+    void Process::resetTimeStamps()
+    {
+        ATOMIC_START
+        {
+        this->_scheduledTS = _scheduler.getCurrTS();
+        this->_actualTS = _scheduler.getCurrTS();
+        this->_pBehind = 0;
+        }
+        ATOMIC_END
+    }
 
     bool Process::disable()
     {