From c85e2a0fb0702ad6fea544b0b3a01cf0a0580f5b Mon Sep 17 00:00:00 2001
From: Justin Clarke Casey
Date: Wed, 26 Nov 2008 17:42:35 +0000
Subject: * restore deleted method documentation, some to IRegionDataStore and
 some to MySQLRegionData * I would like to keep documentation on methods, even
 if it sometimes seems obvious (and not all of these are)

---
 OpenSim/Data/MySQL/MySQLRegionData.cs              | 11 +++++++++-
 .../Environment/Interfaces/IRegionDataStore.cs     | 25 ++++++++++++++++++++++
 2 files changed, 35 insertions(+), 1 deletion(-)

(limited to 'OpenSim')

diff --git a/OpenSim/Data/MySQL/MySQLRegionData.cs b/OpenSim/Data/MySQL/MySQLRegionData.cs
index f64b142..992e84d 100644
--- a/OpenSim/Data/MySQL/MySQLRegionData.cs
+++ b/OpenSim/Data/MySQL/MySQLRegionData.cs
@@ -307,7 +307,12 @@ namespace OpenSim.Data.MySQL
                 ExecuteNonQuery(cmd);
             }
         }
-
+        
+        /// <summary>
+        /// Remove all persisted items of the given prim.
+        /// The caller must acquire the necessrary synchronization locks and commit or rollback changes.
+        /// </summary>
+        /// <param name="uuid">the Item UUID</param>
         private void RemoveItems(UUID uuid)
         {
             lock (m_Connection)
@@ -403,6 +408,10 @@ namespace OpenSim.Data.MySQL
             return objects;
         }
 
+        /// <summary>
+        /// Load in a prim's persisted inventory.
+        /// </summary>
+        /// <param name="prim">The prim</param>        
         private void LoadItems(SceneObjectPart prim)
         {
             lock (m_Connection)
diff --git a/OpenSim/Region/Environment/Interfaces/IRegionDataStore.cs b/OpenSim/Region/Environment/Interfaces/IRegionDataStore.cs
index 0ee4933..78fc626 100644
--- a/OpenSim/Region/Environment/Interfaces/IRegionDataStore.cs
+++ b/OpenSim/Region/Environment/Interfaces/IRegionDataStore.cs
@@ -67,13 +67,38 @@ namespace OpenSim.Region.Environment.Interfaces
         /// <returns></returns>
         void StorePrimInventory(UUID primID, ICollection<TaskInventoryItem> items);
 
+        /// <summary>
+        /// Load persisted objects from region storage.
+        /// </summary>
+        /// <param name="regionUUID">the Region UUID</param>
+        /// <returns>List of loaded groups</returns>        
         List<SceneObjectGroup> LoadObjects(UUID regionUUID);
 
+        /// <summary>
+        /// Store a terrain revision in region storage
+        /// </summary>
+        /// <param name="ter">HeightField data</param>
+        /// <param name="regionID">region UUID</param>      
         void StoreTerrain(double[,] terrain, UUID regionID);
+        
+        /// <summary>
+        /// Load the latest terrain revision from region storage
+        /// </summary>
+        /// <param name="regionID">the region UUID</param>
+        /// <returns>Heightfield data</returns>        
         double[,] LoadTerrain(UUID regionID);
 
         void StoreLandObject(ILandObject Parcel);
+        
+        /// <summary>
+        /// <list type="bullet">
+        /// <item>delete from land where UUID=globalID</item>
+        /// <item>delete from landaccesslist where LandUUID=globalID</item>
+        /// </list>
+        /// </summary>
+        /// <param name="globalID"></param>     
         void RemoveLandObject(UUID globalID);
+        
         List<LandData> LoadLandObjects(UUID regionUUID);
 
         void StoreRegionSettings(RegionSettings rs);
-- 
cgit v1.1