From 8a0a0f9bb563f2cb7ec823587e13e3f4483d3a68 Mon Sep 17 00:00:00 2001
From: Jeff Ames
Date: Thu, 26 Jun 2008 01:12:28 +0000
Subject: Add patch from bug #1596 - adds Doxygen documentation in
 OpenSim.Data.MySQL files.  Thanks kerunix_Flan!

---
 OpenSim/Data/MySQL/MySQLUserData.cs | 42 ++++++++++++++++++++++++++++++++++---
 1 file changed, 39 insertions(+), 3 deletions(-)

(limited to 'OpenSim/Data/MySQL/MySQLUserData.cs')

diff --git a/OpenSim/Data/MySQL/MySQLUserData.cs b/OpenSim/Data/MySQL/MySQLUserData.cs
index 05874f8..11d9c26 100644
--- a/OpenSim/Data/MySQL/MySQLUserData.cs
+++ b/OpenSim/Data/MySQL/MySQLUserData.cs
@@ -56,8 +56,12 @@ namespace OpenSim.Data.MySQL
         private string m_connectString;
 
         /// <summary>
+        /// Initialise User Interface
         /// Loads and initialises the MySQL storage plugin
+        /// Warns and uses the obsolete mysql_connection.ini if connect string is empty.
+        /// Checks for migration
         /// </summary>
+        /// <param name="connect">connect string.</param>
         override public void Initialise(string connect)
         {
             if (connect == String.Empty) {
@@ -494,7 +498,11 @@ namespace OpenSim.Data.MySQL
             return returnlist;
         }
 
-        // see IUserData
+        /// <summary>
+        /// See IUserData
+        /// </summary>
+        /// <param name="uuid">User UUID</param>
+        /// <returns>User profile data</returns>
         override public UserProfileData GetUserByUUID(LLUUID uuid)
         {
             try
@@ -526,7 +534,7 @@ namespace OpenSim.Data.MySQL
         /// <summary>
         /// Returns a user session searching by name
         /// </summary>
-        /// <param name="name">The account name</param>
+        /// <param name="name">The account name : "Username Lastname"</param>
         /// <returns>The users session</returns>
         override public UserAgentData GetAgentByName(string name)
         {
@@ -545,6 +553,11 @@ namespace OpenSim.Data.MySQL
             return GetAgentByUUID(profile.ID);
         }
 
+        /// <summary>
+        /// </summary>
+        /// <param name="AgentID"></param>
+        /// <param name="WebLoginKey"></param>
+        /// <remarks>is it still used ?</remarks>
         override public void StoreWebLoginKey(LLUUID AgentID, LLUUID WebLoginKey)
         {
             Dictionary<string, string> param = new Dictionary<string, string>();
@@ -694,9 +707,11 @@ namespace OpenSim.Data.MySQL
             return false;
         }
 
+        /// <summary>
         /// Appearance
         /// TODO: stubs for now to get us to a compiling state gently
-        // override
+        /// override
+        /// </summary>
         override public AvatarAppearance GetUserAppearance(LLUUID user)
         {
             try {
@@ -723,6 +738,12 @@ namespace OpenSim.Data.MySQL
                 return null;
             }
         }
+
+        /// <summary>
+        /// Updates an avatar appearence
+        /// </summary>
+        /// <param name="user">The user UUID</param>
+        /// <param name="appearance">The avatar appearance</param>
         // override
         override public void UpdateUserAppearance(LLUUID user, AvatarAppearance appearance)
         {
@@ -741,16 +762,31 @@ namespace OpenSim.Data.MySQL
             }
         }
 
+        /// <summary>
+        /// Adds an attachment item to a user
+        /// </summary>
+        /// <param name="user">the user UUID</param>
+        /// <param name="item">the item UUID</param>
         override public void AddAttachment(LLUUID user, LLUUID item)
         {
             return;
         }
 
+        /// <summary>
+        /// Removes an attachment from a user
+        /// </summary>
+        /// <param name="user">the user UUID</param>
+        /// <param name="item">the item UUID</param>
         override public void RemoveAttachment(LLUUID user, LLUUID item)
         {
             return;
         }
 
+        /// <summary>
+        /// Get the list of item attached to a user
+        /// </summary>
+        /// <param name="user">the user UUID</param>
+        /// <returns>UUID list of attached item</returns>
         override public List<LLUUID> GetAttachments(LLUUID user)
         {
             return new List<LLUUID>();
-- 
cgit v1.1