From e241b43d3f4291eb55a2d8edf6464b938eab3756 Mon Sep 17 00:00:00 2001 From: Marian Buschsieweke Date: Tue, 9 Feb 2021 22:34:04 +0100 Subject: [PATCH] sys/ztimer: clearify doc on clock ops --- sys/include/ztimer.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/sys/include/ztimer.h b/sys/include/ztimer.h index 0b0bde9c5d..6c6068dcbc 100644 --- a/sys/include/ztimer.h +++ b/sys/include/ztimer.h @@ -294,16 +294,20 @@ typedef struct { typedef struct { /** * @brief Set a new timer target + * @param clock ztimer clock to set the new target + * @param val Relative target (e.g. fire at value `now() + val`) */ void (*set)(ztimer_clock_t *clock, uint32_t val); /** * @brief Get the current count of the timer + * @param clock ztimer clock to get the current time from */ uint32_t (*now)(ztimer_clock_t *clock); /** * @brief Cancel any set target + * @param clock ztimer clock to cancel a pending alarm, if any */ void (*cancel)(ztimer_clock_t *clock); } ztimer_ops_t;