docs: complete XML documentation for all projects with inheritdoc tags

Co-authored-by: andrew-welker <1765622+andrew-welker@users.noreply.github.com>

src/PepperDash.Essentials.Core/Touchpanels/CrestronTouchpanelPropertiesConfig.cs

@@ -2,24 +2,45 @@
 
 namespace PepperDash.Essentials.Core
 {
+    /// <summary>
+    /// Represents a CrestronTouchpanelPropertiesConfig
+    /// </summary>
     public class CrestronTouchpanelPropertiesConfig
     {
         [JsonProperty("control")]
+        /// <summary>
+        /// Gets or sets the ControlProperties
+        /// </summary>
         public EssentialsControlPropertiesConfig ControlProperties { get; set; }
 
         [JsonProperty("ipId", NullValueHandling = NullValueHandling.Ignore)]
+        /// <summary>
+        /// Gets or sets the IpId
+        /// </summary>
         public string IpId { get; set; }
 
         [JsonProperty("defaultRoomKey", NullValueHandling = NullValueHandling.Ignore)]
+        /// <summary>
+        /// Gets or sets the DefaultRoomKey
+        /// </summary>
         public string DefaultRoomKey { get; set; }
         
         [JsonProperty("roomListKey", NullValueHandling = NullValueHandling.Ignore)]
+        /// <summary>
+        /// Gets or sets the RoomListKey
+        /// </summary>
         public string RoomListKey { get; set; }
 
         [JsonProperty("sgdFile", NullValueHandling = NullValueHandling.Ignore)]
+        /// <summary>
+        /// Gets or sets the SgdFile
+        /// </summary>
         public string SgdFile { get; set; }
 
         [JsonProperty("projectName", NullValueHandling = NullValueHandling.Ignore)]
+        /// <summary>
+        /// Gets or sets the ProjectName
+        /// </summary>
         public string ProjectName { get; set; }
 
         [JsonProperty("showVolumeGauge", NullValueHandling = NullValueHandling.Ignore)]
@@ -35,9 +56,15 @@ namespace PepperDash.Essentials.Core
         public bool? ShowTime { get; set; }
 
         [JsonProperty("setup", NullValueHandling = NullValueHandling.Ignore)]
+        /// <summary>
+        /// Gets or sets the Setup
+        /// </summary>
         public UiSetupPropertiesConfig Setup { get; set; }
 
         [JsonProperty("headerStyle", NullValueHandling = NullValueHandling.Ignore)]
+        /// <summary>
+        /// Gets or sets the HeaderStyle
+        /// </summary>
         public string HeaderStyle { get; set; }
 
         [JsonProperty("includeInFusionRoomHealth", NullValueHandling = NullValueHandling.Ignore)]
@@ -81,7 +108,7 @@ namespace PepperDash.Essentials.Core
     }
 
     /// <summary>
-    /// 
+    /// Represents a UiSetupPropertiesConfig
     /// </summary>
     public class UiSetupPropertiesConfig
     {

src/PepperDash.Essentials.Core/Touchpanels/Interfaces.cs

@@ -7,6 +7,9 @@ using Crestron.SimplSharpPro.DeviceSupport;
 
 namespace PepperDash.Essentials.Core
 {
+    /// <summary>
+    /// Defines the contract for IHasBasicTriListWithSmartObject
+    /// </summary>
     public interface IHasBasicTriListWithSmartObject
     {
         BasicTriListWithSmartObject Panel { get; }

src/PepperDash.Essentials.Core/Touchpanels/Keyboards/HabaneroKeyboardController.cs

@@ -7,6 +7,9 @@ using Crestron.SimplSharpPro.DeviceSupport;
 
 namespace PepperDash.Essentials.Core.Touchpanels.Keyboards
 {
+    /// <summary>
+    /// Represents a HabaneroKeyboardController
+    /// </summary>
     public class HabaneroKeyboardController
     {
         /// <summary>
@@ -14,26 +17,47 @@ namespace PepperDash.Essentials.Core.Touchpanels.Keyboards
         /// </summary>
         public event EventHandler<KeyboardControllerPressEventArgs> KeyPress;
 
+        /// <summary>
+        /// Gets or sets the TriList
+        /// </summary>
         public BasicTriList TriList { get; private set; }
 
+        /// <summary>
+        /// Gets or sets the OutputFeedback
+        /// </summary>
         public StringFeedback OutputFeedback { get; private set; }
 
         public bool IsVisible { get; private set; }
 
         public string DotComButtonString { get; set; }
 
+        /// <summary>
+        /// Gets or sets the GoButtonText
+        /// </summary>
         public string GoButtonText { get; set; }
 
+        /// <summary>
+        /// Gets or sets the SecondaryButtonText
+        /// </summary>
         public string SecondaryButtonText { get; set; }
 
+        /// <summary>
+        /// Gets or sets the GoButtonVisible
+        /// </summary>
         public bool GoButtonVisible { get; set; }
 
+        /// <summary>
+        /// Gets or sets the SecondaryButtonVisible
+        /// </summary>
         public bool SecondaryButtonVisible { get; set; }
 
         int ShiftMode = 0;
         
         StringBuilder Output;
 
+        /// <summary>
+        /// Gets or sets the HideAction
+        /// </summary>
         public Action HideAction { get; set; }
 
 		CTimer BackspaceTimer;
@@ -51,7 +75,7 @@ namespace PepperDash.Essentials.Core.Touchpanels.Keyboards
         }
 
         /// <summary>
-        /// Shows the keyboard and attaches sig handlers in the range of 2901-2969
+        /// Show method
         /// </summary>
         public void Show()
         {
@@ -108,7 +132,7 @@ namespace PepperDash.Essentials.Core.Touchpanels.Keyboards
         }
 
         /// <summary>
-        /// Hides the keyboard and disconnects ALL sig handlers from 2901 - 2969
+        /// Hide method
         /// </summary>
         public void Hide()
         {
@@ -130,6 +154,9 @@ namespace PepperDash.Essentials.Core.Touchpanels.Keyboards
         /// 
         /// </summary>
         /// <param name="c"></param>
+        /// <summary>
+        /// Press method
+        /// </summary>
         public void Press(char c)
         {
             OnKeyPress(c.ToString());
@@ -142,6 +169,9 @@ namespace PepperDash.Essentials.Core.Touchpanels.Keyboards
         /// 
         /// </summary>
         /// <param name="s"></param>
+        /// <summary>
+        /// Press method
+        /// </summary>
         public void Press(string s)
         {
             OnKeyPress(s);
@@ -151,7 +181,7 @@ namespace PepperDash.Essentials.Core.Touchpanels.Keyboards
         }
 
         /// <summary>
-        /// 
+        /// EnableGoButton method
         /// </summary>
         public void EnableGoButton()
         {
@@ -416,6 +446,9 @@ namespace PepperDash.Essentials.Core.Touchpanels.Keyboards
     public class KeyboardControllerPressEventArgs : EventArgs
     {
         public string Text { get; private set; }
+        /// <summary>
+        /// Gets or sets the SpecialKey
+        /// </summary>
         public KeyboardSpecialKey SpecialKey { get; private set; }
 
         public KeyboardControllerPressEventArgs(string text)
@@ -429,6 +462,9 @@ namespace PepperDash.Essentials.Core.Touchpanels.Keyboards
         }
     }
 
+    /// <summary>
+    /// Enumeration of KeyboardSpecialKey values
+    /// </summary>
     public enum KeyboardSpecialKey
     {
         None = 0, Backspace, Clear, GoButton, SecondaryButton

src/PepperDash.Essentials.Core/Touchpanels/ModalDialog.cs

@@ -6,6 +6,9 @@ using Serilog.Events;
 
 namespace PepperDash.Essentials.Core
 {
+ /// <summary>
+ /// Represents a ModalDialog
+ /// </summary>
 	public class ModalDialog
 	{
 		/// <summary>
@@ -165,7 +168,7 @@ namespace PepperDash.Essentials.Core
 		}
 
         /// <summary>
-        /// Wakes the panel by turning on the backlight if off
+        /// WakePanel method
         /// </summary>
         public void WakePanel()
         {
@@ -182,9 +185,9 @@ namespace PepperDash.Essentials.Core
             }
         }
 
-        /// <summary>
-        /// Hide dialog from elsewhere, fires CompleteAction
-        /// </summary>
+  /// <summary>
+  /// CancelDialog method
+  /// </summary>
 		public void CancelDialog()
 		{
             OnModalComplete(0);

src/PepperDash.Essentials.Core/Touchpanels/Mpc3Touchpanel.cs

@@ -67,6 +67,9 @@ namespace PepperDash.Essentials.Core.Touchpanels
 		/// </summary>
 		/// <param name="key"></param>
 		/// <param name="config"></param>
+  /// <summary>
+  /// InitializeButton method
+  /// </summary>
 		public void InitializeButton(string key, KeypadButton config)
 		{
 			if (config == null)
@@ -151,6 +154,9 @@ namespace PepperDash.Essentials.Core.Touchpanels
 		/// </summary>
 		/// <param name="key"></param>
 		/// <param name="config"></param>
+  /// <summary>
+  /// InitializeButtonFeedback method
+  /// </summary>
 		public void InitializeButtonFeedback(string key, KeypadButton config)
 		{
 			//Debug.LogMessage(LogEventLevel.Debug, this, "Initializing button '{0}' feedback...", key);
@@ -305,6 +311,9 @@ namespace PepperDash.Essentials.Core.Touchpanels
 		/// </summary>
 		/// <param name="buttonKey"></param>
 		/// <param name="type"></param>
+  /// <summary>
+  /// Press method
+  /// </summary>
 		public void Press(string buttonKey, string type)
 		{
 			this.LogVerbose("Press: buttonKey-'{buttonKey}', type-'{type}'", buttonKey, type);
@@ -320,6 +329,9 @@ namespace PepperDash.Essentials.Core.Touchpanels
 		}
 
 
+  /// <summary>
+  /// ListButtons method
+  /// </summary>
 		public void ListButtons()
 		{
 			this.LogVerbose("MPC3 Controller {0} - Available Buttons", Key);
@@ -331,9 +343,9 @@ namespace PepperDash.Essentials.Core.Touchpanels
 		}
 	}
 
-	/// <summary>
-	/// Represents the configuration of a keypad button
-	/// </summary>
+ /// <summary>
+ /// Represents a KeypadButton
+ /// </summary>
 	public class KeypadButton
 	{
 		[JsonProperty("eventTypes")]
@@ -349,12 +361,15 @@ namespace PepperDash.Essentials.Core.Touchpanels
 		}
 	}
 
-	/// <summary>
-	/// Represents the configuration of a keypad button feedback
-	/// </summary>
+ /// <summary>
+ /// Represents a KeypadButtonFeedback
+ /// </summary>
 	public class KeypadButtonFeedback
 	{
 		[JsonProperty("deviceKey")]
+  /// <summary>
+  /// Gets or sets the DeviceKey
+  /// </summary>
 		public string DeviceKey { get; set; }
 
 		[JsonProperty("feedbackName")]

src/PepperDash.Essentials.Core/Touchpanels/TriListExtensions.cs

@@ -36,6 +36,9 @@ namespace PepperDash.Essentials.Core
 		/// <param name="sigNum"></param>
 		/// <param name="a"></param>
 		/// <returns></returns>
+  /// <summary>
+  /// SetBoolSigAction method
+  /// </summary>
 		public static BoolOutputSig SetBoolSigAction(this BasicTriList tl, uint sigNum, Action<bool> a)
 		{
 			return tl.BooleanOutput[sigNum].SetBoolSigAction(a);
@@ -50,6 +53,9 @@ namespace PepperDash.Essentials.Core
 		/// Attaches a void Action to a TriList's output sig's UserObject, to be run on release
 		/// </summary>
 		/// <returns>The sig</returns>
+  /// <summary>
+  /// SetSigFalseAction method
+  /// </summary>
 		public static BoolOutputSig SetSigFalseAction(this BasicTriList tl, uint sigNum, Action a)
 		{
 			return tl.BooleanOutput[sigNum].SetBoolSigAction(b => { if (!b) a(); });
@@ -118,6 +124,9 @@ namespace PepperDash.Essentials.Core
         /// Sets an action to a held sig as well as a released-without-hold action
         /// </summary>
         /// <returns>The sig</returns>
+        /// <summary>
+        /// SetSigHeldAction method
+        /// </summary>
         public static BoolOutputSig SetSigHeldAction(this BasicTriList tl, uint sigNum, uint heldMs, Action heldAction, Action releaseAction)
         {
 			return tl.BooleanOutput[sigNum].SetSigHeldAction(heldMs, heldAction, null, releaseAction);
@@ -139,6 +148,9 @@ namespace PepperDash.Essentials.Core
 		/// <param name="sig"></param>
 		/// <param name="a"></param>
 		/// <returns>The Sig</returns>
+  /// <summary>
+  /// SetUShortSigAction method
+  /// </summary>
 		public static UShortOutputSig SetUShortSigAction(this UShortOutputSig sig, Action<ushort> a)
 		{
 			sig.UserObject = a;
@@ -151,6 +163,9 @@ namespace PepperDash.Essentials.Core
 		/// <param name="sigNum"></param>
 		/// <param name="a"></param>
 		/// <returns></returns>
+  /// <summary>
+  /// SetUShortSigAction method
+  /// </summary>
 		public static UShortOutputSig SetUShortSigAction(this BasicTriList tl, uint sigNum, Action<ushort> a)
 		{
 			return tl.UShortOutput[sigNum].SetUShortSigAction(a);
@@ -162,6 +177,9 @@ namespace PepperDash.Essentials.Core
 		/// <param name="sig"></param>
 		/// <param name="a"></param>
 		/// <returns></returns>
+  /// <summary>
+  /// SetStringSigAction method
+  /// </summary>
 		public static StringOutputSig SetStringSigAction(this StringOutputSig sig, Action<string> a)
 		{
 			sig.UserObject = a;
@@ -175,6 +193,9 @@ namespace PepperDash.Essentials.Core
 		/// <param name="sigNum"></param>
 		/// <param name="a"></param>
 		/// <returns></returns>
+  /// <summary>
+  /// SetStringSigAction method
+  /// </summary>
 		public static StringOutputSig SetStringSigAction(this BasicTriList tl, uint sigNum, Action<string> a)
 		{
 			return tl.StringOutput[sigNum].SetStringSigAction(a);
@@ -185,6 +206,9 @@ namespace PepperDash.Essentials.Core
 		/// </summary>
 		/// <param name="sig"></param>
 		/// <returns></returns>
+  /// <summary>
+  /// ClearSigAction method
+  /// </summary>
 		public static Sig ClearSigAction(this Sig sig)
 		{
 			sig.UserObject = null;
@@ -196,18 +220,24 @@ namespace PepperDash.Essentials.Core
 			return ClearSigAction(tl.BooleanOutput[sigNum]) as BoolOutputSig;
 		}
 
+  /// <summary>
+  /// ClearUShortSigAction method
+  /// </summary>
 		public static UShortOutputSig ClearUShortSigAction(this BasicTriList tl, uint sigNum)
 		{
 			return ClearSigAction(tl.UShortOutput[sigNum]) as UShortOutputSig;
 		}
 
+  /// <summary>
+  /// ClearStringSigAction method
+  /// </summary>
 		public static StringOutputSig ClearStringSigAction(this BasicTriList tl, uint sigNum)
 		{
 			return ClearSigAction(tl.StringOutput[sigNum]) as StringOutputSig;
 		}
 
         /// <summary>
-        /// Clears all actions on all sigs
+        /// ClearAllSigActions method
         /// </summary>
         public static void ClearAllSigActions(this BasicTriList t1)
         {
@@ -228,7 +258,7 @@ namespace PepperDash.Essentials.Core
         }
 
         /// <summary>
-        /// Helper method to set the value of a bool Sig on TriList
+        /// SetBool method
         /// </summary>
         public static void SetBool(this BasicTriList tl, uint sigNum, bool value)
         {
@@ -240,6 +270,9 @@ namespace PepperDash.Essentials.Core
 		/// </summary>
 		/// <param name="tl"></param>
 		/// <param name="sigNum"></param>
+  /// <summary>
+  /// PulseBool method
+  /// </summary>
 		public static void PulseBool(this BasicTriList tl, uint sigNum)
 		{
 			tl.BooleanInput[sigNum].Pulse();
@@ -251,6 +284,9 @@ namespace PepperDash.Essentials.Core
 		/// <param name="tl"></param>
 		/// <param name="sigNum"></param>
 		/// <param name="ms"></param>
+  /// <summary>
+  /// PulseBool method
+  /// </summary>
 		public static void PulseBool(this BasicTriList tl, uint sigNum, int ms)
 		{
 			tl.BooleanInput[sigNum].Pulse(ms);
@@ -284,6 +320,9 @@ namespace PepperDash.Essentials.Core
 		/// <param name="tl"></param>
 		/// <param name="sigNum"></param>
 		/// <returns></returns>
+  /// <summary>
+  /// GetBool method
+  /// </summary>
 		public static bool GetBool(this BasicTriList tl, uint sigNum)
 		{
 			return tl.BooleanOutput[sigNum].BoolValue;
@@ -295,6 +334,9 @@ namespace PepperDash.Essentials.Core
 		/// <param name="tl"></param>
 		/// <param name="sigNum"></param>
 		/// <returns></returns>
+  /// <summary>
+  /// GetUshort method
+  /// </summary>
 		public static ushort GetUshort(this BasicTriList tl, uint sigNum)
 		{
 			return tl.UShortOutput[sigNum].UShortValue;
@@ -306,6 +348,9 @@ namespace PepperDash.Essentials.Core
 		/// <param name="tl"></param>
 		/// <param name="sigNum"></param>
 		/// <returns></returns>
+  /// <summary>
+  /// GetString method
+  /// </summary>
 		public static string GetString(this BasicTriList tl, uint sigNum)
 		{
 			return tl.StringOutput[sigNum].StringValue;