Merge pull request #29 from akmadian/develop

v2.0.0 Release

.gitignore

@@ -334,6 +334,21 @@ ASALocalRun/
 .localhistory/
 
 TestApp/
+TestApp2/
 NZXTSharpTesterApp/
 Scripts/
-.vscode/
+NZXTSharp.Profiles/
+.vscode/
+
+
+# DocFX Files
+NZXTSharp/_site/
+NZXTSharp/api/
+NZXTSharp/apidoc/
+NZXTSharp/articles/
+NZXTSharp/images/
+NZXTSharp/src
+NZXTSharp/docfx.json
+NZXTSharp/index.md
+NZXTSharp/log.txt
+NZXTSharp/toc.yml

NZXTSharp.sln

@@ -7,6 +7,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "NZXTSharp", "NZXTSharp\NZXT
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestApp", "TestApp\TestApp.csproj", "{CDEB958B-5717-4232-BE56-3A0F8A74DC66}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestApp2", "TestApp2\TestApp2.csproj", "{D2D5F159-C835-4D6C-A052-1C1E4016ED14}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -21,6 +23,10 @@ Global
 		{CDEB958B-5717-4232-BE56-3A0F8A74DC66}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{CDEB958B-5717-4232-BE56-3A0F8A74DC66}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{CDEB958B-5717-4232-BE56-3A0F8A74DC66}.Release|Any CPU.Build.0 = Release|Any CPU
+		{D2D5F159-C835-4D6C-A052-1C1E4016ED14}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{D2D5F159-C835-4D6C-A052-1C1E4016ED14}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{D2D5F159-C835-4D6C-A052-1C1E4016ED14}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{D2D5F159-C835-4D6C-A052-1C1E4016ED14}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

NZXTSharp/.gitignore

@@ -0,0 +1,9 @@
+###############
+#    folder   #
+###############
+/**/DROP/
+/**/TEMP/
+/**/packages/
+/**/bin/
+/**/obj/
+_site

NZXTSharp/COM/ICOMController.cs

