From 22e09bedaaf125365c6905187db80e939a86df53 Mon Sep 17 00:00:00 2001
From: Jody Northup
Date: Mon, 6 Jul 2009 07:40:28 +0000
Subject: Updated doxygen comments on API functions

svn-id: r42166
---
 graphics/pixelformat.h | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

(limited to 'graphics/pixelformat.h')

diff --git a/graphics/pixelformat.h b/graphics/pixelformat.h
index a1883291b9..bf18197f25 100644
--- a/graphics/pixelformat.h
+++ b/graphics/pixelformat.h
@@ -65,7 +65,11 @@ struct PixelFormat {
 		rShift = RShift, gShift = GShift, bShift = BShift, aShift = AShift;
 	}
 
-	// "Factory" methods for convenience
+	/////////////////////////////////////////////////////////
+	// Convenience functions for creating standard formats //
+	/////////////////////////////////////////////////////////
+
+	// 256 color palette.
 	static inline PixelFormat createFormatCLUT8() { 
 		return PixelFormat(1, 8, 8, 8, 8, 0, 0, 0, 0);
 	}
@@ -201,6 +205,14 @@ struct PixelFormat {
 	}
 };
 
+/**
+ * Determines the first matching format between two lists.
+ *
+ * @param backend	The higher priority list, meant to be a list of formats supported by the backend
+ * @param frontend	The lower priority list, meant to be a list of formats supported by the engine
+ * @return			The first item on the backend list that also occurs on the frontend list
+ *					or PixelFormat::createFormatCLUT8() if no matching formats were found.
+ */
 inline PixelFormat findCompatibleFormat(Common::List<PixelFormat> backend, Common::List<PixelFormat> frontend) {
 #ifdef ENABLE_RGB_COLOR
 	for (Common::List<PixelFormat>::iterator i = backend.begin(); i != backend.end(); ++i) {
-- 
cgit v1.2.3