From 17f34c56bc09e068f01b2a6173bbd6cdc17efa7d Mon Sep 17 00:00:00 2001 From: Wessel Nieboer Date: Mon, 9 Mar 2026 14:50:58 +0100 Subject: [PATCH] Upgrade to Doxygen comment --- src/helpers/ArduinoHelpers.h | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/src/helpers/ArduinoHelpers.h b/src/helpers/ArduinoHelpers.h index e5bb15daf..4e80f5c12 100644 --- a/src/helpers/ArduinoHelpers.h +++ b/src/helpers/ArduinoHelpers.h @@ -24,8 +24,13 @@ public: unsigned long getMillis() override { return millis(); } }; -// Wrap-safe millis deadline check. Handles the 49-day millis() overflow -// using signed comparison (2's complement). Use instead of millis() >= target. +/** + * \brief Wrap-safe millis deadline check, handling the 49-day millis() overflow. + * \param target The deadline timestamp obtained from millis() + delay. + * \returns true when the deadline has passed. + * \note Use this instead of \c millis()>=target which fails near the 32-bit wrap. + * Works via signed subtraction (2's complement). + */ inline bool millis_passed(unsigned long target) { return (long)(millis() - target) > 0; }