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/Web/EssentialsWebApi.cs

@@ -10,6 +10,9 @@ using Serilog.Events;
 
 namespace PepperDash.Essentials.Core.Web
 {
+ /// <summary>
+ /// Represents a EssentialsWebApi
+ /// </summary>
 	public class EssentialsWebApi : EssentialsDevice
 	{
 		private readonly WebApiServer _server;        
@@ -26,9 +29,9 @@ namespace PepperDash.Essentials.Core.Web
 		private const int DebugInfo = 1;
 		private const int DebugVerbose = 2;
 
-		/// <summary>
-		/// CWS base path
-		/// </summary>
+  /// <summary>
+  /// Gets or sets the BasePath
+  /// </summary>
 		public string BasePath { get; private set; }
 
 		/// <summary>
@@ -183,6 +186,9 @@ namespace PepperDash.Essentials.Core.Web
         /// Add a single route to the API. MUST be done during the activation phase
         /// </summary>
         /// <param name="route"></param>
+        /// <summary>
+        /// AddRoute method
+        /// </summary>
         public void AddRoute(HttpCwsRoute route)
         {
             _server.AddRoute(route);
@@ -201,8 +207,9 @@ namespace PepperDash.Essentials.Core.Web
         }
 
         /// <summary>
-        /// Initializes the CWS class
+        /// Initialize method
         /// </summary>
+        /// <inheritdoc />
         public override void Initialize()
 		{
             AddRoute(new HttpCwsRoute("apiPaths") {
@@ -245,6 +252,9 @@ namespace PepperDash.Essentials.Core.Web
 		/// http(s)://{ipaddress}/cws/{basePath}
 		/// http(s)://{ipaddress}/VirtualControl/Rooms/{roomId}/cws/{basePath}
 		/// </example>
+  /// <summary>
+  /// GetPaths method
+  /// </summary>
 		public void GetPaths()
 		{
 			Debug.LogMessage(LogEventLevel.Information, this, new string('-', 50));

src/PepperDash.Essentials.Core/Web/EssentialsWebApiFactory.cs

@@ -5,6 +5,9 @@ using Serilog.Events;
 
 namespace PepperDash.Essentials.Core.Web
 {
+ /// <summary>
+ /// Represents a EssentialsWebApiFactory
+ /// </summary>
 	public class EssentialsWebApiFactory : EssentialsDeviceFactory<EssentialsWebApi>
 	{
 		public EssentialsWebApiFactory()
@@ -12,6 +15,10 @@ namespace PepperDash.Essentials.Core.Web
 			TypeNames = new List<string> { "EssentialsWebApi" };
 		}
 
+  /// <summary>
+  /// BuildDevice method
+  /// </summary>
+  /// <inheritdoc />
 		public override EssentialsDevice BuildDevice(DeviceConfig dc)
 		{
 			Debug.LogMessage(LogEventLevel.Debug, "Factory Attempting to create new Essentials Web API Server");

src/PepperDash.Essentials.Core/Web/EssentialsWebApiHelpers.cs

@@ -9,6 +9,9 @@ namespace PepperDash.Essentials.Core.Web
 {
 	public static class EssentialsWebApiHelpers
 	{
+  /// <summary>
+  /// GetRequestBody method
+  /// </summary>
 		public static string GetRequestBody(this HttpCwsRequest request)
 		{
 			var bytes = new byte[request.ContentLength];
@@ -18,6 +21,9 @@ namespace PepperDash.Essentials.Core.Web
 			return Encoding.UTF8.GetString(bytes, 0, bytes.Length);
 		}
 
+  /// <summary>
+  /// MapToAssemblyObject method
+  /// </summary>
 		public static object MapToAssemblyObject(LoadedAssembly assembly)
 		{
 			return new
@@ -27,6 +33,9 @@ namespace PepperDash.Essentials.Core.Web
 			};
 		}
 
+  /// <summary>
+  /// MapToDeviceListObject method
+  /// </summary>
 		public static object MapToDeviceListObject(IKeyed device)
 		{
 			return new
@@ -38,6 +47,9 @@ namespace PepperDash.Essentials.Core.Web
 			};
 		}
 
+  /// <summary>
+  /// MapJoinToObject method
+  /// </summary>
 		public static object MapJoinToObject(string key, JoinMapBaseAdvanced join)
 		{
 			var kp = new KeyValuePair<string, JoinMapBaseAdvanced>(key, join);
@@ -45,6 +57,9 @@ namespace PepperDash.Essentials.Core.Web
 			return MapJoinToObject(kp);
 		}
 
+  /// <summary>
+  /// MapJoinToObject method
+  /// </summary>
 		public static object MapJoinToObject(KeyValuePair<string, JoinMapBaseAdvanced> join)
 		{
 			return new
@@ -54,6 +69,9 @@ namespace PepperDash.Essentials.Core.Web
 			};
 		}
 
+  /// <summary>
+  /// MapJoinDataCompleteToObject method
+  /// </summary>
 		public static object MapJoinDataCompleteToObject(KeyValuePair<string, JoinDataComplete> joinData)
 		{
 			return new
@@ -67,6 +85,9 @@ namespace PepperDash.Essentials.Core.Web
 			};
 		}
 
+  /// <summary>
+  /// MapDeviceTypeToObject method
+  /// </summary>
 		public static object MapDeviceTypeToObject(string key, DeviceFactoryWrapper device)
 		{
 			var kp = new KeyValuePair<string, DeviceFactoryWrapper>(key, device);
@@ -74,6 +95,9 @@ namespace PepperDash.Essentials.Core.Web
 			return MapDeviceTypeToObject(kp);
 		}
 
+  /// <summary>
+  /// MapDeviceTypeToObject method
+  /// </summary>
 		public static object MapDeviceTypeToObject(KeyValuePair<string, DeviceFactoryWrapper> device)
 		{
 			return new

src/PepperDash.Essentials.Core/Web/EssentialsWebApiPropertiesConfig.cs

@@ -2,9 +2,15 @@
 
 namespace PepperDash.Essentials.Core.Web
 {
+ /// <summary>
+ /// Represents a EssentialsWebApiPropertiesConfig
+ /// </summary>
 	public class EssentialsWebApiPropertiesConfig
 	{
 		[JsonProperty("basePath")]
+  /// <summary>
+  /// Gets or sets the BasePath
+  /// </summary>
 		public string BasePath { get; set; }
 	}
 }

src/PepperDash.Essentials.Core/Web/RequestHandlers/AppDebugRequestHandler.cs

@@ -8,6 +8,9 @@ using Newtonsoft.Json.Converters;
 
 namespace PepperDash.Essentials.Core.Web.RequestHandlers
 {
+ /// <summary>
+ /// Represents a AppDebugRequestHandler
+ /// </summary>
 	public class AppDebugRequestHandler : WebApiBaseRequestHandler
 	{
 		/// <summary>
@@ -77,10 +80,16 @@ namespace PepperDash.Essentials.Core.Web.RequestHandlers
 		}
 	}
 
+ /// <summary>
+ /// Represents a AppDebug
+ /// </summary>
 	public class AppDebug
 	{
 		[JsonProperty("minimumLevel", NullValueHandling = NullValueHandling.Ignore)]
         [JsonConverter(typeof(StringEnumConverter))]
+        /// <summary>
+        /// Gets or sets the MinimumLevel
+        /// </summary>
         public LogEventLevel MinimumLevel { get; set; }
 	}
 }

src/PepperDash.Essentials.Core/Web/RequestHandlers/DebugSessionRequestHandler.cs

@@ -13,6 +13,9 @@ using System.Threading.Tasks;
 
 namespace PepperDash.Essentials.Core.Web.RequestHandlers
 {
+    /// <summary>
+    /// Represents a DebugSessionRequestHandler
+    /// </summary>
     public class DebugSessionRequestHandler : WebApiBaseRequestHandler
     {    
         public DebugSessionRequestHandler()

src/PepperDash.Essentials.Core/Web/RequestHandlers/DefaultRequestHandler.cs

@@ -3,6 +3,9 @@ using PepperDash.Core.Web.RequestHandlers;
 
 namespace PepperDash.Essentials.Core.Web.RequestHandlers
 {
+ /// <summary>
+ /// Represents a DefaultRequestHandler
+ /// </summary>
 	public class DefaultRequestHandler : WebApiBaseRequestHandler
 	{
 		/// <summary>

src/PepperDash.Essentials.Core/Web/RequestHandlers/DevJsonRequestHandler.cs

@@ -7,6 +7,9 @@ using Serilog.Events;
 
 namespace PepperDash.Essentials.Core.Web.RequestHandlers
 {
+ /// <summary>
+ /// Represents a DevJsonRequestHandler
+ /// </summary>
 	public class DevJsonRequestHandler : WebApiBaseRequestHandler
 	{
 		/// <summary>

src/PepperDash.Essentials.Core/Web/RequestHandlers/DevListRequestHandler.cs

@@ -5,6 +5,9 @@ using PepperDash.Core.Web.RequestHandlers;
 
 namespace PepperDash.Essentials.Core.Web.RequestHandlers
 {
+ /// <summary>
+ /// Represents a DevListRequestHandler
+ /// </summary>
 	public class DevListRequestHandler : WebApiBaseRequestHandler
 	{
 		/// <summary>

src/PepperDash.Essentials.Core/Web/RequestHandlers/DevMethodsRequestHandler.cs

@@ -6,6 +6,9 @@ using PepperDash.Core.Web.RequestHandlers;
 
 namespace PepperDash.Essentials.Core.Web.RequestHandlers
 {
+ /// <summary>
+ /// Represents a DevMethodsRequestHandler
+ /// </summary>
 	public class DevMethodsRequestHandler : WebApiBaseRequestHandler
 	{
 		/// <summary>

src/PepperDash.Essentials.Core/Web/RequestHandlers/DevPropsRequestHandler.cs

@@ -5,6 +5,9 @@ using PepperDash.Core.Web.RequestHandlers;
 
 namespace PepperDash.Essentials.Core.Web.RequestHandlers
 {
+ /// <summary>
+ /// Represents a DevPropsRequestHandler
+ /// </summary>
 	public class DevPropsRequestHandler : WebApiBaseRequestHandler
 	{
 		/// <summary>

src/PepperDash.Essentials.Core/Web/RequestHandlers/DisableAllStreamDebugRequestHandler.cs

@@ -3,6 +3,9 @@ using PepperDash.Core.Web.RequestHandlers;
 
 namespace PepperDash.Essentials.Core.Web.RequestHandlers
 {
+ /// <summary>
+ /// Represents a DisableAllStreamDebugRequestHandler
+ /// </summary>
 	public class DisableAllStreamDebugRequestHandler : WebApiBaseRequestHandler
 	{
 		/// <summary>

src/PepperDash.Essentials.Core/Web/RequestHandlers/DoNotLoadConfigOnNextBootRequestHandler.cs

@@ -5,6 +5,9 @@ using PepperDash.Core.Web.RequestHandlers;
 
 namespace PepperDash.Essentials.Core.Web.RequestHandlers
 {
+ /// <summary>
+ /// Represents a DoNotLoadConfigOnNextBootRequestHandler
+ /// </summary>
 	public class DoNotLoadConfigOnNextBootRequestHandler : WebApiBaseRequestHandler
 	{
 		/// <summary>
@@ -76,9 +79,15 @@ namespace PepperDash.Essentials.Core.Web.RequestHandlers
 		}
 	}
 
+ /// <summary>
+ /// Represents a Data
+ /// </summary>
 	public class Data
 	{
 		[JsonProperty("doNotLoadConfigOnNextBoot", NullValueHandling = NullValueHandling.Ignore)]
+  /// <summary>
+  /// Gets or sets the DoNotLoadConfigOnNextBoot
+  /// </summary>
 		public bool DoNotLoadConfigOnNextBoot { get; set; }
 	}
 }

src/PepperDash.Essentials.Core/Web/RequestHandlers/GetFeedbacksForDeviceRequestHandler.cs

@@ -5,6 +5,9 @@ using PepperDash.Core.Web.RequestHandlers;
 
 namespace PepperDash.Essentials.Core.Web.RequestHandlers
 {
+ /// <summary>
+ /// Represents a GetFeedbacksForDeviceRequestHandler
+ /// </summary>
 	public class GetFeedbacksForDeviceRequestHandler : WebApiBaseRequestHandler
 	{
 		/// <summary>

src/PepperDash.Essentials.Core/Web/RequestHandlers/GetJoinMapForBridgeKeyRequestHandler.cs

@@ -6,6 +6,9 @@ using PepperDash.Essentials.Core.Bridges;
 
 namespace PepperDash.Essentials.Core.Web.RequestHandlers
 {
+ /// <summary>
+ /// Represents a GetJoinMapForBridgeKeyRequestHandler
+ /// </summary>
 	public class GetJoinMapForBridgeKeyRequestHandler : WebApiBaseRequestHandler
 	{
 		/// <summary>

src/PepperDash.Essentials.Core/Web/RequestHandlers/GetJoinMapForDeviceKeyRequestHandler.cs

@@ -5,6 +5,9 @@ using PepperDash.Essentials.Core.Bridges;
 
 namespace PepperDash.Essentials.Core.Web.RequestHandlers
 {
+ /// <summary>
+ /// Represents a GetJoinMapForDeviceKeyRequestHandler
+ /// </summary>
 	public class GetJoinMapForDeviceKeyRequestHandler : WebApiBaseRequestHandler
 	{
 		/// <summary>

src/PepperDash.Essentials.Core/Web/RequestHandlers/GetRoutesHandler.cs

@@ -5,6 +5,9 @@ using PepperDash.Core.Web.RequestHandlers;
 
 namespace PepperDash.Essentials.Core.Web.RequestHandlers
 {
+    /// <summary>
+    /// Represents a GetRoutesHandler
+    /// </summary>
     public class GetRoutesHandler:WebApiBaseRequestHandler
     {
         private HttpCwsRouteCollection routeCollection;
@@ -41,12 +44,21 @@ namespace PepperDash.Essentials.Core.Web.RequestHandlers
         }
     }
 
+    /// <summary>
+    /// Represents a RoutesResponseObject
+    /// </summary>
     public class  RoutesResponseObject 
     {
         [JsonProperty("url")]
+        /// <summary>
+        /// Gets or sets the Url
+        /// </summary>
         public string Url { set; get; }
 
         [JsonProperty("routes")]
+        /// <summary>
+        /// Gets or sets the Routes
+        /// </summary>
         public HttpCwsRouteCollection Routes { get; set; }
     }
 }

src/PepperDash.Essentials.Core/Web/RequestHandlers/GetRoutingPortsHandler.cs

@@ -7,6 +7,9 @@ using System.Text;
 
 namespace PepperDash.Essentials.Core.Web.RequestHandlers
 {
+    /// <summary>
+    /// Represents a GetRoutingPortsHandler
+    /// </summary>
     public class GetRoutingPortsHandler : WebApiBaseRequestHandler
     {
         public GetRoutingPortsHandler() : base(true) { }
@@ -62,9 +65,15 @@ namespace PepperDash.Essentials.Core.Web.RequestHandlers
 
     internal class ReturnValue {
         [JsonProperty("inputPorts", NullValueHandling = NullValueHandling.Ignore)]
+        /// <summary>
+        /// Gets or sets the InputPorts
+        /// </summary>
         public List<string> InputPorts { get; set; }
 
         [JsonProperty("outputPorts", NullValueHandling = NullValueHandling.Ignore)]
+        /// <summary>
+        /// Gets or sets the OutputPorts
+        /// </summary>
         public List<string> OutputPorts { get; set; }
     }
 }

src/PepperDash.Essentials.Core/Web/RequestHandlers/GetTieLinesRequestHandler.cs

@@ -6,6 +6,9 @@ using System.Text;
 
 namespace PepperDash.Essentials.Core.Web.RequestHandlers
 {
+    /// <summary>
+    /// Represents a GetTieLinesRequestHandler
+    /// </summary>
     public class GetTieLinesRequestHandler : WebApiBaseRequestHandler
     {
         public GetTieLinesRequestHandler() : base(true) { }

src/PepperDash.Essentials.Core/Web/RequestHandlers/GetTypesByFilterRequestHandler.cs

@@ -5,6 +5,9 @@ using PepperDash.Core.Web.RequestHandlers;
 
 namespace PepperDash.Essentials.Core.Web.RequestHandlers
 {
+ /// <summary>
+ /// Represents a GetTypesByFilterRequestHandler
+ /// </summary>
 	public class GetTypesByFilterRequestHandler : WebApiBaseRequestHandler
 	{
 		/// <summary>

src/PepperDash.Essentials.Core/Web/RequestHandlers/GetTypesRequestHandler.cs

@@ -5,6 +5,9 @@ using PepperDash.Core.Web.RequestHandlers;
 
 namespace PepperDash.Essentials.Core.Web.RequestHandlers
 {
+ /// <summary>
+ /// Represents a GetTypesRequestHandler
+ /// </summary>
 	public class GetTypesRequestHandler : WebApiBaseRequestHandler
 	{
 		/// <summary>

src/PepperDash.Essentials.Core/Web/RequestHandlers/LoadConfigRequestHandler.cs

@@ -6,6 +6,9 @@ using PepperDash.Core.Web.RequestHandlers;
 
 namespace PepperDash.Essentials.Core.Web.RequestHandlers
 {
+ /// <summary>
+ /// Represents a LoadConfigRequestHandler
+ /// </summary>
 	public class LoadConfigRequestHandler : WebApiBaseRequestHandler
 	{
 		/// <summary>

src/PepperDash.Essentials.Core/Web/RequestHandlers/ReportVersionsRequestHandler.cs

@@ -5,6 +5,9 @@ using PepperDash.Core.Web.RequestHandlers;
 
 namespace PepperDash.Essentials.Core.Web.RequestHandlers
 {
+ /// <summary>
+ /// Represents a ReportVersionsRequestHandler
+ /// </summary>
 	public class ReportVersionsRequestHandler : WebApiBaseRequestHandler
 	{
 		/// <summary>

src/PepperDash.Essentials.Core/Web/RequestHandlers/RestartProgramRequestHandler.cs

@@ -6,6 +6,9 @@ using PepperDash.Core.Web.RequestHandlers;
 
 namespace PepperDash.Essentials.Core.Web.RequestHandlers
 {
+ /// <summary>
+ /// Represents a RestartProgramRequestHandler
+ /// </summary>
 	public class RestartProgramRequestHandler : WebApiBaseRequestHandler
 	{
 		/// <summary>

src/PepperDash.Essentials.Core/Web/RequestHandlers/SetDeviceStreamDebugRequestHandler.cs

@@ -6,6 +6,9 @@ using PepperDash.Core.Web.RequestHandlers;
 
 namespace PepperDash.Essentials.Core.Web.RequestHandlers
 {
+ /// <summary>
+ /// Represents a SetDeviceStreamDebugRequestHandler
+ /// </summary>
 	public class SetDeviceStreamDebugRequestHandler : WebApiBaseRequestHandler
 	{
 		/// <summary>
@@ -195,12 +198,21 @@ namespace PepperDash.Essentials.Core.Web.RequestHandlers
 	public class SetDeviceStreamDebugConfig
 	{
 		[JsonProperty("deviceKey", NullValueHandling = NullValueHandling.Include)]
+  /// <summary>
+  /// Gets or sets the DeviceKey
+  /// </summary>
 		public string DeviceKey { get; set; }
 
 		[JsonProperty("setting", NullValueHandling = NullValueHandling.Include)]
+  /// <summary>
+  /// Gets or sets the Setting
+  /// </summary>
 		public string Setting { get; set; }
 
 		[JsonProperty("timeout")]
+  /// <summary>
+  /// Gets or sets the Timeout
+  /// </summary>
 		public int Timeout { get; set; }
 
 		public SetDeviceStreamDebugConfig()

src/PepperDash.Essentials.Core/Web/RequestHandlers/ShowConfigRequestHandler.cs

@@ -5,6 +5,9 @@ using PepperDash.Essentials.Core.Config;
 
 namespace PepperDash.Essentials.Core.Web.RequestHandlers
 {
+ /// <summary>
+ /// Represents a ShowConfigRequestHandler
+ /// </summary>
 	public class ShowConfigRequestHandler : WebApiBaseRequestHandler
 	{
 		/// <summary>