/**
* @file
* @brief platform neutral timing utilities
- * @version $Id: tv.h 17143 2008-01-02 20:56:33Z beck $
*/
#ifndef FIRM_TIMING_H
#define FIRM_TIMING_H
#include "begin.h"
+/**
+ * A timer
+ *
+ * A timer can be started/stopped multiple times and measures the (wallclock)
+ * time spent between start and stop calls.
+ */
typedef struct ir_timer_t ir_timer_t;
/**
FIRM_API int ir_timer_leave_high_priority(void);
/**
- * Get the amount of bytes allocated on the heap.
+ * Returns the amount of bytes allocated on the heap.
* @return The number of bytes allocated on the heap.
*/
FIRM_API size_t ir_get_heap_used_bytes(void);
/**
* Create a new timer
* @return The timer.
+ * @see #ir_timer_t
*/
FIRM_API ir_timer_t *ir_timer_new(void);
FIRM_API ir_timer_t *ir_timer_pop(void);
/**
- * Get the number of milliseconds, the timer has elapsed.
+ * Returns the number of milliseconds, the timer has elapsed.
* @param timer The timer.
* @return The number of milliseconds the timer is (was) running.
*/
FIRM_API unsigned long ir_timer_elapsed_msec(const ir_timer_t *timer);
/**
- * Get the number of microseconds, the timer has elapsed.
+ * Returns the number of microseconds, the timer has elapsed.
* @param timer The timer.
* @return The number of milliseconds the timer is (was) running.
*/