Diff: Timer64.h

Revision:

5:e2a2d9790e36

Parent:

4:9ca673a83acb

Child:

7:381bafbb2218

--- a/Timer64.h	Mon Mar 28 20:56:40 2016 +0000
+++ b/Timer64.h	Mon Mar 28 21:05:49 2016 +0000
@@ -43,7 +43,7 @@
  *  Used to define a 64 bit timer64 that is thread safe.  The Timer64 behaves in a 
  *  similiar fashion to the mbed Timer class with the most notable exception that 
  *  the Timer64 will not rollover after 2^31 microseconds (approximately 35.8 minutes).
- *  The Timer64 extends the rollover time to 2^64 microsecnods (approximately 585,000 years!)
+ *  The Timer64 extends the rollover time to 2^64 microseconds (approximately 585,000 years!)
  *
  *  The Timer64 class is also designed to be thread safe. The following functions can be 
  *  called from any thread after the class is instaniated and initialized:
@@ -104,7 +104,7 @@
      *      TIMER64_MIN_ROLLOVER_CHECK_IN_MSECS
      *
      *  @returns
-     *      TIMER64_OK
+     *      TIMER64_OK,
      *      TIMER64_WARNING_ALREADY_INITIALIZED
      */
     int init(uint32_t rolloverCheckTimeInMsecc = TIMER64_DEFAULT_ROLLOVER_CHECK_IN_MSECS);
@@ -112,7 +112,7 @@
     /** Release the timer - must be called from the same thread calling init()
      *  
      *  @returns
-     *      TIMER64_OK
+     *      TIMER64_OK,
      *      TIMER64_WARNING_ALREADY_RELEASED
      */
     int release(void);
@@ -120,8 +120,8 @@
     /** Start the timer - this method is thread safe
      *  
      *  @returns
-     *      TIMER64_OK
-     *      TIMER64_ERROR_NOT_INITIALIZED
+     *      TIMER64_OK,
+     *      TIMER64_ERROR_NOT_INITIALIZED,
      *      TIMER64_WARNING_ALREADY_RUNNING
      */
     int start(void);
@@ -129,8 +129,8 @@
     /** Stop the timer - this method is thread safe
      *  
      *  @returns
-     *      TIMER64_OK
-     *      TIMER64_ERROR_NOT_INITIALIZED
+     *      TIMER64_OK,
+     *      TIMER64_ERROR_NOT_INITIALIZED,
      *      TIMER64_WARNING_ALREADY_STOPPED
      */
     int stop(void);
@@ -138,7 +138,7 @@
     /** Reset the timer - this method is thread safe
      *  
      *  @returns
-     *      TIMER64_OK
+     *      TIMER64_OK,
      *      TIMER64_ERROR_NOT_INITIALIZED
      */
     int reset(void);
@@ -148,8 +148,8 @@
      *  @param timeInUsec specifies a pointer to a uint64_t where to save the current time in microseconds
      *
      *  @returns
-     *      TIMER64_OK
-     *      TIMER64_ERROR_NOT_INITIALIZED
+     *      TIMER64_OK,
+     *      TIMER64_ERROR_NOT_INITIALIZED,
      *      TIMER64_ERROR_NULL_POINTER
      */
     int read_us(uint64_t* timeInUsec = NULL);
@@ -159,8 +159,8 @@
      *  @param timeInMsec specifies a pointer to a uint64_t where to save the current time in milliseconds
      *
      *  @returns
-     *      TIMER64_OK
-     *      TIMER64_ERROR_NOT_INITIALIZED
+     *      TIMER64_OK,
+     *      TIMER64_ERROR_NOT_INITIALIZED,
      *      TIMER64_ERROR_NULL_POINTER
      */
     int read_ms(uint64_t* timeInMsec = NULL);
@@ -170,9 +170,9 @@
      *  @param timeInMsec specifies a pointer to a double where to save the current time in seconds
      *
      *  @returns
-     *      TIMER64_OK
-     *      TIMER64_ERROR_NOT_INITIALIZED
-     *      TIMER64_ERROR_NULL_POINTER
+     *      TIMER64_OK,
+     *      TIMER64_ERROR_NOT_INITIALIZED,
+     *      TIMER64_ERROR_NULL_POINTER,
      */
     int read(double* timeInSec = NULL);
     
@@ -181,8 +181,8 @@
      *  @param running specifies a pointer to a bool where to save the running status
      *
      *  @returns
-     *      TIMER64_OK
-     *      TIMER64_ERROR_NOT_INITIALIZED
+     *      TIMER64_OK,
+     *      TIMER64_ERROR_NOT_INITIALIZED,
      *      TIMER64_ERROR_NULL_POINTER
      */
     int isRunning(bool* running);