From 18634e9dd8464ee7514587d0645e38f529f0bb3e Mon Sep 17 00:00:00 2001
From: Teravus Ovares (Dan Olivares)
Date: Wed, 12 Aug 2009 23:18:00 -0400
Subject: minor: comments

---
 OpenSim/Framework/ACL.cs              | 19 ++++++++++
 OpenSim/Framework/AgentCircuitData.cs | 68 +++++++++++++++++++++++++++++++++++
 OpenSim/Framework/AgentUpdateArgs.cs  | 34 ++++++++++++++++++
 3 files changed, 121 insertions(+)

(limited to 'OpenSim/Framework')

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;
     }
-- 
cgit v1.1