From 2956132146b7aa76a5c3642de22831ec718c539e Mon Sep 17 00:00:00 2001
From: Tom Hicks <headhunter3@gmail.com>
Date: Sat, 1 Jul 2006 23:48:44 -0400
Subject: [PATCH] Changed Moved LoadBMP into the BitmapImage class ~G2k

---
 src/bmp.cpp | 14 +++++++++++++-
 src/bmp.h   | 15 ++++++++++++++-
 2 files changed, 27 insertions(+), 2 deletions(-)

diff --git a/src/bmp.cpp b/src/bmp.cpp
index 730c2b0..ad8f3b1 100644
--- a/src/bmp.cpp
+++ b/src/bmp.cpp
@@ -26,6 +26,18 @@
 
 namespace OpenArena{
 
+	/*!
+	 * \brief
+	 * Write brief comment for BitmapImage here.
+	 * 
+	 * Write detailed description for BitmapImage here.
+	 * 
+	 * \remarks
+	 * Write remarks for BitmapImage here.
+	 * 
+	 * \see
+	 * Separate items with the '|' character.
+	 */
 	BitmapImage::BitmapImage()
 	{
 		BitmapImage(1, 1);
@@ -222,7 +234,7 @@ namespace OpenArena{
 		return image;
 	}
 
-	TextureImage* LoadBMP(const char* fn)
+	TextureImage* BitmapImage::LoadBMP(const char* fn)
 	{
 		//If anything is not perfect return NULL after cleaning up our mess
 
diff --git a/src/bmp.h b/src/bmp.h
index ca8f04a..01fef4e 100644
--- a/src/bmp.h
+++ b/src/bmp.h
@@ -7,7 +7,19 @@
 #include "texture.h"
 
 namespace OpenArena{
-	TextureImage* LoadBMP(const char* Filename);
+
+	/*!
+	  * \brief
+	  * BitmapImage implements the Image interface and is used to load *.bmp files.
+	  * 
+	  * BitmapImage implements the Image interface which replaces the soon-to-be-removed TextureImage class.  When complete the texture class will accept an Image as the image to generate the texture from.
+	  * 
+	  * \remarks
+	  * I would like to make GetImageData return a const uint8 * but I'm not yet sure this will be possible.  To create an editable image use the BufferedImage class which as yet hasn't been implemented.  A created BitmapImage is expected to not change once it's created.  Doing so may break functionality or cause a crash.
+	  * 
+	  * \see
+	  * Image
+	  */
 	class BitmapImage: public Image
 	{
 	public:
@@ -19,6 +31,7 @@ namespace OpenArena{
 		virtual uint32 GetHeight() const;
 		virtual Image::Type GetType() const;
 		static BitmapImage* CreateFromFile(const char* filename);
+		static TextureImage* LoadBMP(const char* Filename);
 	private:
 		BitmapImage();
 		BitmapImage(uint32 width, uint32 height, uint32 = 24, Image::Type = Image::Type_RGB);