From 0e5f5538bcaa031ae252468e5c0b70e5dce1a9b1 Mon Sep 17 00:00:00 2001
From: SignpostMarv
Date: Fri, 14 Sep 2012 13:20:14 +0100
Subject: Documentation of IScriptModuleComms.RegisterConstant and
 IScriptModuleComms.LookupModConstant

Signed-off-by: Melanie <melanie@t-data.com>
---
 .../Region/Framework/Interfaces/IScriptModuleComms.cs | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

(limited to 'OpenSim/Region/Framework/Interfaces/IScriptModuleComms.cs')

diff --git a/OpenSim/Region/Framework/Interfaces/IScriptModuleComms.cs b/OpenSim/Region/Framework/Interfaces/IScriptModuleComms.cs
index 277c9ed..93930ce 100644
--- a/OpenSim/Region/Framework/Interfaces/IScriptModuleComms.cs
+++ b/OpenSim/Region/Framework/Interfaces/IScriptModuleComms.cs
@@ -104,7 +104,18 @@ namespace OpenSim.Region.Framework.Interfaces
         /// <param name="key"></param>
         void DispatchReply(UUID scriptId, int code, string text, string key);
 
-        /// For constants
+        /// <summary>
+        /// Operation to for a region module to register a constant to be used
+        /// by the script engine
+        /// </summary>
+        /// <param name="cname">
+        /// The name of the constant. LSL convention is for constant names to
+        /// be uppercase.
+        /// </param>
+        /// <param name="value">
+        /// The value of the constant. Should be of a type that can be
+        /// converted to one of <see cref="OpenSim.Region.ScriptEngine.Shared.LSL_Types"/>
+        /// </param>
         void RegisterConstant(string cname, object value);
 
         /// <summary>
@@ -113,6 +124,12 @@ namespace OpenSim.Region.Framework.Interfaces
         /// </summary>
         /// <param name="target"></param>
         void RegisterConstants(IRegionModuleBase target);
+
+        /// <summary>
+        /// Operation to check for a registered constant
+        /// </summary>
+        /// <param name="cname">Name of constant</param>
+        /// <returns>Value of constant or null if none found.</returns>
         object LookupModConstant(string cname);
 
         // For use ONLY by the script API
-- 
cgit v1.1