1 files changed, 57 insertions, 0 deletions

diff --git a/cs-dotnet/src/gatsstream.cs b/cs-dotnet/src/gatsstream.cs
index e1bba91..742f0b4 100644
--- a/cs-dotnet/src/gatsstream.cs
+++ b/cs-dotnet/src/gatsstream.cs
@@ -11,6 +11,23 @@ using System;
 
 namespace Com.Xagasoft.Gats
 {
+    /// <summary>
+    /// Main I/O interface.  Use this to read and write GATS.
+    /// </summary>
+    /// <remarks>
+    /// GatsStream is not a traditional Stream class, it only can read and
+    /// write complete GATS packets.  A GATS packet consists of a version,
+    /// size, and a single encoded GATS object (which can be a container).
+    ///
+    /// This one class handles both reading and writing.  Writing is fairly
+    /// straight forward, but for volatile streams like network sockets you'll
+    /// probably want to wrap your stream with a buffer before handing it to
+    /// GatsStream.
+    ///
+    /// Reading handles it's own buffering, and will remember what has been
+    /// read between calls if it cannot get enough data at once to complete
+    /// a single packet.  See the ReadObject docs for more details.
+    /// </remarks>
     public class GatsStream
     {
         private Stream s;
@@ -20,12 +37,37 @@ namespace Com.Xagasoft.Gats
         private BinaryWriter bw = null;
         private BinaryReader br = null;
 
+        /// <summary>
+        /// Construct a new GatsStream around a given Stream class.
+        /// </summary>
+        /// <remarks>
+        /// The provided Stream does not need to be opened for both reading and
+        /// writing, you can construct a GatsStream around a read only or
+        /// write only stream.
+        /// </remarks>
+        /// <param name="s">Stream to operate on.</param>
         public GatsStream( Stream s )
         {
             this.s = s;
             this.ReadBuf = new MemoryStream();
         }
 
+        /// <summary>
+        /// Read a GATS packet and return the contained GatsObject.
+        /// </summary>
+        /// <remarks>
+        /// This reads a complete packet into an internal buffer, parses the
+        /// gats object within it, and returns it.  This method will read as
+        /// much data as it needs from the stream, but no more.  Not a single
+        /// extra byte will be read.
+        ///
+        /// In the event that an end of stream is encountered, or a partial
+        /// packet has been read but no more data can be read at the moment,
+        /// this method will maintain it's buffer but return null to the caller.
+        /// </remarks>
+        /// <returns>
+        /// The read object, or null if no object could be read yet.
+        /// </returns>
         public GatsObject ReadObject()
         {
             if( size == -1 )
@@ -70,6 +112,21 @@ namespace Com.Xagasoft.Gats
             return null;
         }
 
+        /// <summary>
+        /// Write a GatsObject to the stream in a proper GATS packet.
+        /// </summary>
+        /// <remarks>
+        /// The object passed in is first written to an internal buffer, and
+        /// then to the output in several write operations.  This means that
+        /// for many applications you will want to buffer the output.  In the
+        /// case of writing to files, it could be faster to buffer the output.
+        /// In the case of writing to a socket buffering could prevent sending
+        /// many small packets.
+        ///
+        /// No flushing is done by this method, it is left to the caller to
+        /// determine the proper time to flush their streams.
+        /// </remarks>
+        /// <param name="obj">The object to be written.</param>
         public void WriteObject( GatsObject obj )
         {
             MemoryStream ms = new MemoryStream();