From d649194be310bf267675ac3cd9f9fce302cc3798 Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Fri, 28 Aug 2009 12:52:40 +0100
Subject: minor: formatting and comments

---
 OpenSim/Framework/Communications/Services/LoginService.cs | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

(limited to 'OpenSim/Framework/Communications/Services')

diff --git a/OpenSim/Framework/Communications/Services/LoginService.cs b/OpenSim/Framework/Communications/Services/LoginService.cs
index cac6616..bf59f8e 100644
--- a/OpenSim/Framework/Communications/Services/LoginService.cs
+++ b/OpenSim/Framework/Communications/Services/LoginService.cs
@@ -1063,7 +1063,18 @@ namespace OpenSim.Framework.Communications.Services
         protected abstract RegionInfo RequestClosestRegion(string region);
         protected abstract RegionInfo GetRegionInfo(ulong homeRegionHandle);
         protected abstract RegionInfo GetRegionInfo(UUID homeRegionId);
-        protected abstract bool PrepareLoginToRegion(RegionInfo regionInfo, UserProfileData user, LoginResponse response, IPEndPoint client);
+
+        /// <summary>
+        /// Prepare a login to the given region.  This involves both telling the region to expect a connection
+        /// and appropriately customising the response to the user.
+        /// </summary>
+        /// <param name="sim"></param>
+        /// <param name="user"></param>
+        /// <param name="response"></param>
+        /// <param name="remoteClient"></param>
+        /// <returns>true if the region was successfully contacted, false otherwise</returns>        
+        protected abstract bool PrepareLoginToRegion(
+            RegionInfo regionInfo, UserProfileData user, LoginResponse response, IPEndPoint client);
 
         /// <summary>
         /// Add active gestures of the user to the login response.
-- 
cgit v1.1