From 6454508db861fb44634eab43180f26c176686f03 Mon Sep 17 00:00:00 2001
From: Thomas Harte <thomas.harte@gmail.com>
Date: Sun, 18 Sep 2016 10:30:52 -0400
Subject: [PATCH] Added a quick bit of documentation.

---
 Storage/TimedEventLoop.hpp | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/Storage/TimedEventLoop.hpp b/Storage/TimedEventLoop.hpp
index 53ac7c07a..c939a7827 100644
--- a/Storage/TimedEventLoop.hpp
+++ b/Storage/TimedEventLoop.hpp
@@ -48,6 +48,9 @@ namespace Storage {
 			*/
 			void run_for_cycles(int number_of_cycles);
 
+			/*!
+				@returns the number of whole cycles remaining until the next event is triggered.
+			*/
 			unsigned int get_cycles_until_next_event();
 
 		protected: