From b37beb4493f69de1e2338fcf10bb1852ba864bc7 Mon Sep 17 00:00:00 2001
From: Johannes Schickel
Date: Mon, 29 Jun 2009 23:23:29 +0000
Subject: Add some more explanation to Graphics::CursorManager::showMouse and
 OSystem::showMouse.

svn-id: r41968
---
 common/system.h | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

(limited to 'common/system.h')

diff --git a/common/system.h b/common/system.h
index a8f3b1c903..5b3c208661 100644
--- a/common/system.h
+++ b/common/system.h
@@ -673,7 +673,18 @@ public:
 	 */
 	//@{
 
-	/** Show or hide the mouse cursor. */
+	/**
+	 * Show or hide the mouse cursor.
+	 *
+	 * Currently the backend is not required to immediately draw the
+	 * mouse cursor on showMouse(true).
+	 *
+	 * TODO: We might want to reconsider this fact,
+	 * check Graphics::CursorManager::showMouse for some details about
+	 * this.
+	 *
+	 * @see Graphics::CursorManager::showMouse
+	 */
 	virtual bool showMouse(bool visible) = 0;
 
 	/**
-- 
cgit v1.2.3