From f1e13468069b8dc2719b12f0bc9bb3cc0d999e2a Mon Sep 17 00:00:00 2001
From: MW
Date: Thu, 31 May 2007 10:12:55 +0000
Subject: Added a few summary comments to OpenSim.World files

---
 OpenSim/OpenSim.World/Avatar.cs | 50 ++++++++++++++++++++++++++++++++++++++---
 1 file changed, 47 insertions(+), 3 deletions(-)

(limited to 'OpenSim/OpenSim.World/Avatar.cs')

diff --git a/OpenSim/OpenSim.World/Avatar.cs b/OpenSim/OpenSim.World/Avatar.cs
index 1c22977..ecd938b 100644
--- a/OpenSim/OpenSim.World/Avatar.cs
+++ b/OpenSim/OpenSim.World/Avatar.cs
@@ -39,6 +39,13 @@ namespace OpenSim.world
         private bool childAvatar = false;
         private RegionInfo regionData;
 
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="theClient"></param>
+        /// <param name="world"></param>
+        /// <param name="clientThreads"></param>
+        /// <param name="regionDat"></param>
         public Avatar(IClientAPI theClient, World world, Dictionary<uint, IClientAPI> clientThreads, RegionInfo regionDat)
         {
 
@@ -84,6 +91,9 @@ namespace OpenSim.world
              * */
         }
 
+        /// <summary>
+        /// 
+        /// </summary>
         public PhysicsActor PhysActor
         {
             set
@@ -96,21 +106,36 @@ namespace OpenSim.world
             }
         }
 
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="status"></param>
         public void ChildStatusChange(bool status)
         {
 
         }
-
+        
+        /// <summary>
+        /// 
+        /// </summary>
         public override void addForces()
         {
 
         }
 
+        /// <summary>
+        ///  likely to removed very soon
+        /// </summary>
+        /// <param name="name"></param>
         public static void SetupTemplate(string name)
         {
 
         }
 
+        /// <summary>
+        /// likely to removed very soon
+        /// </summary>
+        /// <param name="objdata"></param>
         protected static void SetDefaultPacketValues(ObjectUpdatePacket.ObjectDataBlock objdata)
         {
 
@@ -118,32 +143,51 @@ namespace OpenSim.world
 
         }
 
+        /// <summary>
+        /// 
+        /// </summary>
         public void CompleteMovement()
         {
             this.ControllingClient.MoveAgentIntoRegion(this.regionData);
         }
 
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="pack"></param>
         public void HandleAgentUpdate(Packet pack)
         {
             this.HandleUpdate((AgentUpdatePacket)pack);
         }
 
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="pack"></param>
         public void HandleUpdate(AgentUpdatePacket pack)
         {
 
         }
 
-        //really really should be moved somewhere else (RegionInfo.cs ?)
+        /// <summary>
+        /// 
+        /// </summary>
         public void SendRegionHandshake()
         {
             this.ControllingClient.SendRegionHandshake(this.regionData);
         }
 
+        /// <summary>
+        /// 
+        /// </summary>
         public static void LoadAnims()
         {
 
         }
-
+        
+        /// <summary>
+        /// 
+        /// </summary>
         public override void LandRenegerated()
         {
 
-- 
cgit v1.1