OSDN Git Service

WinGui:
authorbrianmario <brianmario@b64f7644-9d1e-0410-96f1-a4d463321fa5>
Wed, 18 Jul 2007 08:34:25 +0000 (08:34 +0000)
committerbrianmario <brianmario@b64f7644-9d1e-0410-96f1-a4d463321fa5>
Wed, 18 Jul 2007 08:34:25 +0000 (08:34 +0000)
Added some additional comments

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

win/C#/Parsing/Parser.cs

index 7cda417..7b8b8ba 100644 (file)
@@ -5,16 +5,22 @@ using System.IO;
 \r
 namespace Handbrake.Parsing\r
 {\r
+    /// <summary>\r
+    /// A delegate to handle custom events regarding data being parsed from the buffer\r
+    /// </summary>\r
+    /// <param name="Sender">The object which raised this delegate</param>\r
+    /// <param name="Data">The data parsed from the stream</param>\r
     public delegate void DataReadEventHandler(object Sender, string Data);\r
+\r
     /// <summary>\r
     /// A simple wrapper around a StreamReader to keep track of the entire output from a cli process\r
     /// </summary>\r
     internal class Parser : StreamReader\r
     {\r
+        private string m_buffer;\r
         /// <summary>\r
         /// The output from the CLI process\r
         /// </summary>\r
-        private string m_buffer;\r
         public string Buffer\r
         {\r
             get\r
@@ -23,7 +29,14 @@ namespace Handbrake.Parsing
             }\r
         }\r
 \r
+        /// <summary>\r
+        /// Raised upon a new line being read from stdout/stderr\r
+        /// </summary>\r
         public static event DataReadEventHandler OnReadLine;\r
+\r
+        /// <summary>\r
+        /// Raised upon the entire stdout/stderr stream being read in a single call\r
+        /// </summary>\r
         public static event DataReadEventHandler OnReadToEnd;\r
 \r
         public Parser(Stream baseStream) : base(baseStream)\r