From 59caa68e08691d8fac221e2bd42c712d5bcf69aa Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Wed, 25 Nov 2009 17:49:38 +0000
Subject: minor: add doc to a few parcel methods

---
 .../Region/Framework/Interfaces/ILandChannel.cs    | 25 +++++++++++++++++-----
 1 file changed, 20 insertions(+), 5 deletions(-)

(limited to 'OpenSim/Region/Framework/Interfaces/ILandChannel.cs')

diff --git a/OpenSim/Region/Framework/Interfaces/ILandChannel.cs b/OpenSim/Region/Framework/Interfaces/ILandChannel.cs
index 74f404f..6fe6118 100644
--- a/OpenSim/Region/Framework/Interfaces/ILandChannel.cs
+++ b/OpenSim/Region/Framework/Interfaces/ILandChannel.cs
@@ -33,26 +33,41 @@ namespace OpenSim.Region.Framework.Interfaces
 {
     public interface ILandChannel
     {
-        List<ILandObject> ParcelsNearPoint(Vector3 position);
+        /// <summary>
+        /// Get all parcels
+        /// </summary>
+        /// <returns></returns>
         List<ILandObject> AllParcels();
              
         /// <summary>
-        /// Get the land object at the specified point
+        /// Get the parcel at the specified point
         /// </summary>
         /// <param name="x">Value between 0 - 256 on the x axis of the point</param>
         /// <param name="y">Value between 0 - 256 on the y axis of the point</param>
         /// <returns>Land object at the point supplied</returns>
         ILandObject GetLandObject(int x, int y);
 
-        ILandObject GetLandObject(int localID);
-
         /// <summary>
-        /// Get the land object at the specified point
+        /// Get the parcel at the specified point
         /// </summary>
         /// <param name="x">Value between 0 - 256 on the x axis of the point</param>
         /// <param name="y">Value between 0 - 256 on the y axis of the point</param>
         /// <returns>Land object at the point supplied</returns>
         ILandObject GetLandObject(float x, float y);
+
+        /// <summary>
+        /// Get the parcels near the specified point
+        /// </summary>
+        /// <param name="position"></param>
+        /// <returns></returns>
+        List<ILandObject> ParcelsNearPoint(Vector3 position);        
+
+        /// <summary>
+        /// Get the parcel given the land's local id.
+        /// </summary>
+        /// <param name="localID"></param>
+        /// <returns></returns>
+        ILandObject GetLandObject(int localID);
         
         bool IsLandPrimCountTainted();
         bool IsForcefulBansAllowed();
-- 
cgit v1.1