From 5547c39c9106bce791e1b3b67b1a0b9d26ef2279 Mon Sep 17 00:00:00 2001 From: Thomas Harte Date: Fri, 24 Aug 2018 20:06:40 -0400 Subject: [PATCH] Corrects documentation. --- ClockReceiver/ClockDeferrer.hpp | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/ClockReceiver/ClockDeferrer.hpp b/ClockReceiver/ClockDeferrer.hpp index 1b9d2e01e..838739e4b 100644 --- a/ClockReceiver/ClockDeferrer.hpp +++ b/ClockReceiver/ClockDeferrer.hpp @@ -15,13 +15,10 @@ A ClockDeferrer maintains a list of ordered actions and the times at which they should happen, and divides a total execution period up into the portions that occur between those actions, triggering each action when it is reached. - - @c Class should be a class that implements @c advance(TimeUnit), to advance - that amount of time. */ template class ClockDeferrer { public: - /// Constructs a ClockDeferrer that will call target.advance in between deferred actions. + /// Constructs a ClockDeferrer that will call target(period) in between deferred actions. ClockDeferrer(std::function &&target) : target_(std::move(target)) {} /*! @@ -37,7 +34,7 @@ template class ClockDeferrer { /*! Runs for @c length units of time. - The target's @c advance will be called with one or more periods that add up to @c length; + The constructor-supplied target will be called with one or more periods that add up to @c length; any scheduled actions will be called between periods. */ void run_for(TimeUnit length) {