From e6eeaaea6717f68c1ad622c4fbd308917b3d1408 Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Wed, 17 Nov 2010 22:55:06 +0000
Subject: minor: add some method comments

---
 OpenSim/Framework/Util.cs                                        | 8 ++++++++
 .../CoreModules/Framework/EntityTransfer/EntityTransferModule.cs | 9 +++++++--
 2 files changed, 15 insertions(+), 2 deletions(-)

diff --git a/OpenSim/Framework/Util.cs b/OpenSim/Framework/Util.cs
index addfe5d..e8f8e01 100644
--- a/OpenSim/Framework/Util.cs
+++ b/OpenSim/Framework/Util.cs
@@ -451,6 +451,14 @@ namespace OpenSim.Framework
             return (x + y - (min >> 1) - (min >> 2) + (min >> 4));
         }
 
+        /// <summary>
+        /// Are the co-ordinates of the new region visible from the old region?
+        /// </summary>
+        /// <param name="oldx">Old region x-coord</param>
+        /// <param name="newx">New region x-coord</param>
+        /// <param name="oldy">Old region y-coord</param>
+        /// <param name="newy">New region y-coord</param>
+        /// <returns></returns>        
         public static bool IsOutsideView(uint oldx, uint newx, uint oldy, uint newy)
         {
             // Eventually this will be a function of the draw distance / camera position too.
diff --git a/OpenSim/Region/CoreModules/Framework/EntityTransfer/EntityTransferModule.cs b/OpenSim/Region/CoreModules/Framework/EntityTransfer/EntityTransferModule.cs
index b5cab84..f02a922 100644
--- a/OpenSim/Region/CoreModules/Framework/EntityTransfer/EntityTransferModule.cs
+++ b/OpenSim/Region/CoreModules/Framework/EntityTransfer/EntityTransferModule.cs
@@ -1228,11 +1228,16 @@ namespace OpenSim.Region.CoreModules.Framework.EntityTransfer
                 }
 
                 m_log.Debug("[ENTITY TRANSFER MODULE]: Completed inform client about neighbour " + endPoint.ToString());
-
             }
-
         }
 
+        /// <summary>
+        /// Return the list of regions that are considered to be neighbours to the given scene.
+        /// </summary>
+        /// <param name="pScene"></param>
+        /// <param name="pRegionLocX"></param>
+        /// <param name="pRegionLocY"></param>
+        /// <returns></returns>        
         protected List<GridRegion> RequestNeighbours(Scene pScene, uint pRegionLocX, uint pRegionLocY)
         {
             RegionInfo m_regionInfo = pScene.RegionInfo;
-- 
cgit v1.1