From 4ab5803911180231f370b675b63f717818b79858 Mon Sep 17 00:00:00 2001
From: Adam Frisby
Date: Sat, 7 Apr 2007 17:37:04 +0000
Subject: Documentation!

---
 OpenSim.RegionServer/world/Entity.cs | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

(limited to 'OpenSim.RegionServer/world/Entity.cs')

diff --git a/OpenSim.RegionServer/world/Entity.cs b/OpenSim.RegionServer/world/Entity.cs
index b59d200..96e039a 100644
--- a/OpenSim.RegionServer/world/Entity.cs
+++ b/OpenSim.RegionServer/world/Entity.cs
@@ -62,7 +62,9 @@ namespace OpenSim.world
             }
         }
 
-        
+        /// <summary>
+        /// Creates a new Entity (should not occur on it's own)
+        /// </summary>
         public Entity()
         {
             uuid = new libsecondlife.LLUUID();
@@ -81,6 +83,10 @@ namespace OpenSim.world
                 child.addForces();
             }
         }
+
+        /// <summary>
+        /// Performs any updates that need to be done at each frame. This function is overridable from it's children.
+        /// </summary>
         public virtual void update() {
             // Do any per-frame updates needed that are applicable to every type of entity
             foreach (Entity child in children)
@@ -89,6 +95,10 @@ namespace OpenSim.world
             }
         }
 
+        /// <summary>
+        /// Returns a mesh for this object and any dependents
+        /// </summary>
+        /// <returns>The mesh of this entity tree</returns>
         public virtual Mesh getMesh()
         {
             Mesh mesh = new Mesh();
-- 
cgit v1.1