From 7f3bfa277b894b90e660badf5ee47e4d99ef102c Mon Sep 17 00:00:00 2001
From: Justin Clarke Casey
Date: Tue, 16 Sep 2008 16:37:16 +0000
Subject: * minor: method documentation

---
 .../ScriptEngine/Interfaces/IScriptEngine.cs       | 22 +++++++++++++++++-----
 .../ScriptEngine/Interfaces/IScriptInstance.cs     |  8 ++++++++
 2 files changed, 25 insertions(+), 5 deletions(-)

(limited to 'OpenSim/Region/ScriptEngine/Interfaces')

diff --git a/OpenSim/Region/ScriptEngine/Interfaces/IScriptEngine.cs b/OpenSim/Region/ScriptEngine/Interfaces/IScriptEngine.cs
index 43c2487..ba7e653 100644
--- a/OpenSim/Region/ScriptEngine/Interfaces/IScriptEngine.cs
+++ b/OpenSim/Region/ScriptEngine/Interfaces/IScriptEngine.cs
@@ -36,28 +36,40 @@ using Amib.Threading;
 
 namespace OpenSim.Region.ScriptEngine.Interfaces
 {
+    /// <summary>
+    /// An interface for a script API module to communicate with
+    /// the engine it's running under
+    /// </summary>
     public interface IScriptEngine
     {
-        //
-        // An interface for a script API module to communicate with
-        // the engine it's running under
-        //
-
         Scene World { get; }
         IConfig Config { get; }
         Object AsyncCommands { get; }
         ILog Log { get; }
         string ScriptEngineName { get; }
 
+        /// <summary>
+        /// Post an event to a single script
+        /// </summary>
         bool PostScriptEvent(UUID itemID, EventParams parms);
+        
+        /// <summary>
+        /// Post event to an entire prim
+        /// </summary>
         bool PostObjectEvent(uint localID, EventParams parms);
+        
         void ApiResetScript(UUID itemID);
         void ResetScript(UUID itemID);
         void SetScriptState(UUID itemID, bool state);
         bool GetScriptState(UUID itemID);
         void SetState(UUID itemID, string newState);
         int GetStartParameter(UUID itemID);
+           
+        /// <summary>
+        /// Queue an event for execution
+        /// </summary>
         IScriptWorkItem QueueEventHandler(object parms);
+        
         IScriptApi GetApi(UUID itemID, string name);
 
         DetectParams GetDetectParams(UUID item, int number);
diff --git a/OpenSim/Region/ScriptEngine/Interfaces/IScriptInstance.cs b/OpenSim/Region/ScriptEngine/Interfaces/IScriptInstance.cs
index 169955c..a05edbd 100644
--- a/OpenSim/Region/ScriptEngine/Interfaces/IScriptInstance.cs
+++ b/OpenSim/Region/ScriptEngine/Interfaces/IScriptInstance.cs
@@ -50,6 +50,9 @@ namespace OpenSim.Region.ScriptEngine.Interfaces
         bool Wait(TimeSpan t);
     }
 
+    /// <summary>
+    /// Interface for interaction with a particular script instance
+    /// </summary>
     public interface IScriptInstance
     {
         bool Running { get; set; }
@@ -75,6 +78,11 @@ namespace OpenSim.Region.ScriptEngine.Interfaces
         void SetState(string state);
 
         void PostEvent(EventParams data);
+        
+        /// <summary>
+        /// Process the next event queued for this script
+        /// </summary>
+        /// <returns></returns>
         object EventProcessor();
 
         int EventTime();
-- 
cgit v1.1