From 0a85d1d767d5ab3b37a3a1a797be843d0b54780e Mon Sep 17 00:00:00 2001
From: Teravus Ovares (Dan Olivares)
Date: Wed, 12 Aug 2009 23:34:12 -0400
Subject: minor:comments
---
OpenSim/Framework/Animation.cs | 30 ++++++++++++++++++++++
OpenSim/Framework/AssetBase.cs | 29 ++++++++++++++++++++-
OpenSim/Framework/AvatarAppearance.cs | 7 +++--
OpenSim/Framework/AvatarPickerAvatar.cs | 14 ++++++++++
.../Framework/AvatarPickerReplyAgentDataArgs.cs | 10 ++++++++
OpenSim/Framework/Culture.cs | 3 +++
OpenSim/Framework/LandData.cs | 3 +++
7 files changed, 91 insertions(+), 5 deletions(-)
(limited to 'OpenSim')
diff --git a/OpenSim/Framework/Animation.cs b/OpenSim/Framework/Animation.cs
index 9f86513..232f5a1 100644
--- a/OpenSim/Framework/Animation.cs
+++ b/OpenSim/Framework/Animation.cs
@@ -31,10 +31,17 @@ using OpenMetaverse.StructuredData;
namespace OpenSim.Framework
{
+ /// <summary>
+ /// Information about an Animation
+ /// </summary>
[Serializable]
public class Animation
{
private UUID animID;
+
+ /// <summary>
+ /// ID of Animation
+ /// </summary>
public UUID AnimID
{
get { return animID; }
@@ -49,6 +56,10 @@ namespace OpenSim.Framework
}
private UUID objectID;
+
+ /// <summary>
+ /// Unique ID of object that is being animated
+ /// </summary>
public UUID ObjectID
{
get { return objectID; }
@@ -59,6 +70,12 @@ namespace OpenSim.Framework
{
}
+ /// <summary>
+ /// Creates an Animation based on the data
+ /// </summary>
+ /// <param name="animID">UUID ID of animation</param>
+ /// <param name="sequenceNum"></param>
+ /// <param name="objectID">ID of object to be animated</param>
public Animation(UUID animID, int sequenceNum, UUID objectID)
{
this.animID = animID;
@@ -66,11 +83,20 @@ namespace OpenSim.Framework
this.objectID = objectID;
}
+ /// <summary>
+ /// Animation from OSDMap from LLSD XML or LLSD json
+ /// </summary>
+ /// <param name="args"></param>
public Animation(OSDMap args)
{
UnpackUpdateMessage(args);
}
+
+ /// <summary>
+ /// Pack this object up as an OSDMap for transferring via LLSD XML or LLSD json
+ /// </summary>
+ /// <returns></returns>
public OSDMap PackUpdateMessage()
{
OSDMap anim = new OSDMap();
@@ -80,6 +106,10 @@ namespace OpenSim.Framework
return anim;
}
+ /// <summary>
+ /// Fill object with data from OSDMap
+ /// </summary>
+ /// <param name="args"></param>
public void UnpackUpdateMessage(OSDMap args)
{
if (args["animation"] != null)
diff --git a/OpenSim/Framework/AssetBase.cs b/OpenSim/Framework/AssetBase.cs
index 614670c..9679ff2 100644
--- a/OpenSim/Framework/AssetBase.cs
+++ b/OpenSim/Framework/AssetBase.cs
@@ -31,10 +31,20 @@ using OpenMetaverse;
namespace OpenSim.Framework
{
+ /// <summary>
+ /// Asset class. All Assets are reference by this class or a class derived from this class
+ /// </summary>
[Serializable]
public class AssetBase
{
+ /// <summary>
+ /// Data of the Asset
+ /// </summary>
private byte[] m_data;
+
+ /// <summary>
+ /// Meta Data of the Asset
+ /// </summary>
private AssetMetadata m_metadata;
public AssetBase()
@@ -71,6 +81,9 @@ namespace OpenSim.Framework
}
+ /// <summary>
+ /// Checks if this asset is a binary or text asset
+ /// </summary>
public bool IsBinaryAsset
{
get
@@ -102,12 +115,17 @@ namespace OpenSim.Framework
set { m_data = value; }
}
+ /// <summary>
+ /// Asset UUID
+ /// </summary>
public UUID FullID
{
get { return m_metadata.FullID; }
set { m_metadata.FullID = value; }
}
-
+ /// <summary>
+ /// Asset MetaData ID (transferring from UUID to string ID)
+ /// </summary>
public string ID
{
get { return m_metadata.ID; }
@@ -126,18 +144,27 @@ namespace OpenSim.Framework
set { m_metadata.Description = value; }
}
+ /// <summary>
+ /// (sbyte) AssetType enum
+ /// </summary>
public sbyte Type
{
get { return m_metadata.Type; }
set { m_metadata.Type = value; }
}
+ /// <summary>
+ /// Is this a region only asset, or does this exist on the asset server also
+ /// </summary>
public bool Local
{
get { return m_metadata.Local; }
set { m_metadata.Local = value; }
}
+ /// <summary>
+ /// Is this asset going to be saved to the asset database?
+ /// </summary>
public bool Temporary
{
get { return m_metadata.Temporary; }
diff --git a/OpenSim/Framework/AvatarAppearance.cs b/OpenSim/Framework/AvatarAppearance.cs
index 6a07bc9..7270f32 100644
--- a/OpenSim/Framework/AvatarAppearance.cs
+++ b/OpenSim/Framework/AvatarAppearance.cs
@@ -28,14 +28,13 @@
using System;
using System.Collections;
using System.Collections.Generic;
-using System.Runtime.Serialization;
-using System.Security.Permissions;
using OpenMetaverse;
-using log4net;
-using System.Reflection;
namespace OpenSim.Framework
{
+ /// <summary>
+ /// Contains the Avatar's Appearance and methods to manipulate the appearance.
+ /// </summary>
public class AvatarAppearance
{
//private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
diff --git a/OpenSim/Framework/AvatarPickerAvatar.cs b/OpenSim/Framework/AvatarPickerAvatar.cs
index 0e8602d..200c054 100644
--- a/OpenSim/Framework/AvatarPickerAvatar.cs
+++ b/OpenSim/Framework/AvatarPickerAvatar.cs
@@ -29,10 +29,24 @@ using OpenMetaverse;
namespace OpenSim.Framework
{
+ /// <summary>
+ /// Avatar returned by the Avatar Picker request
+ /// </summary>
public class AvatarPickerAvatar
{
+ /// <summary>
+ /// Avatar's Unique ID
+ /// </summary>
public UUID AvatarID;
+
+ /// <summary>
+ /// Avatar's Account first name
+ /// </summary>
public string firstName;
+
+ /// <summary>
+ /// Avatar's Account last name
+ /// </summary>
public string lastName;
}
}
diff --git a/OpenSim/Framework/AvatarPickerReplyAgentDataArgs.cs b/OpenSim/Framework/AvatarPickerReplyAgentDataArgs.cs
index 8fd21d7..54835da 100644
--- a/OpenSim/Framework/AvatarPickerReplyAgentDataArgs.cs
+++ b/OpenSim/Framework/AvatarPickerReplyAgentDataArgs.cs
@@ -30,9 +30,19 @@ using OpenMetaverse;
namespace OpenSim.Framework
{
+ /// <summary>
+ /// Args to return to a client that queries picker data
+ /// </summary>
public class AvatarPickerReplyAgentDataArgs : EventArgs
{
+ /// <summary>
+ /// Unique Agent ID
+ /// </summary>
public UUID AgentID;
+
+ /// <summary>
+ /// ID of query user submitted
+ /// </summary>
public UUID QueryID;
}
}
diff --git a/OpenSim/Framework/Culture.cs b/OpenSim/Framework/Culture.cs
index c76841d..2066794 100644
--- a/OpenSim/Framework/Culture.cs
+++ b/OpenSim/Framework/Culture.cs
@@ -45,6 +45,9 @@ namespace OpenSim.Framework
get { return m_cultureInfo; }
}
+ /// <summary>
+ /// Set Culture to en-US to make string processing of numbers simpler.
+ /// </summary>
public static void SetCurrentCulture()
{
Thread.CurrentThread.CurrentCulture = m_cultureInfo;
diff --git a/OpenSim/Framework/LandData.cs b/OpenSim/Framework/LandData.cs
index d6afb95..94c0d3b 100644
--- a/OpenSim/Framework/LandData.cs
+++ b/OpenSim/Framework/LandData.cs
@@ -31,6 +31,9 @@ using OpenMetaverse;
namespace OpenSim.Framework
{
+ /// <summary>
+ /// Details of a Parcel of land
+ /// </summary>
public class LandData
{
private Vector3 _AABBMax = new Vector3();
--
cgit v1.1