diff options
author | Daniel Friesel <derf@finalrewind.org> | 2016-01-31 18:44:23 +0100 |
---|---|---|
committer | Daniel Friesel <derf@finalrewind.org> | 2016-01-31 18:44:23 +0100 |
commit | d9f650fc6e723dabeccc800c16ca4d809f4bb94a (patch) | |
tree | 8680c16baba6b863c63e1be5fd1e183e9ff08f17 /src/system.h | |
parent | 631ccf9ba6924d5af077bf31ef84f1212b471f3d (diff) |
document Modem and System classes
Diffstat (limited to 'src/system.h')
-rw-r--r-- | src/system.h | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/src/system.h b/src/system.h index 6e2d1b0..b36e348 100644 --- a/src/system.h +++ b/src/system.h @@ -16,6 +16,14 @@ class System { void shutdown(void); public: System() { want_shutdown = 0; }; + + /** + * System idle loop. Checks for button presses, handles + * standby/resume, reads data from the Modem and updates the Display. + * + * It is recommended to run this function before going back to sleep + * whenever the system is woken up by an interrupt. + */ void loop(void); }; |