Skip to content

Commit e811615

Browse files
committed
Upgrade to Doxygen comment
1 parent 6b8ea68 commit e811615

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

src/helpers/ArduinoHelpers.h

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,13 @@ class ArduinoMillis : public mesh::MillisecondClock {
2424
unsigned long getMillis() override { return millis(); }
2525
};
2626

27-
// Wrap-safe millis deadline check. Handles the 49-day millis() overflow
28-
// using signed comparison (2's complement). Use instead of millis() >= target.
27+
/**
28+
* \brief Wrap-safe millis deadline check, handling the 49-day millis() overflow.
29+
* \param target The deadline timestamp obtained from millis() + delay.
30+
* \returns true when the deadline has passed.
31+
* \note Use this instead of \c millis()>=target which fails near the 32-bit wrap.
32+
* Works via signed subtraction (2's complement).
33+
*/
2934
inline bool millis_passed(unsigned long target) {
3035
return (long)(millis() - target) > 0;
3136
}

0 commit comments

Comments
 (0)