From 7e0240ab14d29401877ff0c4d827be859e13ea58 Mon Sep 17 00:00:00 2001
From: Max Horn
Date: Mon, 28 Jun 2010 11:20:51 +0000
Subject: SCI: Comment cleanup

svn-id: r50423
---
 engines/sci/graphics/screen.h | 34 ++++++++++++++++++++++------------
 1 file changed, 22 insertions(+), 12 deletions(-)

(limited to 'engines/sci/graphics/screen.h')

diff --git a/engines/sci/graphics/screen.h b/engines/sci/graphics/screen.h
index c1e10fabc8..03dfd3529c 100644
--- a/engines/sci/graphics/screen.h
+++ b/engines/sci/graphics/screen.h
@@ -55,9 +55,12 @@ enum {
 };
 
 /**
- * Screen class, actually creates 3 (4) screens internally - which is visual/display (for the user),
- *  priority (contains priority information) and control (contains control information). Handles all operations to it
- *  and copies parts of visual/display screen to the actual screen, so the user can really see it.
+ * Screen class, actually creates 3 (4) screens internally:
+ * - visual/display (for the user),
+ * - priority (contains priority information) and
+ * - control (contains control information).
+ * Handles all operations to it and copies parts of visual/display screen to
+ * the actual screen, so the user can really see it.
  */
 class GfxScreen {
 public:
@@ -85,10 +88,10 @@ public:
 	void drawLine(int16 left, int16 top, int16 right, int16 bottom, byte color, byte prio, byte control) {
 		drawLine(Common::Point(left, top), Common::Point(right, bottom), color, prio, control);
 	}
-	int getUpscaledHires() {
+	int getUpscaledHires() const {
 		return _upscaledHires;
 	}
-	bool getUnditherState() {
+	bool getUnditherState() const {
 		return _unditherState;
 	}
 	void putKanjiChar(Graphics::FontSJIS *commonFont, int16 x, int16 y, uint16 chr, byte color);
@@ -140,27 +143,34 @@ private:
 	bool _unditherState;
 	int16 _unditherMemorial[SCI_SCREEN_UNDITHERMEMORIAL_SIZE];
 
-	// these screens have the real resolution of the game engine (320x200 for SCI0/SCI1/SCI11 games, 640x480 for SCI2 games)
-	//  SCI0 games will be dithered in here at any time
+	// These screens have the real resolution of the game engine (320x200 for
+	// SCI0/SCI1/SCI11 games, 640x480 for SCI2 games). SCI0 games will be
+	// dithered in here at any time.
 	byte *_visualScreen;
 	byte *_priorityScreen;
 	byte *_controlScreen;
 
-	// this screen is the one that is actually displayed to the user. It may be 640x400 for japanese SCI1 games
-	//  SCI0 games may be undithered in here. Only read from this buffer for Save/ShowBits usage.
+	// This screen is the one that is actually displayed to the user. It may be
+	// 640x400 for japanese SCI1 games. SCI0 games may be undithered in here.
+	// Only read from this buffer for Save/ShowBits usage.
 	byte *_displayScreen;
 
 	Common::Rect getScaledRect(Common::Rect rect);
 
 	ResourceManager *_resMan;
 
-	// this is a pointer to the currently active screen (changing it only required for debug purposes)
+	/**
+	 * Pointer to the currently active screen (changing it only required for
+	 * debug purposes).
+	 */
 	byte *_activeScreen;
 
-	// this variable defines, if upscaled hires is active and what upscaled mode is used
+	// This variable defines, if upscaled hires is active and what upscaled mode
+	// is used.
 	int _upscaledHires;
 
-	// this here holds a translation for vertical coordinates between native (visual) and actual (display) screen
+	// This here holds a translation for vertical coordinates between native
+	// (visual) and actual (display) screen.
 	int _upscaledMapping[SCI_SCREEN_UPSCALEDMAXHEIGHT + 1];
 };
 
-- 
cgit v1.2.3