From 3e5b2d52ff7e9fd0c968608c4a705740f51b9bc2 Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Fri, 15 Jul 2011 22:58:29 +0100
Subject: minor: method doc for baked texture uploading

---
 .../ClientStack/Linden/Caps/BunchOfCaps/BunchOfCaps.cs  | 17 +++++++++++++++--
 .../Avatar/AvatarFactory/AvatarFactoryModule.cs         |  3 ++-
 2 files changed, 17 insertions(+), 3 deletions(-)

(limited to 'OpenSim')

diff --git a/OpenSim/Region/ClientStack/Linden/Caps/BunchOfCaps/BunchOfCaps.cs b/OpenSim/Region/ClientStack/Linden/Caps/BunchOfCaps/BunchOfCaps.cs
index b11210a..8db4e67 100644
--- a/OpenSim/Region/ClientStack/Linden/Caps/BunchOfCaps/BunchOfCaps.cs
+++ b/OpenSim/Region/ClientStack/Linden/Caps/BunchOfCaps/BunchOfCaps.cs
@@ -331,14 +331,22 @@ namespace OpenSim.Region.ClientStack.Linden
             }
         }
 
+        /// <summary>
+        /// Handle a request from the client for a Uri to upload a baked texture.
+        /// </summary>
+        /// <param name="request"></param>
+        /// <param name="path"></param>
+        /// <param name="param"></param>
+        /// <param name="httpRequest"></param>
+        /// <param name="httpResponse"></param>
+        /// <returns>The upload response if the request is successful, null otherwise.</returns>
         public string UploadBakedTexture(string request, string path,
                 string param, OSHttpRequest httpRequest,
                 OSHttpResponse httpResponse)
         {
             try
             {
-                //                m_log.Debug("[CAPS]: UploadBakedTexture Request in region: " +
-                //                        m_regionName);
+//                m_log.Debug("[CAPS]: UploadBakedTexture Request in region: " + m_regionName);
 
                 string capsBase = "/CAPS/" + m_HostCapsObj.CapsObjectPath;
                 string uploaderPath = Util.RandomClass.Next(5000, 8000).ToString("0000");
@@ -374,6 +382,11 @@ namespace OpenSim.Region.ClientStack.Linden
             return null;
         }
 
+        /// <summary>
+        /// Called when a baked texture has been successfully uploaded by a client.
+        /// </summary>
+        /// <param name="assetID"></param>
+        /// <param name="data"></param>
         public void BakedTextureUploaded(UUID assetID, byte[] data)
         {
             //            m_log.WarnFormat("[CAPS]: Received baked texture {0}", assetID.ToString());
diff --git a/OpenSim/Region/CoreModules/Avatar/AvatarFactory/AvatarFactoryModule.cs b/OpenSim/Region/CoreModules/Avatar/AvatarFactory/AvatarFactoryModule.cs
index 1955e5b..75dbeb8 100644
--- a/OpenSim/Region/CoreModules/Avatar/AvatarFactory/AvatarFactoryModule.cs
+++ b/OpenSim/Region/CoreModules/Avatar/AvatarFactory/AvatarFactoryModule.cs
@@ -180,8 +180,9 @@ namespace OpenSim.Region.CoreModules.Avatar.AvatarFactory
         }
 
         /// <summary>
-        /// Set appearance data (textureentry and slider settings) received from the client
+        /// Set appearance data (texture asset IDs and slider settings) received from the client
         /// </summary>
+        /// <param name="client"></param>
         /// <param name="texture"></param>
         /// <param name="visualParam"></param>
         public void SetAppearance(IClientAPI client, Primitive.TextureEntry textureEntry, byte[] visualParams)
-- 
cgit v1.1