Merge branch 'master' of ssh://diva@opensimulator.org/var/git/opensim

11 files changed, 213 insertions, 6 deletions

diff --git a/OpenSim/Framework/ACL.cs b/OpenSim/Framework/ACL.cs
index 9d7827e..3b1c0f0 100644
--- a/OpenSim/Framework/ACL.cs
+++ b/OpenSim/Framework/ACL.cs
@@ -46,6 +46,11 @@ namespace OpenSim.Framework
         private Dictionary<string, Resource> Resources = new Dictionary<string, Resource>();
         private Dictionary<string, Role> Roles = new Dictionary<string, Role>();
 
+        /// <summary>
+        /// Adds a new role
+        /// </summary>
+        /// <param name="role"></param>
+        /// <returns></returns>
         public ACL AddRole(Role role)
         {
             if (Roles.ContainsKey(role.Name))
@@ -56,6 +61,11 @@ namespace OpenSim.Framework
             return this;
         }
 
+        /// <summary>
+        /// Adds a new resource
+        /// </summary>
+        /// <param name="resource"></param>
+        /// <returns></returns>
         public ACL AddResource(Resource resource)
         {
             Resources.Add(resource.Name, resource);
@@ -63,6 +73,12 @@ namespace OpenSim.Framework
             return this;
         }
 
