From d9f40d1ebceb041038a0640368b6577074905c85 Mon Sep 17 00:00:00 2001
From: "Justin Clark-Casey (justincc)" <jjustincc@googlemail.com>
Date: Tue, 3 Jul 2012 23:19:11 +0100
Subject: [PATCH] minor: Add some method doc to HasGroupChanged and Schedule
 GroupForFull/PartUpdate() to indicate when region modules need to invoke them

---
 .../Framework/Scenes/SceneObjectGroup.cs      | 23 +++++++++++++++++--
 1 file changed, 21 insertions(+), 2 deletions(-)

diff --git a/OpenSim/Region/Framework/Scenes/SceneObjectGroup.cs b/OpenSim/Region/Framework/Scenes/SceneObjectGroup.cs
index a4dbe06286..e9d1cb9d03 100644
--- a/OpenSim/Region/Framework/Scenes/SceneObjectGroup.cs
+++ b/OpenSim/Region/Framework/Scenes/SceneObjectGroup.cs
@@ -108,6 +108,15 @@ namespace OpenSim.Region.Framework.Scenes
         private long timeFirstChanged;
         private long timeLastChanged;
 
+        /// <summary>
+        /// This indicates whether the object has changed such that it needs to be repersisted to permenant storage
+        /// (the database).
+        /// </summary>
+        /// <remarks>
+        /// Ultimately, this should be managed such that region modules can change it at the end of a set of operations
+        /// so that either all changes are preserved or none at all.  However, currently, a large amount of internal
+        /// code will set this anyway when some object properties are changed.
+        /// </remarks>
         public bool HasGroupChanged
         {
             set
@@ -1810,8 +1819,13 @@ namespace OpenSim.Region.Framework.Scenes
         }
 
         /// <summary>
-        /// Schedule a full update for this scene object
+        /// Schedule a full update for this scene object to all interested viewers.
         /// </summary>
+        /// <remarks>
+        /// Ultimately, this should be managed such that region modules can invoke it at the end of a set of operations
+        /// so that either all changes are sent at once.  However, currently, a large amount of internal
+        /// code will set this anyway when some object properties are changed.
+        /// </remarks>
         public void ScheduleGroupForFullUpdate()
         {
 //            if (IsAttachment)
@@ -1830,8 +1844,13 @@ namespace OpenSim.Region.Framework.Scenes
         }
 
         /// <summary>
-        /// Schedule a terse update for this scene object
+        /// Schedule a terse update for this scene object to all interested viewers.
         /// </summary>
+        /// <remarks>
+        /// Ultimately, this should be managed such that region modules can invoke it at the end of a set of operations
+        /// so that either all changes are sent at once.  However, currently, a large amount of internal
+        /// code will set this anyway when some object properties are changed.
+        /// </remarks>
         public void ScheduleGroupForTerseUpdate()
         {
 //            m_log.DebugFormat("[SOG]: Scheduling terse update for {0} {1}", Name, UUID);