From be42f800a448798819b5ccedbb0a2aca3133730f Mon Sep 17 00:00:00 2001
From: Johannes Schickel
Date: Wed, 10 Jun 2009 15:11:17 +0000
Subject: Extend documentation for "kFeatureCursorHasPalette".

svn-id: r41430
---
 common/system.h | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'common/system.h')

diff --git a/common/system.h b/common/system.h
index 5b72dab7c1..9cfb7dd511 100644
--- a/common/system.h
+++ b/common/system.h
@@ -148,6 +148,10 @@ public:
 		 * It is currently used only by some Macintosh versions of Humongous
 		 * Entertainment games. If the backend doesn't implement this feature then
 		 * the engine switches to b/w versions of cursors.
+		 * The GUI also relies on this feature for mouse cursors.
+		 *
+		 * To enable the cursor palette call "disableCursorPalette" with false.
+		 * @see disableCursorPalette
 		 */
 		kFeatureCursorHasPalette,
 
-- 
cgit v1.2.3