From 3795d07c6f07fa25dbe9cbd4259af794078035e3 Mon Sep 17 00:00:00 2001 From: Karl Fessel Date: Fri, 13 May 2022 20:01:47 +0200 Subject: [PATCH] ztimer: add module removal information to doxygen --- sys/include/ztimer.h | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/sys/include/ztimer.h b/sys/include/ztimer.h index 4c4ffb339496..a0518925be2c 100644 --- a/sys/include/ztimer.h +++ b/sys/include/ztimer.h @@ -301,13 +301,26 @@ struct ztimer_base { uint32_t offset; /**< offset from last timer in list */ }; +/** + * @defgroup ztimer_now64 ztimer_now64 + * @deprecated use uint32_t or ztimer64, will be removed after 2022.07 release. + * + * @brief deprecated module changes deprecated ztimer_now_t type + * + * use ztimer_now() returning uint32_t or alternatively use module ztimer64 + * ztimer64_now() returning uint64_t. + * @{ + */ #if MODULE_ZTIMER_NOW64 typedef uint64_t ztimer_now_t; /**< type for ztimer_now() result - * @deprecated use uint32_t or ztimer64 */ + * @deprecated use uint32_t or ztimer64, + * will be removed after 2022.07 release. */ #else typedef uint32_t ztimer_now_t; /**< type for ztimer_now() result - * @deprecated use uint32_t or ztimer64 */ + * @deprecated use uint32_t or ztimer64, + * will be removed after 2022.07 release. */ #endif +/** @}*/ /** * @brief ztimer structure