From b9e0f1cd2be3fe8b20d639d66f5f4fc8f1995d73 Mon Sep 17 00:00:00 2001
From: SignpostMarv
Date: Fri, 5 Oct 2012 14:46:31 +0100
Subject: documenting ISoundModule methods & fields

---
 .../Region/Framework/Interfaces/ISoundModule.cs    | 28 ++++++++++++++++++++++
 1 file changed, 28 insertions(+)

(limited to 'OpenSim/Region')

diff --git a/OpenSim/Region/Framework/Interfaces/ISoundModule.cs b/OpenSim/Region/Framework/Interfaces/ISoundModule.cs
index 90fe0bc..6930d78 100644
--- a/OpenSim/Region/Framework/Interfaces/ISoundModule.cs
+++ b/OpenSim/Region/Framework/Interfaces/ISoundModule.cs
@@ -32,11 +32,39 @@ namespace OpenSim.Region.Framework.Interfaces
 {
     public interface ISoundModule
     {
+        /// <summary>
+        /// Maximum distance between a sound source and a recipient.
+        /// </summary>
         float MaxDistance { get; }
 
+        /// <summary>
+        /// Play a sound from an object.
+        /// </summary>
+        /// <param name="soundID">Sound asset ID</param>
+        /// <param name="ownerID">Sound source owner</param>
+        /// <param name="objectID">Sound source ID</param>
+        /// <param name="gain">Sound volume</param>
+        /// <param name="position">Sound source position</param>
+        /// <param name="flags">Sound flags</param>
+        /// <param name="radius">
+        /// Radius used to affect gain over distance.
+        /// </param>
         void PlayAttachedSound(UUID soundID, UUID ownerID, UUID objectID,
                 double gain, Vector3 position, byte flags, float radius);
 
+        /// <summary>
+        /// Trigger a sound in the scene.
+        /// </summary>
+        /// <param name="soundId">Sound asset ID</param>
+        /// <param name="ownerID">Sound source owner</param>
+        /// <param name="objectID">Sound source ID</param>
+        /// <param name="parentID">Sound source parent.</param>
+        /// <param name="gain">Sound volume</param>
+        /// <param name="position">Sound source position</param>
+        /// <param name="handle"></param>
+        /// <param name="radius">
+        /// Radius used to affect gain over distance.
+        /// </param>
         void TriggerSound(
                 UUID soundId, UUID ownerID, UUID objectID, UUID parentID,
                 double gain, Vector3 position, UInt64 handle, float radius);
-- 
cgit v1.1