diff options
Diffstat (limited to 'src/timer.hpp')
| -rw-r--r-- | src/timer.hpp | 17 |
1 files changed, 13 insertions, 4 deletions
diff --git a/src/timer.hpp b/src/timer.hpp index 0454a802..7d0e4669 100644 --- a/src/timer.hpp +++ b/src/timer.hpp @@ -19,15 +19,24 @@ #include <sys/timeb.h> +/* + * @brief return epoch in milliseconds + * + * @return long long int epoch in milliseconds + */ typedef long long int (*TimeFunction)(); /** - * @brief: A frequency counting clock. + * @struct FrequencyClock + * @brief A frequency counting clock. * - * frequency - the clock frequency in Hz. - * last_time - the last time (in milliseconds since startup) that the clock + * @var FrequencyClock::frequency + * the clock frequency in Hz. + * @var FrequencyClock::last_time + * the last time (in milliseconds since startup) that the clock * ticked. - * time_function - a function returning current time + * @var FrequencyClock::time_function + * a function returning current time */ typedef struct { float frequency; |