From 602d17f5fd3f3d89716be9f2975f644512aeb12d Mon Sep 17 00:00:00 2001
From: Alexander Tkachev
Date: Sat, 4 Jun 2016 20:37:47 +0600
Subject: CLOUD: Document CloudIcon::draw() more precisely

---
 backends/networking/curl/cloudicon.h | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

(limited to 'backends')

diff --git a/backends/networking/curl/cloudicon.h b/backends/networking/curl/cloudicon.h
index e981dda611..9b30a8640d 100644
--- a/backends/networking/curl/cloudicon.h
+++ b/backends/networking/curl/cloudicon.h
@@ -42,7 +42,21 @@ public:
 	CloudIcon();
 	~CloudIcon();
 
-	/** Returns true if ConnMan's timer could be stopped. */
+	/**
+	 * This method is called from ConnectionManager every time
+	 * its own timer calls the handle() method. The primary
+	 * responsibility of this draw() method is to draw cloud icon
+	 * on ScummVM's OSD when current cloud Storage is working.
+	 *
+	 * As we don't want ConnectionManager to work when no
+	 * Requests are running, we'd like to stop the timer. But then
+	 * this icon wouldn't have time to disappear smoothly. So,
+	 * in order to do that, ConnectionManager stop its timer
+	 * only when this draw() method returns true, indicating that
+	 * the CloudIcon has disappeared and the timer could be stopped.
+	 *
+	 * @return true if ConnMan's timer could be stopped.
+	 */
 	bool draw();
 };
 
-- 
cgit v1.2.3