From ef3cc2e507a545bfcffc804015ee3ec5b8a260e0 Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Tue, 9 Oct 2012 01:40:40 +0100
Subject: minor: Add documentation to IGridService.GetRegionFlags()

---
 OpenSim/Framework/RegionFlags.cs            |  1 +
 OpenSim/Services/Interfaces/IGridService.cs | 13 +++++++++++++
 2 files changed, 14 insertions(+)

(limited to 'OpenSim')

diff --git a/OpenSim/Framework/RegionFlags.cs b/OpenSim/Framework/RegionFlags.cs
index c0630c8..a3089b0 100644
--- a/OpenSim/Framework/RegionFlags.cs
+++ b/OpenSim/Framework/RegionFlags.cs
@@ -34,6 +34,7 @@ namespace OpenSim.Framework
     /// </summary>
     /// <remarks>
     /// Don't confuse with OpenMetaverse.RegionFlags which are client facing flags (i.e. they go over the wire).
+    /// Returned by IGridService.GetRegionFlags()
     /// </remarks>
     [Flags]
     public enum RegionFlags : int
diff --git a/OpenSim/Services/Interfaces/IGridService.cs b/OpenSim/Services/Interfaces/IGridService.cs
index d809996..d7da056 100644
--- a/OpenSim/Services/Interfaces/IGridService.cs
+++ b/OpenSim/Services/Interfaces/IGridService.cs
@@ -100,6 +100,19 @@ namespace OpenSim.Services.Interfaces
         List<GridRegion> GetFallbackRegions(UUID scopeID, int x, int y);
         List<GridRegion> GetHyperlinks(UUID scopeID);
 
+        /// <summary>
+        /// Get internal OpenSimulator region flags.
+        /// </summary>
+        /// <remarks>
+        /// See OpenSimulator.Framework.RegionFlags.  These are not returned in the GridRegion structure -
+        /// they currently need to be requested separately.  Possibly this should change to avoid multiple service calls
+        /// in some situations.
+        /// </remarks>
+        /// <returns>
+        /// The region flags.
+        /// </returns>
+        /// <param name='scopeID'></param>
+        /// <param name='regionID'></param>
         int GetRegionFlags(UUID scopeID, UUID regionID);
     }
 
-- 
cgit v1.1