From 17507404b5de340eab5e3c368dd2600ee7b1467c Mon Sep 17 00:00:00 2001
From: Adam Frisby
Date: Sun, 13 Apr 2008 01:36:03 +0000
Subject: * Added some comments to terrain module. * Fixed a range issue in the
 GenericSystemDrawing saving mechanism.

---
 .../Region/Environment/Modules/Terrain/FileLoaders/BMP.cs | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

(limited to 'OpenSim/Region/Environment/Modules/Terrain/FileLoaders/BMP.cs')

diff --git a/OpenSim/Region/Environment/Modules/Terrain/FileLoaders/BMP.cs b/OpenSim/Region/Environment/Modules/Terrain/FileLoaders/BMP.cs
index 56c511e..cad0edf 100644
--- a/OpenSim/Region/Environment/Modules/Terrain/FileLoaders/BMP.cs
+++ b/OpenSim/Region/Environment/Modules/Terrain/FileLoaders/BMP.cs
@@ -30,8 +30,19 @@ using OpenSim.Region.Environment.Interfaces;
 
 namespace OpenSim.Region.Environment.Modules.Terrain.FileLoaders
 {
+    /// <summary>
+    /// A generic windows bitmap loader. 
+    /// Should be capable of handling 24-bit RGB images.
+    /// 
+    /// Uses the System.Drawing filesystem loader.
+    /// </summary>
     class BMP : GenericSystemDrawing
     {
+        /// <summary>
+        /// Exports a file to a image on the disk using a System.Drawing exporter.
+        /// </summary>
+        /// <param name="filename">The target filename</param>
+        /// <param name="map">The terrain channel being saved</param>
         public override void SaveFile(string filename, ITerrainChannel map)
         {
             Bitmap colours = CreateGrayscaleBitmapFromMap(map);
@@ -39,6 +50,10 @@ namespace OpenSim.Region.Environment.Modules.Terrain.FileLoaders
             colours.Save(filename, System.Drawing.Imaging.ImageFormat.Bmp);
         }
 
+        /// <summary>
+        /// The human readable version of the file format(s) this loader handles
+        /// </summary>
+        /// <returns></returns>
         public override string ToString()
         {
             return "BMP";
-- 
cgit v1.1