+        /// <summary>
+        /// Permision for user/roll on a resource
+        /// </summary>
+        /// <param name="role"></param>
+        /// <param name="resource"></param>
+        /// <returns></returns>
         public Permission HasPermission(string role, string resource)
         {
             if (!Roles.ContainsKey(role))
@@ -234,6 +250,9 @@ namespace OpenSim.Framework
 
     #region Tests
 
+    /// <summary>
+    /// ACL Test class
+    /// </summary>
     internal class ACLTester
     {
         public ACLTester()
diff --git a/OpenSim/Framework/AgentCircuitData.cs b/OpenSim/Framework/AgentCircuitData.cs
index c38f0c3..6472f31 100644
--- a/OpenSim/Framework/AgentCircuitData.cs
+++ b/OpenSim/Framework/AgentCircuitData.cs
@@ -32,26 +32,83 @@ using OpenMetaverse.StructuredData;
 
 namespace OpenSim.Framework
 {
+    /// <summary>
+    /// Circuit data for an agent.  Connection information shared between
+    /// regions that accept UDP connections from a client
+    /// </summary>
     public class AgentCircuitData
     {
+        /// <summary>
+        /// Avatar Unique Agent Identifier
+        /// </summary>
         public UUID AgentID;
+
+        /// <summary>
+        /// Avatar's Appearance
+        /// </summary>
         public AvatarAppearance Appearance;
+
+        /// <summary>
+        /// Agent's root inventory folder
+        /// </summary>
         public UUID BaseFolder;
+
+        /// <summary>
+        /// Base Caps path for user
+        /// </summary>
         public string CapsPath = String.Empty;
+
+        /// <summary>
+        /// Seed caps for neighbor regions that the user can see into
+        /// </summary>
         public Dictionary<ulong, string> ChildrenCapSeeds;
+
+        /// <summary>
+        /// Root agent, or Child agent
+        /// </summary>
         public bool child;
+
+        /// <summary>
+        /// Number given to the client when they log-in that they provide 
+        /// as credentials to the UDP server
+        /// </summary>
         public uint circuitcode;
+
+        /// <summary>
+        /// Agent's account first name
+        /// </summary>
         public string firstname;
         public UUID InventoryFolder;
+
+        /// <summary>
+        /// Agent's account last name
+        /// </summary>
         public string lastname;
+
+        /// <summary>
+        /// Random Unique GUID for this session.  Client gets this at login and it's
+        /// only supposed to be disclosed over secure channels
+        /// </summary>
         public UUID SecureSessionID;
+
+        /// <summary>
+        /// Non secure Session ID
+        /// </summary>
         public UUID SessionID;
+
+        /// <summary>
+        /// Position the Agent's Avatar starts in the region
+        /// </summary>
         public Vector3 startpos;
 
         public AgentCircuitData()
         {
         }
 
+        /// <summary>
+        /// Create AgentCircuitData from a Serializable AgentCircuitData
+        /// </summary>
+        /// <param name="cAgent"></param>
         public AgentCircuitData(sAgentCircuitData cAgent)
         {
             AgentID = new UUID(cAgent.AgentID);
@@ -68,6 +125,10 @@ namespace OpenSim.Framework
             ChildrenCapSeeds = cAgent.ChildrenCapSeeds;
         }
 
+        /// <summary>
+        /// Pack AgentCircuitData into an OSDMap for transmission over LLSD XML or LLSD json
+        /// </summary>
+        /// <returns>map of the agent circuit data</returns>
         public OSDMap PackAgentCircuitData()
         {
             OSDMap args = new OSDMap();
@@ -98,6 +159,10 @@ namespace OpenSim.Framework
             return args;
         }
 
+        /// <summary>
+        /// Unpack agent circuit data map into an AgentCiruitData object
+        /// </summary>
+        /// <param name="args"></param>
         public void UnpackAgentCircuitData(OSDMap args)
         {
             if (args["agent_id"] != null)
@@ -150,6 +215,9 @@ namespace OpenSim.Framework
         }
     }
 
+    /// <summary>
+    /// Serializable Agent Circuit Data
+    /// </summary>
     [Serializable]
     public class sAgentCircuitData
     {
diff --git a/OpenSim/Framework/AgentUpdateArgs.cs b/OpenSim/Framework/AgentUpdateArgs.cs
index a19795d..7b9ec68 100644
--- a/OpenSim/Framework/AgentUpdateArgs.cs
+++ b/OpenSim/Framework/AgentUpdateArgs.cs
@@ -30,18 +30,52 @@ using OpenMetaverse;
 
 namespace OpenSim.Framework
 {
+    /// <summary>
+    /// Client provided parameters for avatar movement
+    /// </summary>
     public class AgentUpdateArgs : EventArgs
     {
+        /// <summary>
+        /// Agent's unique ID
+        /// </summary>
         public UUID AgentID;
+
+        /// <summary>
+        /// Rotation of the avatar's body
+        /// </summary>
         public Quaternion BodyRotation;
+
+        /// <summary>
+        /// AT portion of the camera matrix
+        /// </summary>
         public Vector3 CameraAtAxis;
+
+        /// <summary>
+        /// Position of the camera in the Scene
+        /// </summary>
         public Vector3 CameraCenter;
         public Vector3 CameraLeftAxis;
         public Vector3 CameraUpAxis;
+
+        /// <summary>
+        /// Bitflag field for agent movement.  Fly, forward, backward, turn left, turn right, go up, go down, Straffe, etc.
+        /// </summary>
         public uint ControlFlags;
+
+        /// <summary>
+        /// Agent's client Draw distance setting
+        /// </summary>
         public float Far;
         public byte Flags;
+
+        /// <summary>
+        /// Rotation of the avatar's head
+        /// </summary>
         public Quaternion HeadRotation;
+
+        /// <summary>
+        /// Session Id
+        /// </summary>
         public UUID SessionID;
         public byte State;
     }
diff --git a/OpenSim/Framework/Animation.cs b/OpenSim/Framework/Animation.cs
index 9f86513..232f5a1 100644
--- a/OpenSim/Framework/Animation.cs
+++ b/OpenSim/Framework/Animation.cs
@@ -31,10 +31,17 @@ using OpenMetaverse.StructuredData;
 
 namespace OpenSim.Framework
 {
+    /// <summary>
+    /// Information about an Animation
+    /// </summary>
     [Serializable]
     public class Animation
     {
         private UUID animID;
+
+        /// <summary>
+        /// ID of Animation
+        /// </summary>
         public UUID AnimID
         {
             get { return animID; }
@@ -49,6 +56,10 @@ namespace OpenSim.Framework
         }
 
         private UUID objectID;
+
+        /// <summary>
+        /// Unique ID of object that is being animated
+        /// </summary>
         public UUID ObjectID
         {
             get { return objectID; }
@@ -59,6 +70,12 @@ namespace OpenSim.Framework
         {
         }
 
+        /// <summary>
+        /// Creates an Animation based on the data
+        /// </summary>
+        /// <param name="animID">UUID ID of animation</param>
+        /// <param name="sequenceNum"></param>
+        /// <param name="objectID">ID of object to be animated</param>
         public Animation(UUID animID, int sequenceNum, UUID objectID)
         {
             this.animID = animID;
@@ -66,11 +83,20 @@ namespace OpenSim.Framework
             this.objectID = objectID;
         }
 
+        /// <summary>
+        /// Animation from OSDMap from LLSD XML or LLSD json
+        /// </summary>
+        /// <param name="args"></param>
         public Animation(OSDMap args)
         {
             UnpackUpdateMessage(args);
         }
 
+
+        /// <summary>
+        /// Pack this object up as an OSDMap for transferring via LLSD XML or LLSD json
+        /// </summary>
+        /// <returns></returns>
         public OSDMap PackUpdateMessage()
         {
             OSDMap anim = new OSDMap();
@@ -80,6 +106,10 @@ namespace OpenSim.Framework
             return anim;
         }
 
+        /// <summary>
+        /// Fill object with data from OSDMap
+        /// </summary>
+        /// <param name="args"></param>
         public void UnpackUpdateMessage(OSDMap args)
         {
             if (args["animation"] != null)
diff --git a/OpenSim/Framework/AssetBase.cs b/OpenSim/Framework/AssetBase.cs
index 614670c..9679ff2 100644
--- a/OpenSim/Framework/AssetBase.cs
+++ b/OpenSim/Framework/AssetBase.cs
@@ -31,10 +31,20 @@ using OpenMetaverse;
 
 namespace OpenSim.Framework
 {
+    /// <summary>
+    /// Asset class.   All Assets are reference by this class or a class derived from this class
+    /// </summary>
     [Serializable]
     public class AssetBase
     {
+        /// <summary>
+        /// Data of the Asset
+        /// </summary>
         private byte[] m_data;
+
+        /// <summary>
+        /// Meta Data of the Asset
+        /// </summary>
         private AssetMetadata m_metadata;
 
         public AssetBase()
@@ -71,6 +81,9 @@ namespace OpenSim.Framework
 
         }
 
+        /// <summary>
+        /// Checks if this asset is a binary or text asset
+        /// </summary>
         public bool IsBinaryAsset
         {
             get
@@ -102,12 +115,17 @@ namespace OpenSim.Framework
             set { m_data = value; }
         }
 
+        /// <summary>
+        /// Asset UUID
+        /// </summary>
         public UUID FullID
         {
             get { return m_metadata.FullID; }
             set { m_metadata.FullID = value; }
         }
-
+        /// <summary>
+        /// Asset MetaData ID (transferring from UUID to string ID)
+        /// </summary>
         public string ID
         {
             get { return m_metadata.ID; }
@@ -126,18 +144,27 @@ namespace OpenSim.Framework
             set { m_metadata.Description = value; }
         }
 
+        /// <summary>
+        /// (sbyte) AssetType enum
+        /// </summary>
         public sbyte Type
         {
             get { return m_metadata.Type; }
             set { m_metadata.Type = value; }
         }
 
+        /// <summary>
+        /// Is this a region only asset, or does this exist on the asset server also
+        /// </summary>
         public bool Local
         {
             get { return m_metadata.Local; }
             set { m_metadata.Local = value; }
         }
 
+        /// <summary>
+        /// Is this asset going to be saved to the asset database?
+        /// </summary>
         public bool Temporary
         {
             get { return m_metadata.Temporary; }
diff --git a/OpenSim/Framework/AvatarAppearance.cs b/OpenSim/Framework/AvatarAppearance.cs
index 6a07bc9..7270f32 100644
--- a/OpenSim/Framework/AvatarAppearance.cs
+++ b/OpenSim/Framework/AvatarAppearance.cs
@@ -28,14 +28,13 @@
 using System;
 using System.Collections;
 using System.Collections.Generic;
-using System.Runtime.Serialization;
-using System.Security.Permissions;
 using OpenMetaverse;
-using log4net;
-using System.Reflection;
 
 namespace OpenSim.Framework
 {
+    /// <summary>
+    /// Contains the Avatar's Appearance and methods to manipulate the appearance.
+    /// </summary>
     public class AvatarAppearance
     {
         //private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
diff --git a/OpenSim/Framework/AvatarPickerAvatar.cs b/OpenSim/Framework/AvatarPickerAvatar.cs
index 0e8602d..200c054 100644
--- a/OpenSim/Framework/AvatarPickerAvatar.cs
+++ b/OpenSim/Framework/AvatarPickerAvatar.cs
@@ -29,10 +29,24 @@ using OpenMetaverse;
 
 namespace OpenSim.Framework
 {
+    /// <summary>
+    /// Avatar returned by the Avatar Picker request
+    /// </summary>
     public class AvatarPickerAvatar
     {
+        /// <summary>
+        /// Avatar's Unique ID
+        /// </summary>
         public UUID AvatarID;
+
+        /// <summary>
+        /// Avatar's Account first name
+        /// </summary>
         public string firstName;
+
+        /// <summary>
+        /// Avatar's Account last name
+        /// </summary>
         public string lastName;
     }
 }
diff --git a/OpenSim/Framework/AvatarPickerReplyAgentDataArgs.cs b/OpenSim/Framework/AvatarPickerReplyAgentDataArgs.cs
index 8fd21d7..54835da 100644
--- a/OpenSim/Framework/AvatarPickerReplyAgentDataArgs.cs
+++ b/OpenSim/Framework/AvatarPickerReplyAgentDataArgs.cs
@@ -30,9 +30,19 @@ using OpenMetaverse;
 
 namespace OpenSim.Framework
 {
+    /// <summary>
+    /// Args to return to a client that queries picker data
+    /// </summary>
     public class AvatarPickerReplyAgentDataArgs : EventArgs
     {
+        /// <summary>
+        /// Unique Agent ID
+        /// </summary>
         public UUID AgentID;
+
+        /// <summary>
+        /// ID of query user submitted
+        /// </summary>
         public UUID QueryID;
     }
 }
diff --git a/OpenSim/Framework/Culture.cs b/OpenSim/Framework/Culture.cs
index c76841d..2066794 100644
--- a/OpenSim/Framework/Culture.cs
+++ b/OpenSim/Framework/Culture.cs
@@ -45,6 +45,9 @@ namespace OpenSim.Framework
             get { return m_cultureInfo; }
         }
 
+        /// <summary>
+        /// Set Culture to en-US to make string processing of numbers simpler.
+        /// </summary>
         public static void SetCurrentCulture()
         {
             Thread.CurrentThread.CurrentCulture = m_cultureInfo;
diff --git a/OpenSim/Framework/LandData.cs b/OpenSim/Framework/LandData.cs
index d6afb95..94c0d3b 100644
--- a/OpenSim/Framework/LandData.cs
+++ b/OpenSim/Framework/LandData.cs
@@ -31,6 +31,9 @@ using OpenMetaverse;
 
 namespace OpenSim.Framework
 {
+    /// <summary>
+    /// Details of a Parcel of land
+    /// </summary>
     public class LandData
     {
         private Vector3 _AABBMax = new Vector3();
diff --git a/OpenSim/Framework/Servers/BaseOpenSimServer.cs b/OpenSim/Framework/Servers/BaseOpenSimServer.cs
index 2a97528..7a244ff 100644
--- a/OpenSim/Framework/Servers/BaseOpenSimServer.cs
+++ b/OpenSim/Framework/Servers/BaseOpenSimServer.cs
@@ -443,7 +443,7 @@ namespace OpenSim.Framework.Servers
             string inputLine;
             int strcmp;
 
-            if (File.Exists( gitCommitFileName))
+            if (File.Exists(gitCommitFileName))
             {
                 StreamReader CommitFile = File.OpenText(gitCommitFileName);
                 buildVersion = Environment.NewLine + "git# " + CommitFile.ReadLine();