ztimer_periodic: fix example in documentation

benpicco · benpicco · commit 278d2c781cec · 2023-09-29T18:27:43.000+02:00
diff --git a/sys/include/ztimer/periodic.h b/sys/include/ztimer/periodic.h
@@ -25,9 +25,12 @@
  * ```
  * #include "ztimer/periodic.h"
  *
- * static void callback(void *arg)
+ * static bool callback(void *arg)
  * {
  *    puts(arg);
+ *
+ *    // keep the timer running
+ *    return true;
  * }
  *
  *

Original file line number	Diff line number	Diff line change
`@@ -25,9 +25,12 @@`
`25`	`25`	* ```
`26`	`26`	`* #include "ztimer/periodic.h"`
`27`	`27`	`*`
`28`		`- * static void callback(void *arg)`
	`28`	`+ * static bool callback(void *arg)`
`29`	`29`	`* {`
`30`	`30`	`* puts(arg);`
	`31`	`+ *`
	`32`	`+ * // keep the timer running`
	`33`	`+ * return true;`
`31`	`34`	`* }`
`32`	`35`	`*`
`33`	`36`	`*`