@@ -3,6 +3,10 @@
 using System.Text;
 
 namespace NZXTSharp.COM {
-    interface ICOMController {
+
+    /// <summary>
+    /// Represents an HID or serial communication controller.
+    /// </summary>
+    public interface ICOMController {
     }
 }

NZXTSharp/COM/Serial/SerialCOMData.cs

@@ -9,7 +9,7 @@ namespace NZXTSharp.COM {
     /// <summary>
     /// Contains information needed to open a COM port.
     /// </summary>
-    internal class SerialCOMData {
+    public class SerialCOMData {
 
         #region Properties and Fields
         private readonly Parity _Parity;
@@ -78,6 +78,10 @@ internal class SerialCOMData {
             this._Name = Name;
         }
 
+        /// <summary>
+        /// Generates a string with information about the <see cref="SerialCOMData"/> instance.
+        /// </summary>
+        /// <returns>A string with information about the <see cref="SerialCOMData"/> instance.</returns>
         public override string ToString()
         {
             return String.Format("Parity: {0}, StopBits: {1}, WriteTimeout: {2}, ReadTimeout: {3}, Baud: {4}, DataBits: {5}, Name: {6}",

NZXTSharp/COM/Serial/SerialController.cs

@@ -11,7 +11,7 @@ namespace NZXTSharp.COM {
     /// <summary>
     /// Represents a <see cref="SerialPort"/> with some useful methods.
     /// </summary>
-    internal class SerialController : ICOMController {
+    public class SerialController : ICOMController {
 
         #region Properties and Fields
         private SerialPort _Port;

NZXTSharp/COM/USB/DeviceEnumerator.cs

@@ -10,29 +10,31 @@ namespace NZXTSharp.COM
     /// <summary>
     /// Copied from https://github.com/DarkMio/Octopode with modifications.
     /// </summary>
-    class DeviceEnumerator
+    public class DeviceEnumerator
     {
+        /// <summary>
+        /// Enumerates all HID devices connected to the system.
+        /// </summary>
+        /// <returns>An <see cref="IEnumerable{T}"/> containing all found <see cref="HidDevice"/>s.</returns>
         public static IEnumerable<HidDevice> EnumAllDevices()
         {
             return HidDevices.Enumerate();
         }
 
+        /// <summary>
+        /// Enumerates all NZXT devices connected to the system.
+        /// </summary>
+        /// <returns>An <see cref="IEnumerable{T}"/> containing all found NZXT <see cref="HidDevice"/>s.</returns>
         public static IEnumerable<HidDevice> EnumNZXTDevices()
         {
             return HidDevices.Enumerate(0x1E71);
         }
 
-        public static IEnumerable<HidDevice> EnumKrakenMDevices()
-        {
-            foreach (var device in EnumNZXTDevices())
-            {
-                if (device.Attributes.ProductId == (int)HIDDeviceID.KrakenM)
-                {
-                    yield return device;
-                }
-            }
-        }
-
+        /// <summary>
+        /// Enumerates all <see cref="KrakenX.KrakenX"/> devices connected to the system.
+        /// </summary>
+        /// <returns>An <see cref="IEnumerable{T}"/> containing all found
+        /// <see cref="KrakenX.KrakenX"/> <see cref="HidDevice"/>s.</returns>
         public static IEnumerable<HidDevice> EnumKrakenXDevices()
         {
             foreach (var device in EnumNZXTDevices())

NZXTSharp/COM/USB/USBController.cs

@@ -14,7 +14,7 @@
 using NZXTSharp.Exceptions;
 
 namespace NZXTSharp.COM {
-    internal class USBController
+    public class USBController
     { 
 
         private NZXTDeviceType _Type;

NZXTSharp/Core/Color.cs

@@ -85,7 +85,7 @@ public Color(int R, int G, int B)
         /// Returns a list of 40 "#ffffff" color codes in G, R, B format.
         /// </summary>
         /// <returns></returns>
-        public byte[] AllOff()
+        public static byte[] AllOff()
         {
             List<int> outBytes = new List<int>();
             for (int i = 0; i < 40; i++)

NZXTSharp/Core/Common/Effects/Marquee.cs

@@ -74,14 +74,14 @@ public bool IsCompatibleWith(NZXTDeviceType Type)
                 case NZXTDeviceType.HuePlus:
                     List<byte[]> outList = new List<byte[]>();
                     byte[] SettingsBytes = new byte[] { 0x4b, (byte)Channel.ChannelByte, 0x03, Param1, Param2 };
-                    byte[] final = SettingsBytes.ConcatenateByteArr(Channel.State == false ? new Color().AllOff() : Channel.BuildColorBytes(_Color));
+                    byte[] final = SettingsBytes.ConcatenateByteArr(Channel.State == false ? Color.AllOff() : Channel.BuildColorBytes(_Color));
                     outList.Add(final);
 
                     return outList;
                 case NZXTDeviceType.KrakenX:
                     List<byte[]> KrakenXOutList = new List<byte[]>();
                     byte[] KrakenXSettingsBytes = new byte[] { 0x02, 0x4c, 0x02, 0x03, Param2 };
-                    byte[] KrakenXfinal = KrakenXSettingsBytes.ConcatenateByteArr(Channel.State == false ? new Color().AllOff() : Channel.BuildColorBytes(_Color));
+                    byte[] KrakenXfinal = KrakenXSettingsBytes.ConcatenateByteArr(Channel.State == false ? Color.AllOff() : Channel.BuildColorBytes(_Color));
                     KrakenXOutList.Add(KrakenXfinal);
                     return KrakenXOutList;
                 default:

NZXTSharp/Core/Common/Params/CISS.cs

@@ -10,7 +10,7 @@ namespace NZXTSharp
     /// <summary>
     /// Represents a CISS effect param.
     /// </summary>
-    internal class CISS : IParam {
+    public class CISS : IParam {
         private readonly int colorIndex;
         private int speed;
         private int evaluatedIndex;

NZXTSharp/Core/Exceptions/IncompatibleDeviceTypeException.cs

@@ -4,22 +4,34 @@
 
 namespace NZXTSharp.Exceptions
 {
-    internal class IncompatibleDeviceTypeException : Exception
+    /// <summary>
+    /// Thrown when an <see cref="NZXTDeviceType"/> is passed to a method
+    /// or constructor that is not compatible with that method or constructor.
+    /// </summary>
+    public class IncompatibleDeviceTypeException : Exception
     {
-
+        /// <summary>
+        /// 
+        /// </summary>
         public IncompatibleDeviceTypeException()
             : base("Invalid NZXTDeviceType given to USBController.")
         {
 
         }
 
+        /// <summary>
+        /// Constructs an <see cref="IncompatibleDeviceTypeException"/> with a custom message.
+        /// </summary>
+        /// <param name="message">A custom message.</param>
         public IncompatibleDeviceTypeException(string message)
             : base(message)
         {
 
         }
 
-        public IncompatibleDeviceTypeException(string message, Exception innerException) : base(message, innerException)
+        /// <inheritdoc/>
+        public IncompatibleDeviceTypeException(string message, Exception innerException) 
+            : base(message, innerException)
         {
         }
     }

NZXTSharp/Core/Exceptions/IncompatibleEffectException.cs

@@ -3,26 +3,40 @@
 using System.Text;
 
 namespace NZXTSharp.Exceptions {
-    internal class IncompatibleEffectException : Exception {
+
+    /// <summary>
+    /// Thrown when an effect passed to <see cref="INZXTDevice.ApplyEffect(IEffect)"/> 
+    /// is not compatible with that <see cref="INZXTDevice"/>.
+    /// </summary>
+    public class IncompatibleEffectException : Exception {
 
         private static string baseString = "NXZTSharp.Exceptions.IncompatibleEffectException; ";
 
+        /// <inheritdoc/>
         public IncompatibleEffectException() 
             : base(baseString + "Invalid Effect Supplied To ApplyEffect()") {
 
         }
 
+        /// <inheritdoc/>
         public IncompatibleEffectException(string message)
             : base(message) {
 
         }
 
+        /// <summary>
+        /// Constructs an <see cref="IncompatibleEffectException"/> with more information
+        /// about the <see cref="INZXTDevice"/> and <see cref="IEffect"/>.
+        /// </summary>
+        /// <param name="DeviceName"></param>
+        /// <param name="EffectName"></param>
         public IncompatibleEffectException(string DeviceName, string EffectName) 
             : base(string.Format(baseString + "Invalid Effect \"{0}\" Supplied To ApplyEffect() Of Device \"{1}\"",
                 EffectName, DeviceName)){
 
         }
 
+        /// <inheritdoc/>
         public IncompatibleEffectException(string message, Exception innerException) 
             : base(message, innerException)
         {

NZXTSharp/Core/Exceptions/IncompatibleParamException.cs

@@ -2,17 +2,29 @@
 using System.Collections.Generic;
 using System.Text;
 
-namespace NZXTSharp.Exceptions {
-    internal class IncompatibleParamException : Exception {
-        public IncompatibleParamException() {
+namespace NZXTSharp.Exceptions
+{
+    /// <summary>
+    /// Thrown when a param object passed to an <see cref="IEffect"/> 
+    /// constructor is not compatible with that <see cref="IEffect"/>.
+    /// </summary>
+    public class IncompatibleParamException : Exception
+    {
+
+        /// <inheritdoc/>
+        public IncompatibleParamException()
+        {
 
         }
 
+        /// <inheritdoc/>
         public IncompatibleParamException(string message)
-            : base(message) {
+            : base(message)
+        {
 
         }
 
+        /// <inheritdoc/>
         public IncompatibleParamException(string message, Exception innerException) 
             : base(message, innerException)
         {

NZXTSharp/Core/Exceptions/InvalidEffectSpeedException.cs

@@ -2,17 +2,36 @@
 using System.Collections.Generic;
 using System.Text;
 
-namespace NZXTSharp.Exceptions {
-    internal class InvalidEffectSpeedException : Exception {
+namespace NZXTSharp.Exceptions
+{
+    /// <summary>
+    ///Thrown when an invalid speed value is passed to an
+    /// <see cref="IParam"/> or <see cref="IEffect"/> constructor.
+    /// 
+    /// Speed values must be 0 - 4 (inclusive); 
+    /// 0 being slowest, 2 being normal, and 4 being fastest.
+    /// </summary>
+    public class InvalidEffectSpeedException : Exception
+    {
 
+        /// <inheritdoc/>
         public InvalidEffectSpeedException() 
-            : base ("NZXTSharp.Exceptions.InvalidEffectSpeedException; Effect Speed Must Be Between 0 and 4 (Inclusive).") {
+            : base ("NZXTSharp.Exceptions.InvalidEffectSpeedException; Effect Speed Must Be Between 0 and 4 (Inclusive).")
+        {
 
         }
 
+        /// <inheritdoc/>
         public InvalidEffectSpeedException(string message)
-            : base(message) {
+            : base(message)
+        {
 
         }
+
+        /// <inheritdoc/>
+        public InvalidEffectSpeedException(string message, Exception innerException) 
+            : base(message, innerException)
+        {
+        }
     }
 }