Adding C# style XML documentation. It turns out Doxygen handles that properly

too.  Wow, Doxygen, it really does it all :-P

1 files changed, 42 insertions, 0 deletions

diff --git a/cs-dotnet/src/gatsobject.cs b/cs-dotnet/src/gatsobject.cs
index 7c92cff..57da747 100644
--- a/cs-dotnet/src/gatsobject.cs
+++ b/cs-dotnet/src/gatsobject.cs
@@ -9,11 +9,53 @@ using System.IO;
 
 namespace Com.Xagasoft.Gats
 {
+    /// <summary>
+    /// The base class of all GATS Data Type classes.
+    /// </summary>
+    /// <remarks>
+    /// This provides the standard Read and Write methods that are used to do
+    /// all type serialization, as well as a handy static Read function that
+    /// can be used
+    /// to read in any type.  These methods should not be used in normal
+    /// programming, instead use the GatsStream class to read and write
+    /// complete GATS packets.
+    /// </remarks>
     public abstract class GatsObject
     {
+        /// <summary>
+        /// Read a single object from the provided stream.
+        /// </summary>
+        /// <remarks>
+        /// This method does not read the leading type character.  The static
+        /// Read method in GatsObject does this, and passes the type into the
+        /// Read method as a parameter in case it's needed by a specific type,
+        /// such as GatsBoolean.
+        /// </remarks>
+        /// <param name="s">The Stream derived class to read from.</param>
+        /// <param name="type">The already read type specifier.</param>
         public abstract void Read( Stream s, char type );
+
+        /// <summary>
+        /// Write a single object to the provided stream.
+        /// </summary>
+        /// <remarks>
+        /// Unlike the Read method, this does actually write the leading type
+        /// specifier.
+        /// </remarks>
+        /// <param name="s">The Stream derived class to write to.</param>
         public abstract void Write( Stream s );
 
+        /// <summary>
+        /// Reads a GatsObject from the provided stream and returns it.
+        /// </summary>
+        /// <remarks>
+        /// This method reads the initial type specifier byte, constructs the
+        /// proper object, calls the Read method on that object, and returns
+        /// the result.
+        /// </remarks>
+        /// <returns>
+        /// The constructed object, or null if an end type was found.
+        /// </returns>
         public static GatsObject Read( Stream s )
         {
             int b = s.ReadByte();