Interop: Add in a bunch of missing comments.

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

9 files changed, 121 insertions, 25 deletions

diff --git a/win/CS/HandBrake.Interop/HandBrakeInterop/Converters.cs b/win/CS/HandBrake.Interop/HandBrakeInterop/Converters.cs
index 868a8b720..b0e81fcd3 100644
--- a/win/CS/HandBrake.Interop/HandBrakeInterop/Converters.cs
+++ b/win/CS/HandBrake.Interop/HandBrakeInterop/Converters.cs
@@ -18,7 +18,10 @@ namespace HandBrake.Interop
 

 	public static class Converters

 	{

-		private static Dictionary<double, int> vrates = new Dictionary<double, int>

+	    /// <summary>

+	    /// Video Frame Rates

+	    /// </summary>

+	    private static Dictionary<double, int> vrates = new Dictionary<double, int>

 		{

 			{5, 5400000},

 			{10, 2700000},

@@ -30,7 +33,19 @@ namespace HandBrake.Interop
 			{29.97, 900900}

 		};

 

-		public static int FramerateToVrate(double framerate)

+	    /// <summary>

+        /// Convert Framerate to Video Rates

+	    /// </summary>

+	    /// <param name="framerate">

+	    /// The framerate.

+	    /// </param>

+	    /// <returns>

+	    /// The vrate if a valid framerate is passed in.

+	    /// </returns>

+	    /// <exception cref="ArgumentException">

+	    /// Thrown when framerate is invalid.

+	    /// </exception>

+	    public static int FramerateToVrate(double framerate)

 		{

 			if (!vrates.ContainsKey(framerate))

 			{

@@ -40,7 +55,19 @@ namespace HandBrake.Interop
 			return vrates[framerate];

 		}

 

-		public static int MixdownToNative(Mixdown mixdown)

+	    /// <summary>

+	    /// Convert a Mixdown object to HandBrakes native mixdown constant.

+	    /// </summary>

+	    /// <param name="mixdown">

+	    /// The mixdown.

+	    /// </param>

+	    /// <returns>

+	    /// NativeContstant that represents the mixdown.

+	    /// </returns>

+	    /// <exception cref="ArgumentException">

+	    /// Thrown for an invalid mixodown.

+	    /// </exception>

+	    public static int MixdownToNative(Mixdown mixdown)

 		{

 			if (mixdown == Mixdown.Auto)

 			{

@@ -64,7 +91,19 @@ namespace HandBrake.Interop
 			return 0;

 		}

 

-		public static Mixdown NativeToMixdown(int mixdown)

+	    /// <summary>

+	    /// Convert an native internal handbrake mixdown to a local mixdown enum.

+	    /// </summary>

+	    /// <param name="mixdown">

+	    /// The mixdown.

+	    /// </param>

+	    /// <returns>

+	    /// A mixdown object.

+	    /// </returns>

+	    /// <exception cref="ArgumentException">

+	    /// thrown when mixdown is invalid.

+	    /// </exception>

+	    public static Mixdown NativeToMixdown(int mixdown)

 		{

 			switch (mixdown)

 			{

@@ -117,7 +156,16 @@ namespace HandBrake.Interop
 			return 0;

 		}

 

-		public static AudioCodec NativeToAudioCodec(uint codec)

+	    /// <summary>

+	    /// Convert Native HB Internal Audio int to a AudioCodec model.

+	    /// </summary>

+	    /// <param name="codec">

+	    /// The codec.

+	    /// </param>

+	    /// <returns>

+	    /// An AudioCodec object.

+	    /// </returns>

+	    public static AudioCodec NativeToAudioCodec(uint codec)

 		{

 			switch (codec)

 			{

diff --git a/win/CS/HandBrake.Interop/HandBrakeInterop/EncodeCompletedEventArgs.cs b/win/CS/HandBrake.Interop/HandBrakeInterop/EncodeCompletedEventArgs.cs
index 17e196e59..aa71b3a14 100644
--- a/win/CS/HandBrake.Interop/HandBrakeInterop/EncodeCompletedEventArgs.cs
+++ b/win/CS/HandBrake.Interop/HandBrakeInterop/EncodeCompletedEventArgs.cs
@@ -11,8 +11,14 @@ namespace HandBrake.Interop
 {

 	using System;

 

-	public class EncodeCompletedEventArgs : EventArgs

+    /// <summary>

+    /// Encode Completed Event Args

+    /// </summary>

+    public class EncodeCompletedEventArgs : EventArgs

 	{

-		public bool Error { get; set; }

+	    /// <summary>

+	    /// Gets or sets a value indicating whether Error.

+	    /// </summary>

+	    public bool Error { get; set; }

 	}

 }

diff --git a/win/CS/HandBrake.Interop/HandBrakeInterop/EncodeProgressEventArgs.cs b/win/CS/HandBrake.Interop/HandBrakeInterop/EncodeProgressEventArgs.cs
index 3a7429057..73802fafd 100644
--- a/win/CS/HandBrake.Interop/HandBrakeInterop/EncodeProgressEventArgs.cs
+++ b/win/CS/HandBrake.Interop/HandBrakeInterop/EncodeProgressEventArgs.cs
@@ -11,12 +11,30 @@ namespace HandBrake.Interop
 {

 	using System;

 

-	public class EncodeProgressEventArgs : EventArgs

+    /// <summary>

+    /// Encode Progress Event Args

+    /// </summary>

+    public class EncodeProgressEventArgs : EventArgs

 	{

-		public float FractionComplete { get; set; }

-		public float CurrentFrameRate { get; set; }

-		public float AverageFrameRate { get; set; }

-		public TimeSpan EstimatedTimeLeft { get; set; }

+	    /// <summary>

+	    /// Gets or sets FractionComplete.

+	    /// </summary>

+	    public float FractionComplete { get; set; }

+

+	    /// <summary>

+	    /// Gets or sets CurrentFrameRate.

+	    /// </summary>

+	    public float CurrentFrameRate { get; set; }

+

+	    /// <summary>

+	    /// Gets or sets AverageFrameRate.

+	    /// </summary>

+	    public float AverageFrameRate { get; set; }

+

+	    /// <summary>

+	    /// Gets or sets EstimatedTimeLeft.

+	    /// </summary>

+	    public TimeSpan EstimatedTimeLeft { get; set; }

 

 		/// <summary>

 		/// Gets or sets the current encoding pass. (-1: subtitle scan, 1: first pass, 2: second pass)

diff --git a/win/CS/HandBrake.Interop/HandBrakeInterop/HandBrakeInstance.cs b/win/CS/HandBrake.Interop/HandBrakeInterop/HandBrakeInstance.cs
index 12172993f..c7818cd7e 100644
--- a/win/CS/HandBrake.Interop/HandBrakeInterop/HandBrakeInstance.cs
+++ b/win/CS/HandBrake.Interop/HandBrakeInterop/HandBrakeInstance.cs
@@ -32,11 +32,6 @@ namespace HandBrake.Interop
 		private const int PictureAutoSizeModulus = 2;

 

 		/// <summary>

-		/// Modulus used for picture size when using non-anamorphic.

-		/// </summary>

-		private const int NonAnamorphicAutoSizeModulus = 16;

-

-		/// <summary>

 		/// The number of MS between status polls when scanning.

 		/// </summary>

 		private const double ScanPollIntervalMs = 200;

diff --git a/win/CS/HandBrake.Interop/HandBrakeInterop/HandBrakeUtils.cs b/win/CS/HandBrake.Interop/HandBrakeInterop/HandBrakeUtils.cs
index 047a69535..b90387703 100644
--- a/win/CS/HandBrake.Interop/HandBrakeInterop/HandBrakeUtils.cs
+++ b/win/CS/HandBrake.Interop/HandBrakeInterop/HandBrakeUtils.cs
@@ -17,7 +17,10 @@ namespace HandBrake.Interop
 	using HandBrake.Interop.Model.Encoding;

 	using HandBrake.Interop.SourceData;

 

-	public static class HandBrakeUtils

+    /// <summary>

+    /// HandBrake Interop Utilities

+    /// </summary>

+    public static class HandBrakeUtils

 	{

 		/// <summary>

 		/// Estimated overhead in bytes for each frame in output container.

@@ -44,7 +47,10 @@ namespace HandBrake.Interop
 		/// </summary>

 		public static event EventHandler<MessageLoggedEventArgs> ErrorLogged;

 

-		public static void RegisterLogger()

+	    /// <summary>

+	    /// Register the logger.

+	    /// </summary>

+	    public static void RegisterLogger()

 		{

 			// Register the logger if we have not already

 			if (loggingCallback == null)

diff --git a/win/CS/HandBrake.Interop/HandBrakeInterop/MarshalingConstants.cs b/win/CS/HandBrake.Interop/HandBrakeInterop/MarshalingConstants.cs
index 2818844de..66dc737fb 100644
--- a/win/CS/HandBrake.Interop/HandBrakeInterop/MarshalingConstants.cs
+++ b/win/CS/HandBrake.Interop/HandBrakeInterop/MarshalingConstants.cs
@@ -15,8 +15,15 @@ namespace HandBrake.Interop
 		public const int JobPaddingBytes = 24688;

 		public const int AudioPaddingBytes = 24632;

 #else

-		public const int JobPaddingBytes = 24640;

-		public const int AudioPaddingBytes = 24604;

+	    /// <summary>

+	    /// Job Padding Bytes

+	    /// </summary>

+	    public const int JobPaddingBytes = 24640;

+

+	    /// <summary>

+	    /// Audio Padding Bytes

+	    /// </summary>

+	    public const int AudioPaddingBytes = 24604;

 #endif

 	}

 }

diff --git a/win/CS/HandBrake.Interop/HandBrakeInterop/MessageLoggedEventArgs.cs b/win/CS/HandBrake.Interop/HandBrakeInterop/MessageLoggedEventArgs.cs
index 8850daff5..fd33c9ef3 100644
--- a/win/CS/HandBrake.Interop/HandBrakeInterop/MessageLoggedEventArgs.cs
+++ b/win/CS/HandBrake.Interop/HandBrakeInterop/MessageLoggedEventArgs.cs
@@ -11,8 +11,14 @@ namespace HandBrake.Interop
 {

 	using System;

 

+	/// <summary>

+	/// The Message Logged Event Args

+	/// </summary>

 	public class MessageLoggedEventArgs : EventArgs

 	{

+		/// <summary>

+		/// Gets or sets Message.

+		/// </summary>

 		public string Message { get; set; }

 	}

 }

diff --git a/win/CS/HandBrake.Interop/HandBrakeInterop/NativeList.cs b/win/CS/HandBrake.Interop/HandBrakeInterop/NativeList.cs
index 1b01a87db..adc74c456 100644
--- a/win/CS/HandBrake.Interop/HandBrakeInterop/NativeList.cs
+++ b/win/CS/HandBrake.Interop/HandBrakeInterop/NativeList.cs
@@ -12,7 +12,7 @@ namespace HandBrake.Interop
 	using System;

 	using System.Collections.Generic;

 

-    /// <summary>

+	/// <summary>

 	/// Represents a HandBrake style native list.

 	/// </summary>

 	public class NativeList

diff --git a/win/CS/HandBrake.Interop/HandBrakeInterop/ScanProgressEventArgs.cs b/win/CS/HandBrake.Interop/HandBrakeInterop/ScanProgressEventArgs.cs
index 2b96f8468..ce20a4f9d 100644
--- a/win/CS/HandBrake.Interop/HandBrakeInterop/ScanProgressEventArgs.cs
+++ b/win/CS/HandBrake.Interop/HandBrakeInterop/ScanProgressEventArgs.cs
@@ -11,9 +11,19 @@ namespace HandBrake.Interop
 {

 	using System;

 

-	public class ScanProgressEventArgs : EventArgs

+    /// <summary>

+    /// The Scan Progress Event Args

+    /// </summary>

+    public class ScanProgressEventArgs : EventArgs

 	{

-		public int CurrentTitle { get; set; }

-		public int Titles { get; set; }

+	    /// <summary>

+	    /// Gets or sets CurrentTitle.

+	    /// </summary>

+	    public int CurrentTitle { get; set; }

+

+	    /// <summary>

+	    /// Gets or sets Titles.

+	    /// </summary>

+	    public int Titles { get; set; }

 	}

 }