From 7d24dbca3c85cafe182648139ab132563e3e1cdd Mon Sep 17 00:00:00 2001
From: Diva Canto <diva@metaverseink.com>
Date: Wed, 1 Dec 2010 16:01:22 -0800
Subject: [PATCH] Added some comments. Better than listening to the boring
 speaker...

---
 .../External/ExternalRepresentationUtils.cs          | 12 ++++++++++++
 OpenSim/Region/Framework/Scenes/SceneObjectPart.cs   |  5 ++++-
 OpenSim/Services/HypergridService/HGAssetService.cs  |  5 +++++
 .../Services/HypergridService/HGInventoryService.cs  |  7 +++++++
 4 files changed, 28 insertions(+), 1 deletion(-)

diff --git a/OpenSim/Framework/Serialization/External/ExternalRepresentationUtils.cs b/OpenSim/Framework/Serialization/External/ExternalRepresentationUtils.cs
index 5c0630cf7b..6e8c2ee173 100644
--- a/OpenSim/Framework/Serialization/External/ExternalRepresentationUtils.cs
+++ b/OpenSim/Framework/Serialization/External/ExternalRepresentationUtils.cs
@@ -34,8 +34,20 @@ using OpenSim.Services.Interfaces;
 
 namespace OpenSim.Framework.Serialization.External
 {
+    /// <summary>
+    /// Utilities for manipulating external representations of data structures in OpenSim
+    /// </summary>
     public class ExternalRepresentationUtils
     {
+        /// <summary>
+        /// Takes a XML representation of a SceneObjectPart and returns another XML representation
+        /// with creator data added to it.
+        /// </summary>
+        /// <param name="xml">The SceneObjectPart represented in XML2</param>
+        /// <param name="profileURL">The URL of the profile service for the creator</param>
+        /// <param name="userService">The service for retrieving user account information</param>
+        /// <param name="scopeID">The scope of the user account information (Grid ID)</param>
+        /// <returns>The SceneObjectPart represented in XML2</returns>
         public static string RewriteSOP(string xml, string profileURL, IUserAccountService userService, UUID scopeID)
         {
             if (xml == string.Empty || profileURL == string.Empty || userService == null)
diff --git a/OpenSim/Region/Framework/Scenes/SceneObjectPart.cs b/OpenSim/Region/Framework/Scenes/SceneObjectPart.cs
index ba592c4afa..f87056e48e 100644
--- a/OpenSim/Region/Framework/Scenes/SceneObjectPart.cs
+++ b/OpenSim/Region/Framework/Scenes/SceneObjectPart.cs
@@ -449,7 +449,10 @@ namespace OpenSim.Region.Framework.Scenes
             }
         }
 
-        public string CreatorData // = <profile url>;<name>
+        /// <summary>
+        /// Data about the creator in the form profile_url;name
+        /// </summary>
+        public string CreatorData 
         {
             get { return m_creatorData; }
             set { m_creatorData = value; }
diff --git a/OpenSim/Services/HypergridService/HGAssetService.cs b/OpenSim/Services/HypergridService/HGAssetService.cs
index 584ab6fdb3..a82d0d191f 100644
--- a/OpenSim/Services/HypergridService/HGAssetService.cs
+++ b/OpenSim/Services/HypergridService/HGAssetService.cs
@@ -42,6 +42,11 @@ using OpenSim.Services.AssetService;
 
 namespace OpenSim.Services.HypergridService
 {
+    /// <summary>
+    /// Hypergrid asset service. It serves the IAssetService interface,
+    /// but implements it in ways that are appropriate for inter-grid
+    /// asset exchanges.
+    /// </summary>
     public class HGAssetService : OpenSim.Services.AssetService.AssetService, IAssetService
     {
         private static readonly ILog m_log =
diff --git a/OpenSim/Services/HypergridService/HGInventoryService.cs b/OpenSim/Services/HypergridService/HGInventoryService.cs
index a04f0c4a05..9ee1ae4c5f 100644
--- a/OpenSim/Services/HypergridService/HGInventoryService.cs
+++ b/OpenSim/Services/HypergridService/HGInventoryService.cs
@@ -40,6 +40,13 @@ using OpenSim.Server.Base;
 
 namespace OpenSim.Services.HypergridService
 {
+    /// <summary>
+    /// Hypergrid inventory service. It serves the IInventoryService interface,
+    /// but implements it in ways that are appropriate for inter-grid
+    /// inventory exchanges. Specifically, it does not performs deletions
+    /// and it responds to GetRootFolder requests with the ID of the
+    /// Suitcase folder, not the actual "My Inventory" folder.
+    /// </summary>
     public class HGInventoryService : XInventoryService, IInventoryService
     {
         private static readonly ILog m_log =