diff --git a/OpenSim.RegionServer/OpenSimMain.cs b/OpenSim.RegionServer/OpenSimMain.cs
index fa5dfc291b..f4eea1110e 100644
--- a/OpenSim.RegionServer/OpenSimMain.cs
+++ b/OpenSim.RegionServer/OpenSimMain.cs
@@ -96,6 +96,9 @@ namespace OpenSim
OpenSim.Framework.Console.MainConsole.Instance = m_console;
}
+ ///
+ /// Performs initialisation of the world, such as loading configuration from disk.
+ ///
public virtual void StartUp()
{
this.regionData = new RegionInfo();
@@ -358,6 +361,9 @@ namespace OpenSim
}
}
+ ///
+ /// Performs any last-minute sanity checking and shuts down the region server
+ ///
public virtual void Shutdown()
{
m_console.WriteLine("Main.cs:Shutdown() - Closing all threads");
@@ -371,11 +377,21 @@ namespace OpenSim
Environment.Exit(0);
}
+ ///
+ /// Performs per-frame updates regularly
+ ///
+ ///
+ ///
void Heartbeat(object sender, System.EventArgs e)
{
LocalWorld.Update();
}
+ ///
+ /// Runs commands issued by the server console from the operator
+ ///
+ /// The first argument of the parameter (the command)
+ /// Additional arguments passed to the command
public void RunCmd(string command, string[] cmdparams)
{
switch (command)
@@ -400,6 +416,10 @@ namespace OpenSim
}
}
+ ///
+ /// Outputs to the console information about the region
+ ///
+ /// What information to display (valid arguments are "uptime", "users")
public void Show(string ShowWhat)
{
switch (ShowWhat)
diff --git a/OpenSim.RegionServer/world/Entity.cs b/OpenSim.RegionServer/world/Entity.cs
index b59d200ed4..96e039aae6 100644
--- a/OpenSim.RegionServer/world/Entity.cs
+++ b/OpenSim.RegionServer/world/Entity.cs
@@ -62,7 +62,9 @@ namespace OpenSim.world
}
}
-
+ ///
+ /// Creates a new Entity (should not occur on it's own)
+ ///
public Entity()
{
uuid = new libsecondlife.LLUUID();
@@ -81,6 +83,10 @@ namespace OpenSim.world
child.addForces();
}
}
+
+ ///
+ /// Performs any updates that need to be done at each frame. This function is overridable from it's children.
+ ///
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
}
}
+ ///
+ /// Returns a mesh for this object and any dependents
+ ///
+ /// The mesh of this entity tree
public virtual Mesh getMesh()
{
Mesh mesh = new Mesh();