summaryrefslogtreecommitdiffstats
path: root/src/timer.hpp
diff options
context:
space:
mode:
authorRomain Forlot <romain.forlot@iot.bzh>2017-02-22 13:06:24 +0100
committerRomain Forlot <romain.forlot@iot.bzh>2017-02-22 15:28:12 +0100
commit836feaecd602e86ea6d954ae018a2d7bbc04aa7a (patch)
tree4bb43361e8fe8a58505a64fd50ade04000c18d60 /src/timer.hpp
parent747d58ad84d230f6cf11ac818bab65019df83611 (diff)
Change way to convert simplemessage into a json
object. Improve doxygen comments Change-Id: I794bdc10f9e1ce66ebd4e68dbd6e0c465e3ca5c4 Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
Diffstat (limited to 'src/timer.hpp')
-rw-r--r--src/timer.hpp17
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;