feat: complete XML documentation in PD Core

Author: erikdred

buildFile.txt

@@ -15,23 +15,23 @@ public class Device : IKeyName
 		/// Unique Key
 		/// </summary>
 		public string Key { get; protected set; }
-  /// <summary>
-  /// Gets or sets the Name
-  /// </summary>
+		/// <summary>
+		/// Gets or sets the Name
+		/// </summary>
 		public string Name { get; protected set; }
 		/// <summary>
 		/// 
 		/// </summary>
 		public bool Enabled { get; protected set; }
 
-		/// <summary>
-		/// A place to store reference to the original config object, if any. These values should 
-		/// NOT be used as properties on the device as they are all publicly-settable values.
-		/// </summary>
+		// /// <summary>
+		// /// A place to store reference to the original config object, if any. These values should 
+		// /// NOT be used as properties on the device as they are all publicly-settable values.
+		// /// </summary>
 		//public DeviceConfig Config { get; private set; }
-		/// <summary>
-		/// Helper method to check if Config exists
-		/// </summary>
+		// /// <summary>
+		// /// Helper method to check if Config exists
+		// /// </summary>
 		//public bool HasConfig { get { return Config != null; } }
 
 		List<Action> _PreActivationActions;

src/PepperDash.Core/Device.cs

@@ -41,13 +41,19 @@ public void Emit(LogEvent logEvent)
             CrestronConsole.PrintLine(message);
         }
 
+        /// <summary>
+        /// Constructor for DebugConsoleSink        
+        /// </summary>
         public DebugConsoleSink(ITextFormatter formatProvider )
         {
             _textFormatter = formatProvider ?? new JsonFormatter();
         }
 
     }
 
+    /// <summary>
+    /// Provides extension methods for DebugConsoleSink     
+    /// </summary>
     public static class DebugConsoleSinkExtensions
     {
         /// <summary>

src/PepperDash.Core/Logging/DebugConsoleSink.cs

@@ -27,6 +27,9 @@ public void Emit(LogEvent logEvent)
             CrestronLogger.WriteToLog(message, (uint)logEvent.Level);
         }
 
+        /// <summary>
+        /// Constructor for DebugCrestronLoggerSink
+        /// </summary>
         public DebugCrestronLoggerSink()
         {
             CrestronLogger.Initialize(1, LoggerModeEnum.RM);

src/PepperDash.Core/Logging/DebugCrestronLoggerSink.cs

@@ -63,6 +63,9 @@ public void Emit(LogEvent logEvent)
             handler(message);
         }
 
