6502/CLK
1
0
Fork 0
mirror of https://github.com/TomHarte/CLK.git synced 2025-08-15 14:27:29 +00:00
Code Issues Projects Releases Wiki Activity

Corrects documentation.

Browse Source
This commit is contained in:
Thomas Harte
2018-08-24 20:06:40 -04:00
parent 97a89aaf4d
commit 5547c39c91
1 changed files with 2 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
ClockReceiver/ClockDeferrer.hpp
View File

@@ -15,13 +15,10 @@
A ClockDeferrer maintains a list of ordered actions and the times at which 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 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. 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 <typename TimeUnit> class ClockDeferrer { template <typename TimeUnit> class ClockDeferrer {
public: 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<void(TimeUnit)> &&target) : target_(std::move(target)) {} ClockDeferrer(std::function<void(TimeUnit)> &&target) : target_(std::move(target)) {}
/*! /*!
@@ -37,7 +34,7 @@ template <typename TimeUnit> class ClockDeferrer {
/*! /*!
Runs for @c length units of time. 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. any scheduled actions will be called between periods.
*/ */
void run_for(TimeUnit length) { void run_for(TimeUnit length) {