1 files changed, 41 insertions, 0 deletions

diff --git a/OpenGrid.Framework.Data/GridData.cs b/OpenGrid.Framework.Data/GridData.cs
index d6b5a2b..3b052fb 100644
--- a/OpenGrid.Framework.Data/GridData.cs
+++ b/OpenGrid.Framework.Data/GridData.cs
@@ -4,14 +4,55 @@ using System.Text;
 

 namespace OpenGrid.Framework.Data

 {

+    /// <summary>

+    /// A standard grid interface

+    /// </summary>

     public interface IGridData

     {

+        /// <summary>

+        /// Returns a sim profile from a regionHandle

+        /// </summary>

+        /// <param name="regionHandle">A 64bit Region Handle</param>

+        /// <returns>A simprofile</returns>

         SimProfileData GetProfileByHandle(ulong regionHandle);

+

+        /// <summary>

+        /// Returns a sim profile from a UUID

+        /// </summary>

+        /// <param name="UUID">A 128bit UUID</param>

+        /// <returns>A sim profile</returns>

         SimProfileData GetProfileByLLUUID(libsecondlife.LLUUID UUID);

+

+        /// <summary>

+        /// Authenticates a sim by use of it's recv key. 

+        /// WARNING: Insecure

+        /// </summary>

+        /// <param name="UUID">The UUID sent by the sim</param>

+        /// <param name="regionHandle">The regionhandle sent by the sim</param>

+        /// <param name="simrecvkey">The recieving key sent by the sim</param>

+        /// <returns>Whether the sim has been authenticated</returns>

         bool AuthenticateSim(libsecondlife.LLUUID UUID, ulong regionHandle, string simrecvkey);

+

+        /// <summary>

+        /// Initialises the interface

+        /// </summary>

         void Initialise();

+

+        /// <summary>

+        /// Closes the interface

+        /// </summary>

         void Close();

+

+        /// <summary>

+        /// The plugin being loaded

+        /// </summary>

+        /// <returns>A string containing the plugin name</returns>

         string getName();

+

+        /// <summary>

+        /// The plugins version

+        /// </summary>

+        /// <returns>A string containing the plugin version</returns>

         string getVersion();

     }

 }