From 63533412f882fd55c0c40989d97f8a8262bc4e3c Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Wed, 6 Apr 2011 18:57:50 +0100
Subject: Improve previous ILandObject method doc.

For test code, take a part name prefix when creating objects, so that these can be more easily identified in the logs
---
 OpenSim/Framework/ILandObject.cs | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

(limited to 'OpenSim/Framework')

diff --git a/OpenSim/Framework/ILandObject.cs b/OpenSim/Framework/ILandObject.cs
index 02775e9..5a55b02 100644
--- a/OpenSim/Framework/ILandObject.cs
+++ b/OpenSim/Framework/ILandObject.cs
@@ -92,8 +92,12 @@ namespace OpenSim.Framework
         /// Create a square land bitmap.
         /// </summary>
         /// <remarks>
-        /// Land co-ordinates are zero indexed.  At the moment, the smallest parcel of land is 4m x 4m, so if the 
-        /// region is 256 x 256m (the SL size), the largest land parcel starts at (0,0) and ends at (63,63).
+        /// Land co-ordinates are zero indexed.  The inputs are treated as points.  So if you want to create a bitmap
+        /// that covers an entire 256 x 256m region apart from a strip of land on the east, then you would need to 
+        /// specify start_x = 0, start_y = 0, end_x = 252 (or anything up to 255), end_y = 256.
+        /// 
+        /// At the moment, the smallest parcel of land is 4m x 4m, so if the 
+        /// region is 256 x 256m (the SL size), the bitmap returned will start at (0,0) and end at (63,63).
         /// </remarks>
         /// <param name="start_x"></param>
         /// <param name="start_y"></param>
-- 
cgit v1.1