minor: method documentation

OpenSim/Region/Environment/Scenes/InnerScene.cs

@@ -747,6 +747,11 @@ namespace OpenSim.Region.Environment.Scenes
             return sp;
         }
 
+        /// <summary>
+        /// Get a scene object group that contains the prim with the given local id
+        /// </summary>
+        /// <param name="localID"></param>
+        /// <returns>null if no scene object group containing that prim is found</returns>
         private SceneObjectGroup GetGroupByPrim(uint localID)
         {
             List<EntityBase> EntityList = GetEntities();
@@ -762,6 +767,11 @@ namespace OpenSim.Region.Environment.Scenes
             return null;
         }
 
+        /// <summary>
+        /// Get a scene object group that contains the prim with the given uuid
+        /// </summary>
+        /// <param name="fullID"></param>
+        /// <returns>null if no scene object group containing that prim is found</returns>        
         private SceneObjectGroup GetGroupByPrim(LLUUID fullID)
         {
             List<EntityBase> EntityList = GetEntities();
@@ -802,15 +812,26 @@ namespace OpenSim.Region.Environment.Scenes
             return returnResult;
         }
 
+        /// <summary>
+        /// Get a part contained in this scene.
+        /// </summary>
+        /// <param name="localID"></param>
+        /// <returns>null if the part was not found</returns>
         protected internal SceneObjectPart GetSceneObjectPart(uint localID)
         {
             SceneObjectGroup group = GetGroupByPrim(localID);
+            
             if (group != null)
                 return group.GetChildPart(localID);
             else
                 return null;
         }
 
+        /// <summary>
+        /// Get a part contained in this scene.
+        /// </summary>
+        /// <param name="fullID"></param>
+        /// <returns>null if the part was not found</returns>        
         protected internal SceneObjectPart GetSceneObjectPart(LLUUID fullID)
         {
             SceneObjectGroup group = GetGroupByPrim(fullID);

OpenSim/Region/Environment/Scenes/SceneObjectGroup.cs

@@ -442,13 +442,13 @@ namespace OpenSim.Region.Environment.Scenes
                 }
                 more = !reader.EOF;
             }
+            
             reader.Close();
             sr.Close();
 
             UpdateParentIDs();
         }
        
-       
         /// <summary>
         ///
         /// </summary>
@@ -832,7 +832,7 @@ namespace OpenSim.Region.Environment.Scenes
         }
 
         /// <summary>
-        ///
+        /// Make sure that every non root part has the proper parent root part local id
         /// </summary>
         public void UpdateParentIDs()
         {
@@ -1663,6 +1663,7 @@ namespace OpenSim.Region.Environment.Scenes
             {
                 return true;
             }
+            
             return false;
         }
 
@@ -1684,6 +1685,7 @@ namespace OpenSim.Region.Environment.Scenes
                     }
                 }
             }
+            
             return false;
         }
 

OpenSim/Region/Environment/Scenes/SceneObjectPart.cs

@@ -819,152 +819,102 @@ namespace OpenSim.Region.Environment.Scenes
             }
         }
 
-        public uint ParentID {
+        public uint ParentID 
-            get {
+        {
-                return _parentID;
+            get { return _parentID; }
-            }
+            set { _parentID = value; }
-            set {
-                _parentID = value;
-            }
         }
 
-        public int CreationDate {
+        public int CreationDate 
-            get {
+        {
-                return _creationDate;
+            get { return _creationDate; }
-            }
+            set { _creationDate = value; }
-            set {
-                _creationDate = value;
-            }
         }
 
-        public uint Category {
+        public uint Category 
-            get {
+        {
-                return _category;
+            get { return _category; }
-            }
+            set { _category = value; }
-            set {
-                _category = value;
-            }
         }
 
-        public int SalePrice {
+        public int SalePrice 
-            get {
+        {
-                return _salePrice;
+            get { return _salePrice; }
-            }
+            set { _salePrice = value; }
-            set {
-                _salePrice = value;
-            }
         }
 
-        public byte ObjectSaleType {
+        public byte ObjectSaleType 
-            get {
+        {
-                return _objectSaleType;
+            get { return _objectSaleType; }
-            }
+            set { _objectSaleType = value; }
-            set {
-                _objectSaleType = value;
-            }
         }
 
-        public int OwnershipCost {
+        public int OwnershipCost 
-            get {
+        {
-                return _ownershipCost;
+            get { return _ownershipCost; }
-            }
+            set { _ownershipCost = value; }
-            set {
-                _ownershipCost = value;
-            }
         }
 
-        public LLUUID GroupID {
+        public LLUUID GroupID 
-            get {
+        {
-                return _groupID;
+            get { return _groupID; }
-            }
+            set { _groupID = value; }
-            set {
-                _groupID = value;
-            }
         }
 
-        public LLUUID OwnerID {
+        public LLUUID OwnerID 
-            get {
+        {
-                return _ownerID;
+            get { return _ownerID; }
-            }
+            set { _ownerID = value; }
-            set {
-                _ownerID = value;
-            }
         }
 
-        public LLUUID LastOwnerID {
+        public LLUUID LastOwnerID 
-            get {
+        {
-                return _lastOwnerID;
+            get { return _lastOwnerID; }
-            }
+            set { _lastOwnerID = value; }
-            set {
-                _lastOwnerID = value;
-            }
         }
 
-        public uint BaseMask {
+        public uint BaseMask 
-            get {
+        {
-                return _baseMask;
+            get { return _baseMask; }
-            }
+            set { _baseMask = value; }
-            set {
-                _baseMask = value;
-            }
         }
 
-        public uint OwnerMask {
+        public uint OwnerMask 
-            get {
+        {
-                return _ownerMask;
+            get { return _ownerMask; }
-            }
+            set { _ownerMask = value; }
-            set {
-                _ownerMask = value;
-            }
         }
 
-        public uint GroupMask {
+        public uint GroupMask 
-            get {
+        {
-                return _groupMask;
+            get { return _groupMask; }
-            }
+            set { _groupMask = value; }
-            set {
-                _groupMask = value;
-            }
         }
 
-        public uint EveryoneMask {
+        public uint EveryoneMask 
-            get {
+        {
-                return _everyoneMask;
+            get { return _everyoneMask; }
-            }
+            set { _everyoneMask = value; }
-            set {
-                _everyoneMask = value;
-            }
         }
 
-        public uint NextOwnerMask {
+        public uint NextOwnerMask 
-            get {
+        {
-                return _nextOwnerMask;
+            get { return _nextOwnerMask; }
-            }
+            set { _nextOwnerMask = value; }
-            set {
-                _nextOwnerMask = value;
-            }
         }
 
-        public libsecondlife.LLObject.ObjectFlags Flags {
+        public libsecondlife.LLObject.ObjectFlags Flags 
-            get {
+        {
-                return _flags;
+            get { return _flags; }
-            }
+            set { _flags = value; }
-            set {
-                _flags = value;
-            }
         }
 
-        public LLUUID SitTargetAvatar {
+        public LLUUID SitTargetAvatar 
-            get {
+        {
-                return m_sitTargetAvatar;
+            get { return m_sitTargetAvatar; }
-            }
+            set { m_sitTargetAvatar = value; }
-            set {
-                m_sitTargetAvatar = value;
-            }
         }
         
-
-        
         #endregion Public Properties with only Get
 
         #region Private Methods
@@ -982,7 +932,7 @@ namespace OpenSim.Region.Environment.Scenes
         }
 
         /// <summary>
-        /// Clear all pending updates
+        /// Clear all pending updates of parts to clients
         /// </summary>
         private void ClearUpdateSchedule()
         {