+        /// <summary>
+        /// Constructor for DebugErrorLogSink
+        /// </summary>
         public DebugErrorLogSink(ITextFormatter formatter = null)
         {
             _formatter = formatter;

src/PepperDash.Core/Logging/DebugErrorLogSink.cs

@@ -4,6 +4,9 @@
 
 namespace PepperDash.Core.Logging
 {
+    /// <summary>               
+    /// Provides extension methods for logging on IKeyed objects
+    /// </summary>
     public static class DebugExtensions
     {
         /// <summary>

src/PepperDash.Core/Logging/DebugExtensions.cs

@@ -32,6 +32,9 @@ public class DebugWebsocketSink : ILogEventSink
         private const string _certificateName = "selfCres";
         private const string _certificatePassword = "cres12345";
 
+        /// <summary>
+        /// Gets the Port
+        /// </summary>
         public int Port 
         { get 
             { 
@@ -41,6 +44,9 @@ public int Port
             } 
         }
 
+        /// <summary>
+        /// Gets the Url
+        /// </summary>
         public string Url
         {
             get
@@ -58,6 +64,9 @@ public string Url
 
         private readonly ITextFormatter _textFormatter;
 
+        /// <summary>
+        /// Constructor for DebugWebsocketSink
+        /// </summary>
         public DebugWebsocketSink(ITextFormatter formatProvider)
         {
 
@@ -217,6 +226,9 @@ public void StopServer()
         }
     }
 
+    /// <summary>
+    /// Provides extension methods for DebugWebsocketSink   
+    /// </summary>
     public static class DebugWebsocketSinkExtensions
     {
         /// <summary>
@@ -237,6 +249,9 @@ public class DebugClient : WebSocketBehavior
     {
         private DateTime _connectionTime;
 
+        /// <summary>
+        /// Gets the ConnectedDuration
+        /// </summary>
         public TimeSpan ConnectedDuration
         {
             get
@@ -252,11 +267,17 @@ public TimeSpan ConnectedDuration
             }
         }
 
+        /// <summary>
+        /// Constructor for DebugClient
+        /// </summary>
         public DebugClient()
         {
             Debug.Console(0, "DebugClient Created");
         }
 
+        /// <summary>
+        /// OnOpen method
+        /// </summary>
         protected override void OnOpen()
         {
             base.OnOpen();
@@ -267,13 +288,19 @@ protected override void OnOpen()
             _connectionTime = DateTime.Now;
         }
 
+        /// <summary>
+        /// OnMessage method
+        /// </summary>
         protected override void OnMessage(MessageEventArgs e)
         {
             base.OnMessage(e);
 
             Debug.Console(0, "WebSocket UiClient Message: {0}", e.Data);
         }
 
+        /// <summary>
+        /// OnClose method
+        /// </summary>
         protected override void OnClose(CloseEventArgs e)
         {
             base.OnClose(e);
@@ -282,6 +309,9 @@ protected override void OnClose(CloseEventArgs e)
 
         }
 
+        /// <summary>
+        /// OnError method          
+        /// </summary>
         protected override void OnError(WebSocketSharp.ErrorEventArgs e)
         {
             base.OnError(e);

src/PepperDash.Core/Logging/DebugWebsocketSink.cs

@@ -5,9 +5,16 @@
 
 namespace PepperDash.Core.Web.RequestHandlers
 {
+    /// <summary>
+    /// CWS Base Async Handler, implements IHttpCwsHandler      
+    /// </summary>
     public abstract class WebApiBaseRequestAsyncHandler:IHttpCwsHandler
     {
         private readonly Dictionary<string, Func<HttpCwsContext, Task>> _handlers;
+       
+       /// <summary>
+       /// Indicates whether CORS is enabled
+       /// </summary>
         protected readonly bool EnableCors;
 
         /// <summary>

src/PepperDash.Core/Web/RequestHandlers/WebApiBaseRequestAsyncHandler.cs

@@ -10,6 +10,10 @@ namespace PepperDash.Core.Web.RequestHandlers
 	public abstract class WebApiBaseRequestHandler : IHttpCwsHandler
 	{
 		private readonly Dictionary<string, Action<HttpCwsContext>> _handlers;
+		
+		/// <summary>
+		/// Indicates whether CORS is enabled
+		/// </summary>
 		protected readonly bool EnableCors;
 
 		/// <summary>

src/PepperDash.Core/Web/RequestHandlers/WebApiBaseRequestHandler.cs

@@ -45,9 +45,9 @@ public class WebApiServer : IKeyName
   /// </summary>
 		public bool IsRegistered { get; private set; }
 
-		/// <summary>
-		/// Http request handler
-		/// </summary>
+		// /// <summary>
+		// /// Http request handler
+		// /// </summary>
 		//public IHttpCwsHandler HttpRequestHandler
 		//{
 		//    get { return _server.HttpRequestHandler; }
@@ -58,9 +58,9 @@ public class WebApiServer : IKeyName
 		//    }
 		//}
 
-		/// <summary>
-		/// Received request event handler
-		/// </summary>
+		// /// <summary>
+		// /// Received request event handler
+		// /// </summary>
 		//public event EventHandler<HttpCwsRequestEventArgs> ReceivedRequestEvent
 		//{
 		//    add { _server.ReceivedRequestEvent += new HttpCwsRequestEventHandler(value); }