From ac037dfe210f416e6355bd7c1210f25d6cb90f63 Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Sat, 20 Oct 2012 02:26:08 +0100
Subject: Add method doc for IPresenceService

---
 OpenSim/Services/Interfaces/IPresenceService.cs | 38 ++++++++++++++++++++++++-
 1 file changed, 37 insertions(+), 1 deletion(-)

(limited to 'OpenSim/Services')

diff --git a/OpenSim/Services/Interfaces/IPresenceService.cs b/OpenSim/Services/Interfaces/IPresenceService.cs
index 8d583ff..90f9842 100644
--- a/OpenSim/Services/Interfaces/IPresenceService.cs
+++ b/OpenSim/Services/Interfaces/IPresenceService.cs
@@ -61,13 +61,49 @@ namespace OpenSim.Services.Interfaces
 
     public interface IPresenceService
     {
+        /// <summary>
+        /// Store session information.
+        /// </summary>
+        /// <returns>/returns>
+        /// <param name='userID'></param>
+        /// <param name='sessionID'></param>
+        /// <param name='secureSessionID'></param>
         bool LoginAgent(string userID, UUID sessionID, UUID secureSessionID);
+
+        /// <summary>
+        /// Remove session information.
+        /// </summary>
+        /// <returns></returns>
+        /// <param name='sessionID'></param>
         bool LogoutAgent(UUID sessionID);
+
+        /// <summary>
+        /// Remove session information for all agents in the given region.
+        /// </summary>
+        /// <returns></returns>
+        /// <param name='regionID'></param>
         bool LogoutRegionAgents(UUID regionID);
 
+        /// <summary>
+        /// Update data for an existing session.
+        /// </summary>
+        /// <returns></returns>
+        /// <param name='sessionID'></param>
+        /// <param name='regionID'></param>
         bool ReportAgent(UUID sessionID, UUID regionID);
 
+        /// <summary>
+        /// Get session information for a given session ID.
+        /// </summary>
+        /// <returns></returns>
+        /// <param name='sessionID'></param>
         PresenceInfo GetAgent(UUID sessionID);
+
+        /// <summary>
+        /// Get session information for a collection of users.
+        /// </summary>
+        /// <returns>Session information for the users.</returns>
+        /// <param name='userIDs'></param>
         PresenceInfo[] GetAgents(string[] userIDs);
     }
-}
+}
\ No newline at end of file
-- 
cgit v1.1