From f5e39fa61d9a2ca46010c37701bd11547e3aa27f Mon Sep 17 00:00:00 2001
From: Denis Kasak
Date: Mon, 22 Jun 2009 20:13:25 +0000
Subject: * Expanded docs for the Sprite class * Added Surface and Screen docs
 * Small documentation fixes

svn-id: r41779
---
 engines/draci/surface.cpp | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

(limited to 'engines/draci/surface.cpp')

diff --git a/engines/draci/surface.cpp b/engines/draci/surface.cpp
index 1c7fce08b5..148c24633b 100644
--- a/engines/draci/surface.cpp
+++ b/engines/draci/surface.cpp
@@ -38,6 +38,10 @@ Surface::~Surface() {
 	this->free();
 }
 
+/**
+ * @brief Marks a dirty rectangle on the surface
+ * @param r The rectangle to be marked dirty
+ */
 void Surface::markDirtyRect(Common::Rect r) {
 	Common::List<Common::Rect>::iterator it;
 
@@ -61,31 +65,54 @@ void Surface::markDirtyRect(Common::Rect r) {
 	_dirtyRects.push_back(r);
 }
 
+/**
+ * @brief Clears all dirty rectangles
+ *
+ */
 void Surface::clearDirtyRects() {
 	_dirtyRects.clear();
 }
 
+/**
+ * @brief Marks the whole surface dirty
+ */
 void Surface::markDirty() {
 	_fullUpdate = true;
 }
 
+/**
+ * @brief Marks the whole surface clean
+ */
 void Surface::markClean() {
 	_fullUpdate = false;
 	_dirtyRects.clear();
 }
 
+/**
+ * @brief Checks whether the surface needs a full update
+ */
 bool Surface::needsFullUpdate() {
 	return _fullUpdate;
 }
 
+/**
+ * @brief Fetches the surface's dirty rectangles
+ * @return A pointer a list of dirty rectangles
+ */
 Common::List<Common::Rect> *Surface::getDirtyRects() {
 	return &_dirtyRects;
 }
 
+/**
+ * @brief Returns the current transparent colour of the surface
+ */
 uint8 Surface::getTransparentColour() {
 	return _transparentColour;
 }
 
+/**
+ * @brief Sets the surface's transparent colour
+ */
 void Surface::setTransparentColour(uint8 colour) {
 	_transparentColour = colour;
 }
-- 
cgit v1.2.3