Skip to content

Commit

Permalink
Merge pull request #15975 from maribu/ztimer-doc
Browse files Browse the repository at this point in the history
sys/ztimer: clearify doc on clock ops
  • Loading branch information
maribu authored Feb 10, 2021
2 parents 6d0942a + e241b43 commit d7f3e92
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions sys/include/ztimer.h
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down

0 comments on commit d7f3e92

Please sign in to comment.