From 227db07f2ff8a1ba840a0d3018bb242a34d6038f Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Thu, 13 Oct 2011 18:19:13 +0100
Subject: refactor: move 3x copy/pasted ode structure removal code in
 ODECharacter into a DestroyOdeStructures() method

also adds some method doc
---
 OpenSim/Region/Physics/Manager/PhysicsScene.cs | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

(limited to 'OpenSim/Region/Physics/Manager')

diff --git a/OpenSim/Region/Physics/Manager/PhysicsScene.cs b/OpenSim/Region/Physics/Manager/PhysicsScene.cs
index 04efc1d..052ee9e 100644
--- a/OpenSim/Region/Physics/Manager/PhysicsScene.cs
+++ b/OpenSim/Region/Physics/Manager/PhysicsScene.cs
@@ -75,8 +75,25 @@ namespace OpenSim.Region.Physics.Manager
 
         public abstract void Initialise(IMesher meshmerizer, IConfigSource config);
 
+        /// <summary>
+        /// Add an avatar
+        /// </summary>
+        /// <param name="avName"></param>
+        /// <param name="position"></param>
+        /// <param name="size"></param>
+        /// <param name="isFlying"></param>
+        /// <returns></returns>
         public abstract PhysicsActor AddAvatar(string avName, Vector3 position, Vector3 size, bool isFlying);
 
+        /// <summary>
+        /// Add an avatar
+        /// </summary>
+        /// <param name="localID"></param>
+        /// <param name="avName"></param>
+        /// <param name="position"></param>
+        /// <param name="size"></param>
+        /// <param name="isFlying"></param>
+        /// <returns></returns>
         public virtual PhysicsActor AddAvatar(uint localID, string avName, Vector3 position, Vector3 size, bool isFlying)
         {
             PhysicsActor ret = AddAvatar(avName, position, size, isFlying);
@@ -84,10 +101,14 @@ namespace OpenSim.Region.Physics.Manager
             return ret;
         }
 
+        /// <summary>
+        /// Remove an avatar.
+        /// </summary>
+        /// <param name="actor"></param>
         public abstract void RemoveAvatar(PhysicsActor actor);
 
         /// <summary>
-        /// Remove a prim from the physics scene.
+        /// Remove a prim.
         /// </summary>
         /// <param name="prim"></param>
         public abstract void RemovePrim(PhysicsActor prim);
-- 
cgit v1.1