some cleaning :)

[blank.git] / src / app / IntervalTimer.hpp

diff --git a/src/app/IntervalTimer.hpp b/src/app/IntervalTimer.hpp
index e5d02481e676d9c618388b626b9931f8caf6fc5a..0d6790be20850ebfb9276fc62f88b09408793917 100644 (file)
--- a/src/app/IntervalTimer.hpp
+++ b/src/app/IntervalTimer.hpp
@@ -4,9 +4,15 @@
 
 namespace blank {
 
+/// Timer that hits every n milliseconds. Resolution is that of the
+/// delta values passed to Update(), minimum 1ms.
+/// Also tracks the number of iterations as well as milliseconds
+/// passed.
 class IntervalTimer {
 
 public:
+       /// Create a timer that hits every interval_ms milliseconds.
+       /// Initial state is stopped.
        explicit IntervalTimer(int interval_ms) noexcept
        : intv(interval_ms) { }
 
@@ -21,6 +27,7 @@ public:
        bool Running() const noexcept {
                return speed != 0;
        }
+       /// true if an interval boundary was passed by the last call to Update()
        bool Hit() const noexcept {
                return Running() && value % intv < last_dt;
        }