OpenSim
/
OpenSimMirror
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

minor: put <remarks> tags around some method doc

remove-scene-viewer
Justin Clark-Casey (justincc) 2011-09-12 20:06:09 +01:00
parent 728fd0b1b8
commit 517932722b
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
OpenSim/Region/Framework/Scenes/UuidGatherer.cs
View File

@ -43,11 +43,12 @@ namespace OpenSim.Region.Framework.Scenes
/// <summary> /// <summary>
/// Gather uuids for a given entity. /// Gather uuids for a given entity.
/// </summary> /// </summary>
/// /// <remarks>
/// This does a deep inspection of the entity to retrieve all the assets it uses (whether as textures, as scripts /// This does a deep inspection of the entity to retrieve all the assets it uses (whether as textures, as scripts
/// contained in inventory, as scripts contained in objects contained in another object's inventory, etc. Assets /// contained in inventory, as scripts contained in objects contained in another object's inventory, etc. Assets
/// are only retrieved when they are necessary to carry out the inspection (i.e. a serialized object needs to be /// are only retrieved when they are necessary to carry out the inspection (i.e. a serialized object needs to be
/// retrieved to work out which assets it references). /// retrieved to work out which assets it references).
/// </remarks>
public class UuidGatherer public class UuidGatherer
{ {
private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
@ -76,11 +77,11 @@ namespace OpenSim.Region.Framework.Scenes
/// <summary> /// <summary>
/// Gather all the asset uuids associated with the asset referenced by a given uuid /// Gather all the asset uuids associated with the asset referenced by a given uuid
/// </summary> /// </summary>
/// /// <remarks>
/// This includes both those directly associated with /// This includes both those directly associated with
/// it (e.g. face textures) and recursively, those of items within it's inventory (e.g. objects contained /// it (e.g. face textures) and recursively, those of items within it's inventory (e.g. objects contained
/// within this object). /// within this object).
/// /// </remarks>
/// <param name="assetUuid">The uuid of the asset for which to gather referenced assets</param> /// <param name="assetUuid">The uuid of the asset for which to gather referenced assets</param>
/// <param name="assetType">The type of the asset for the uuid given</param> /// <param name="assetType">The type of the asset for the uuid given</param>
/// <param name="assetUuids">The assets gathered</param> /// <param name="assetUuids">The assets gathered</param>
@ -123,11 +124,11 @@ namespace OpenSim.Region.Framework.Scenes
/// <summary> /// <summary>
/// Gather all the asset uuids associated with a given object. /// Gather all the asset uuids associated with a given object.
/// </summary> /// </summary>
/// /// <remarks>
/// This includes both those directly associated with /// This includes both those directly associated with
/// it (e.g. face textures) and recursively, those of items within it's inventory (e.g. objects contained /// it (e.g. face textures) and recursively, those of items within it's inventory (e.g. objects contained
/// within this object). /// within this object).
/// /// </remarks>
/// <param name="sceneObject">The scene object for which to gather assets</param> /// <param name="sceneObject">The scene object for which to gather assets</param>
/// <param name="assetUuids">The assets gathered</param> /// <param name="assetUuids">The assets gathered</param>
public void GatherAssetUuids(SceneObjectGroup sceneObject, IDictionary<UUID, AssetType> assetUuids) public void GatherAssetUuids(SceneObjectGroup sceneObject, IDictionary<UUID, AssetType> assetUuids)