WinGui:

Added some additional comments

git-svn-id: svn://svn.handbrake.fr/HandBrake/trunk@709 b64f7644-9d1e-0410-96f1-a4d463321fa5

1 files changed, 14 insertions, 1 deletions

diff --git a/win/C#/Parsing/Parser.cs b/win/C#/Parsing/Parser.cs
index 7cda4178c..7b8b8ba68 100644
--- a/win/C#/Parsing/Parser.cs
+++ b/win/C#/Parsing/Parser.cs
@@ -5,16 +5,22 @@ using System.IO;
 

 namespace Handbrake.Parsing

 {

+    /// <summary>

+    /// A delegate to handle custom events regarding data being parsed from the buffer

+    /// </summary>

+    /// <param name="Sender">The object which raised this delegate</param>

+    /// <param name="Data">The data parsed from the stream</param>

     public delegate void DataReadEventHandler(object Sender, string Data);

+

     /// <summary>

     /// A simple wrapper around a StreamReader to keep track of the entire output from a cli process

     /// </summary>

     internal class Parser : StreamReader

     {

+        private string m_buffer;

         /// <summary>

         /// The output from the CLI process

         /// </summary>

-        private string m_buffer;

         public string Buffer

         {

             get

@@ -23,7 +29,14 @@ namespace Handbrake.Parsing
             }

         }

 

+        /// <summary>

+        /// Raised upon a new line being read from stdout/stderr

+        /// </summary>

         public static event DataReadEventHandler OnReadLine;

+

+        /// <summary>

+        /// Raised upon the entire stdout/stderr stream being read in a single call

+        /// </summary>

         public static event DataReadEventHandler OnReadToEnd;

 

         public Parser(Stream baseStream) : base(baseStream)