document Modem and System classes

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);
 };