From d3bde9bcf9fa18ceab666b7e9ac1118eed8c469d Mon Sep 17 00:00:00 2001 From: Pavel Kirienko Date: Sat, 26 Jul 2014 02:06:59 +0400 Subject: [PATCH] Timer API doc clarification --- libuavcan/include/uavcan/node/timer.hpp | 2 ++ 1 file changed, 2 insertions(+) diff --git a/libuavcan/include/uavcan/node/timer.hpp b/libuavcan/include/uavcan/node/timer.hpp index df25bab5a0..95ed0096c1 100644 --- a/libuavcan/include/uavcan/node/timer.hpp +++ b/libuavcan/include/uavcan/node/timer.hpp @@ -62,6 +62,8 @@ public: /** * Various ways to start the timer - periodically or once. * If it is running already, it will be restarted. + * If the deadline is in the past, the event will fire immediately. + * In periodic mode the timer does not accumulate error over time. */ void startOneShotWithDeadline(MonotonicTime deadline); void startOneShotWithDelay(MonotonicDuration delay);