sys/xtimer: improve documentation

maribu · maribu · commit 9454a50df344 · 2023-05-30T17:32:48.000+02:00
- Add a deprecation note to xtimer, so that new code hopefully
  starts using ztimer
- Add a hint that `ztimer_xtimer_compat` can be used even after `xtimer`
  is gone
diff --git a/sys/include/xtimer.h b/sys/include/xtimer.h
@@ -8,18 +8,31 @@
  */
 
 /**
- * @defgroup  sys_xtimer Timers
- * @ingroup   sys
- * @brief     Provides a high level timer module to register
- *            timers, get current system time, and let a thread sleep for
- *            a certain amount of time.
+ * @defgroup    sys_xtimer xtimer high level timer abstraction layer (deprecated)
+ * @ingroup     sys
+ * @brief       Provides a high level timer module to register
+ *              timers, get current system time, and let a thread sleep for
+ *              a certain amount of time.
  *
  * The implementation takes one low-level timer and multiplexes it.
  *
  * Insertion and removal of timers has O(n) complexity with (n) being the
  * number of active timers.  The reason for this is that multiplexing is
  * realized by next-first singly linked lists.
  *
+ * @deprecated  xtimer has been deprecated in favor of the @ref sys_ztimer
+ * @note        With @ref sys_ztimer_xtimer_compat a compatibility wrapper is
+ *              provided that in the vast majority of cases can function as a
+ *              drop-in replacement. This compatibility wrapper is expected to
+ *              replace `xtimer` in the near future and ensure that code still
+ *              depending on the `xtimer` API continues to function.
+ * @details     Note that at least for long running timers, using
+ *              @ref sys_ztimer instead of the compatibility layer can yield
+ *              lower clock drift and lower power consumption compared to
+ *              using the compatibility layer. For details on how to achieve
+ *              lower clock drift and lower power consumption please consult the
+ *              @ref sys_ztimer documentation.
+ *
  * @{
  * @file
  * @brief   xtimer interface definitions
