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/OpenSimMain.cs  | 20 ++++++++++++++++++++
 OpenSim.RegionServer/world/Entity.cs | 12 +++++++++++-
 2 files changed, 31 insertions(+), 1 deletion(-)

diff --git a/OpenSim.RegionServer/OpenSimMain.cs b/OpenSim.RegionServer/OpenSimMain.cs
index fa5dfc2..f4eea11 100644
--- a/OpenSim.RegionServer/OpenSimMain.cs
+++ b/OpenSim.RegionServer/OpenSimMain.cs
@@ -96,6 +96,9 @@ namespace OpenSim
             OpenSim.Framework.Console.MainConsole.Instance = m_console;
         }
 
+        /// <summary>
+        /// Performs initialisation of the world, such as loading configuration from disk.
+        /// </summary>
         public virtual void StartUp()
         {
             this.regionData = new RegionInfo();
@@ -358,6 +361,9 @@ namespace OpenSim
             }
         }
 
+        /// <summary>
+        /// Performs any last-minute sanity checking and shuts down the region server
+        /// </summary>
         public virtual void Shutdown()
         {
             m_console.WriteLine("Main.cs:Shutdown() - Closing all threads");
@@ -371,11 +377,21 @@ namespace OpenSim
             Environment.Exit(0);
         }
 
+        /// <summary>
+        /// Performs per-frame updates regularly
+        /// </summary>
+        /// <param name="sender"></param>
+        /// <param name="e"></param>
         void Heartbeat(object sender, System.EventArgs e)
         {
             LocalWorld.Update();
         }
 
+        /// <summary>
+        /// Runs commands issued by the server console from the operator
+        /// </summary>
+        /// <param name="command">The first argument of the parameter (the command)</param>
+        /// <param name="cmdparams">Additional arguments passed to the command</param>
         public void RunCmd(string command, string[] cmdparams)
         {
             switch (command)
@@ -400,6 +416,10 @@ namespace OpenSim
             }
         }
 
+        /// <summary>
+        /// Outputs to the console information about the region
+        /// </summary>
+        /// <param name="ShowWhat">What information to display (valid arguments are "uptime", "users")</param>
         public void Show(string ShowWhat)
         {
             switch (ShowWhat)
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