From 7d24dbca3c85cafe182648139ab132563e3e1cdd Mon Sep 17 00:00:00 2001
From: Diva Canto
Date: Wed, 1 Dec 2010 16:01:22 -0800
Subject: Added some comments. Better than listening to the boring speaker...

---
 .../Serialization/External/ExternalRepresentationUtils.cs    | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'OpenSim/Framework/Serialization/External/ExternalRepresentationUtils.cs')

diff --git a/OpenSim/Framework/Serialization/External/ExternalRepresentationUtils.cs b/OpenSim/Framework/Serialization/External/ExternalRepresentationUtils.cs
index 5c0630c..6e8c2ee 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)
-- 
cgit v1.1