From b4c3d9840c99ce5d4e23eb0f646bd995f7d2c002 Mon Sep 17 00:00:00 2001
From: Paul Gilbert
Date: Fri, 1 May 2015 17:17:24 -1000
Subject: SHERLOCK: Extra method comments

---
 engines/sherlock/screen.cpp | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

(limited to 'engines/sherlock/screen.cpp')

diff --git a/engines/sherlock/screen.cpp b/engines/sherlock/screen.cpp
index 01d3b9155a..97b23e7c8e 100644
--- a/engines/sherlock/screen.cpp
+++ b/engines/sherlock/screen.cpp
@@ -50,6 +50,9 @@ Screen::~Screen() {
 	delete _font;
 }
 
+/**
+ * Set the font to use for writing text on the screen
+ */
 void Screen::setFont(int fontNumber) {
 	_fontNumber = fontNumber;
 	Common::String fname = Common::String::format("FONT%d.VGS", fontNumber + 1);
@@ -64,6 +67,9 @@ void Screen::setFont(int fontNumber) {
 		_fontHeight = MAX((uint16)_fontHeight, (*_font)[idx]._frame.h);
 }
 
+/**
+ * Handles updating any dirty areas of the screen Surface object to the physical screen
+ */
 void Screen::update() {
 	// Merge the dirty rects
 	mergeDirtyRects();
@@ -82,14 +88,23 @@ void Screen::update() {
 	_dirtyRects.clear();
 }
 
+/**
+ * Return the currently active palette
+ */
 void Screen::getPalette(byte palette[PALETTE_SIZE]) {
 	g_system->getPaletteManager()->grabPalette(palette, 0, PALETTE_COUNT);
 }
 
+/**
+ * Set the palette
+ */
 void Screen::setPalette(const byte palette[PALETTE_SIZE]) {
 	g_system->getPaletteManager()->setPalette(palette, 0, PALETTE_COUNT);
 }
 
+/**
+ * Fades from the currently active palette to the passed palette
+ */
 int Screen::equalizePalette(const byte palette[PALETTE_SIZE]) {
 	int total = 0;
 	byte tempPalette[PALETTE_SIZE];
-- 
cgit v1.2.3