More XML Documentation and Cleanup

Author: HerpDerpinstine

Properties/GlobalSuppressions.cs

@@ -3,4 +3,4 @@
 [assembly: SuppressMessage("Style", "IDE1006:Naming Styles", Scope = "type", Target = "~T:bHapticsLib.bHapticsConnection")]
 [assembly: SuppressMessage("Style", "IDE1006:Naming Styles", Scope = "type", Target = "~T:bHapticsLib.bHapticsException")]
 [assembly: SuppressMessage("Style", "IDE1006:Naming Styles", Scope = "type", Target = "~T:bHapticsLib.bHapticsManager")]
-[assembly: SuppressMessage("Style", "IDE1006:Naming Styles", Scope = "type", Target = "~T:bHapticsLib.bHapticsStatus")]
+[assembly: SuppressMessage("Style", "IDE1006:Naming Styles", Scope = "type", Target = "~T:bHapticsLib.bHapticsStatus")]

bHapticsLib/DotPoint.cs

@@ -13,7 +13,7 @@ public DotPoint(int index = 0, int intensity = 50)
             Intensity = intensity;
         }
 
-        /// <value>Index of Haptic Node</value>
+        /// <value>Index of Haptic Motor</value>
         public int Index
         {
             get => node["index"].AsInt;

bHapticsLib/HapticPattern.cs

@@ -3,8 +3,10 @@
     /// <summary>Haptic Pattern Utility</summary>
     public class HapticPattern
     {
+        /// <value>Pattern key id</value>
         public string Key { get; private set; }
 
+
         public static HapticPattern LoadFromFile(string key, string tactFilePath)
         {
             bHapticsManager.RegisterPatternFromFile(key, tactFilePath);

bHapticsLib/bHapticsException.cs

@@ -5,8 +5,8 @@ namespace bHapticsLib
     /// <summary>Exception Thrown from bHapticsLib</summary>
     public class bHapticsException : Exception
     {
-        public bHapticsException() { }
-        public bHapticsException(string message) : base(message) { }
-        public bHapticsException(string message, Exception exception) : base(message, exception) { }
+        internal bHapticsException() { }
+        internal bHapticsException(string message) : base(message) { }
+        internal bHapticsException(string message, Exception exception) : base(message, exception) { }
     }
 }

bHapticsLib/bHapticsManager.cs

@@ -100,8 +100,12 @@ public static bool IsPlayingAny()
         #endregion
 
         #region StopPlaying
+        /// <summary>Stops the specified pattern</summary>
+        /// <param name="key">The key id of the pattern</param>
         public static void StopPlaying(string key) 
             => Connection.StopPlaying(key);
+
+        /// <summary>Stops the currently playing patterns</summary>
         public static void StopPlayingAll() 
             => Connection.StopPlayingAll();
         #endregion