More documenting. Applied patches #1723 and #1724. Someone test nant build.

git-svn-id: http://libopenmetaverse.googlecode.com/svn/trunk@729 52acb1d6-8a22-11de-b505-999d5b087335
2006-12-16 16:51:04 +00:00
parent acc8ff8eb5
commit a2a9e5bf8a
6 changed files with 66 additions and 45 deletions
--- a/libsecondlife-cs/GridManager.cs
+++ b/libsecondlife-cs/GridManager.cs
@@ -253,7 +253,7 @@ namespace libsecondlife
        /// Populate Grid info based on data from MapBlockReplyPacket
        /// </summary>
        /// <param name="packet">Incoming MapBlockReplyPacket packet</param>
-        /// <param name="simulator">[UNUSED]</param>
+        /// <param name="simulator">Unused</param>
 		private void MapBlockReplyHandler(Packet packet, Simulator simulator) 
 		{
 			GridRegion region;
@@ -301,7 +301,7 @@ namespace libsecondlife
        /// Get sim time from the appropriate packet
        /// </summary>
        /// <param name="packet">Incoming SimulatorViewerTimeMessagePacket from SL</param>
-        /// <param name="simulator">[UNUSED]</param>
+        /// <param name="simulator">Unused</param>
        private void TimeMessageHandler(Packet packet, Simulator simulator)
        {
            SunDirection = ((SimulatorViewerTimeMessagePacket)packet).TimeInfo.SunDirection;
--- a/libsecondlife-cs/MainAvatar.cs
+++ b/libsecondlife-cs/MainAvatar.cs
@@ -35,11 +35,11 @@ namespace libsecondlife
    /// <summary>
    /// Triggered on incoming chat messages
    /// </summary>
-    /// <param name="Message"></param>
-    /// <param name="Audible"></param>
-    /// <param name="Type"></param>
-    /// <param name="Sourcetype"></param>
-    /// <param name="FromName"></param>
+    /// <param name="Message">Text of chat message</param>
+    /// <param name="Audible">Is this normal audible chat or not.</param>
+    /// <param name="Type">Type of chat (whisper,shout,status,etc)</param>
+    /// <param name="Sourcetype">Type of source (Agent / Object / ???)</param>
+    /// <param name="FromName">Text name of sending Avatar/Object</param>
    /// <param name="ID"></param>
    public delegate void ChatCallback(string message, byte audible, byte type, byte sourcetype,
        string fromName, LLUUID id, LLUUID ownerid, LLVector3 position);
@@ -67,17 +67,17 @@ namespace libsecondlife
    /// <summary>
    /// Tiggered on incoming instant messages
    /// </summary>
-    /// <param name="fromAgentID"></param>
-    /// <param name="fromAgentName"></param>
-    /// <param name="toAgentID"></param>
-    /// <param name="parentEstateID"></param>
-    /// <param name="regionID"></param>
-    /// <param name="position"></param>
+    /// <param name="fromAgentID">Key of sender</param>
+    /// <param name="fromAgentName">Name of sender</param>
+    /// <param name="toAgentID">Key of destination Avatar</param>
+    /// <param name="parentEstateID">ID of originating Estate</param>
+    /// <param name="regionID">Key of originating Region</param>
+    /// <param name="position">Coordinates in originating Region</param>
    /// <param name="dialog"></param>
-    /// <param name="groupIM"></param>
-    /// <param name="imSessionID"></param>
-    /// <param name="timestamp"></param>
-    /// <param name="message"></param>
+    /// <param name="groupIM">Group IM session toggle</param>
+    /// <param name="imSessionID">Key of IM Session</param>
+    /// <param name="timestamp">Timestamp of message</param>
+    /// <param name="message">Text of message</param>
    /// <param name="offline"></param>
    /// <param name="binaryBucket"></param>
    public delegate void InstantMessageCallback(LLUUID fromAgentID, string fromAgentName,
@@ -774,6 +774,7 @@ namespace libsecondlife
        /// <summary>
        /// Grabs an object
        /// </summary>
+        /// <param name="objectLocalID">Local ID of Object to grab</param>
        public void Grab(uint objectLocalID)
        {
            ObjectGrabPacket grab = new ObjectGrabPacket();
@@ -889,7 +890,7 @@ namespace libsecondlife
        ///   OnInstantMessage is defined call that with the appropriate arguments.
        /// </summary>
        /// <param name="packet">Incoming ImprovedInstantMessagePacket</param>
-        /// <param name="simulator">[UNUSED]</param>
+        /// <param name="simulator">Unused</param>
        private void InstantMessageHandler(Packet packet, Simulator simulator)
        {
            if (packet.Type == PacketType.ImprovedInstantMessage)
@@ -922,7 +923,7 @@ namespace libsecondlife
        ///   that with the appropriate arguments.
        /// </summary>
        /// <param name="packet">Incoming ChatFromSimulatorPacket</param>
-        /// <param name="simulator">[UNUSED]</param>
+        /// <param name="simulator">Unused</param>
        private void ChatHandler(Packet packet, Simulator simulator)
        {
            if (OnChat != null)
@@ -940,7 +941,11 @@ namespace libsecondlife
                    );
            }
        }
-
+        /// <summary>
+        /// Used for parsing llDialog's
+        /// </summary>
+        /// <param name="packet">Incoming ScriptDialog packet</param>
+        /// <param name="simulator">Unused</param>
        private void ScriptDialogHandler(Packet packet, Simulator simulator)
        {
            if (OnScriptDialog != null)
@@ -968,7 +973,7 @@ namespace libsecondlife
        /// Update client's Position and LookAt from incoming packet
        /// </summary>
        /// <param name="packet">Incoming AgentMovementCompletePacket</param>
-        /// <param name="simulator">[UNUSED]</param>
+        /// <param name="simulator">Unused</param>
        private void MovementCompleteHandler(Packet packet, Simulator simulator)
        {
            AgentMovementCompletePacket movement = (AgentMovementCompletePacket)packet;
@@ -981,7 +986,7 @@ namespace libsecondlife
        /// Update Client Avatar's health via incoming packet
        /// </summary>
        /// <param name="packet">Incoming HealthMessagePacket</param>
-        /// <param name="simulator">[UNUSED]</param>
+        /// <param name="simulator">Unused</param>
        private void HealthHandler(Packet packet, Simulator simulator)
        {
            health = ((HealthMessagePacket)packet).HealthData.Health;
@@ -991,7 +996,7 @@ namespace libsecondlife
        /// Update Client Avatar's L$ balance from incoming packet
        /// </summary>
        /// <param name="packet">Incoming MoneyBalanceReplyPacket</param>
-        /// <param name="simulator">[UNUSED]</param>
+        /// <param name="simulator">Unused</param>
        private void BalanceHandler(Packet packet, Simulator simulator)
        {
            if (packet.Type == PacketType.MoneyBalanceReply)
@@ -1016,8 +1021,8 @@ namespace libsecondlife
        /// <summary>
        /// Handler for teleport Requests
        /// </summary>
-        /// <param name="packet">Packet</param>
-        /// <param name="simulator">Simulator</param>
+        /// <param name="packet">Incoming TeleportHandler packet</param>
+        /// <param name="simulator">Simulator sending teleport information</param>
        private void TeleportHandler(Packet packet, Simulator simulator)
        {
            if (packet.Type == PacketType.TeleportStart)
@@ -1089,8 +1094,8 @@ namespace libsecondlife
                    else
                    {
                        // Sleep a little while so we can collect parcel information
-                        // FIXME: This doesn't belong in libsecondlife
-                        System.Threading.Thread.Sleep(1000);
+                        // NOTE: This doesn't belong in libsecondlife
+                        // System.Threading.Thread.Sleep(1000);
                    }
                }
                else
@@ -1113,7 +1118,7 @@ namespace libsecondlife
        }

        /// <summary>
-        /// Teleport Timer Event Handler
+        /// Teleport Timer Event Handler. Used for enforcing timeouts.
        /// </summary>
        /// <param name="source"></param>
        /// <param name="ea"></param>
--- a/libsecondlife-cs/Settings.cs
+++ b/libsecondlife-cs/Settings.cs
@@ -30,6 +30,9 @@ using libsecondlife.Packets;

 namespace libsecondlife
 {
+    /// <summary>
+    /// Class for controlling various system settings.
+    /// </summary>
    public class Settings
    {
        /// <summary>The version of libsecondlife (not the SL protocol itself)</summary>
@@ -63,7 +66,10 @@ namespace libsecondlife

        private SecondLife Client;
        private int priceUpload = 0;
-
+        /// <summary>
+        /// Constructor
+        /// </summary>
+        /// <param name="client">Client connection Object to use</param>
        public Settings(SecondLife client)
        {
            Client = client;
@@ -71,6 +77,11 @@ namespace libsecondlife
            Client.Network.RegisterCallback(Packets.PacketType.EconomyData, new NetworkManager.PacketCallback(EconomyDataHandler));
        }

+        /// <summary>
+        /// Presumably for outputting asset upload costs.
+        /// </summary>
+        /// <param name="packet"></param>
+        /// <param name="simulator"></param>
        private void EconomyDataHandler(Packet packet, Simulator simulator)
        {
            EconomyDataPacket econ = (EconomyDataPacket)packet;
--- a/libsecondlife-cs/examples/TestClient/Commands/UptimeCommand.cs
+++ b/libsecondlife-cs/examples/TestClient/Commands/UptimeCommand.cs
@@ -6,19 +6,20 @@ using libsecondlife.Packets;

 namespace libsecondlife.TestClient
 {
-    public class UptimeCommand: Command
+    public class UptimeCommand : Command
    {
-		public DateTime Created = DateTime.Now;
+        public DateTime Created = DateTime.Now;

-		public UptimeCommand()
-		{
-			Name = "uptime";
-			Description = "Shows the login time and length of time logged on.";
-		}
+        public UptimeCommand()
+        {
+            Name = "uptime";
+            Description = "Shows the login name, login time and length of time logged on.";
+        }

        public override string Execute(SecondLife Client, string[] args, LLUUID fromAgentID)
-		{
-			return "Up Since: " + Created + " (" + (DateTime.Now - Created) + ")";
-		}
+        {
+            string name = Client.ToString();
+            return "I am " + name + ", Up Since: " + Created + " (" + (DateTime.Now - Created) + ")";
+        }
    }
-}
+}
--- a/libsecondlife-cs/examples/TestClient/TestClient.build
+++ b/libsecondlife-cs/examples/TestClient/TestClient.build
@@ -23,10 +23,10 @@
     - datetime::parse('01/01/2002'))))}" />
  <property
    name="assembly"
-    value="TestCommand"/>
+    value="TestClient"/>
  <property
    name="bin_dir"
-    value="../../bin" />
+    value="../../../bin" />

  <!-- default configuration -->
  <property
@@ -74,7 +74,7 @@
  <!-- build tasks -->
  <target
    name="build"
-    depends="init build-dll"
+    depends="init"
    description="Builds the binaries for the current configuration">
    <echo message="Build Directory is ${bin_dir}/" />
    <mkdir
--- a/libsecondlife-cs/examples/examples.build
+++ b/libsecondlife-cs/examples/examples.build
@@ -44,9 +44,13 @@
  <!-- build tasks -->
  <target name="example" description="Build a particular example">
    <property name="example_name" value="${path::get-file-name(example_path)}" />
+	<property name="example_buildfile" value="${example_path}/${example_name}.build" />
    <echo message="building ${example_name}" />
-    <csc target="exe" debug="${build.debug}" output="${bin_dir}/${example_name}.exe">
-      <sources failonempty="true"><include name="${example_path}/*.cs"/></sources>
+	<nant buildfile="${example_buildfile}" if="${file::exists(example_buildfile)}" />
+	  <csc target="exe" debug="${build.debug}" output="${bin_dir}/${example_name}.exe" unless="${file::exists(example_buildfile)}">
+		  <sources failonempty="true">
+			  <include name="${example_path}/**/*.cs"/>
+		  </sources>
      <references basedir="${bin_dir}/"> 
         <include name="libjaspernet.dll"/>
         <include name="libsecondlife.dll"/>