diff --git a/src/PepperDash.Core/Device.cs b/src/PepperDash.Core/Device.cs index 7124550e..1295463c 100644 --- a/src/PepperDash.Core/Device.cs +++ b/src/PepperDash.Core/Device.cs @@ -15,23 +15,23 @@ namespace PepperDash.Core /// Unique Key /// public string Key { get; protected set; } - /// - /// Gets or sets the Name - /// + /// + /// Gets or sets the Name + /// public string Name { get; protected set; } /// - /// + /// Gets or sets a value indicating whether the device is enabled /// public bool Enabled { get; protected set; } - /// - /// 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. - /// + // /// + // /// 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. + // /// //public DeviceConfig Config { get; private set; } - /// - /// Helper method to check if Config exists - /// + // /// + // /// Helper method to check if Config exists + // /// //public bool HasConfig { get { return Config != null; } } List _PreActivationActions; diff --git a/src/PepperDash.Core/Logging/DebugConsoleSink.cs b/src/PepperDash.Core/Logging/DebugConsoleSink.cs index 6363caa5..4879de2a 100644 --- a/src/PepperDash.Core/Logging/DebugConsoleSink.cs +++ b/src/PepperDash.Core/Logging/DebugConsoleSink.cs @@ -41,6 +41,9 @@ namespace PepperDash.Core CrestronConsole.PrintLine(message); } + /// + /// Constructor for DebugConsoleSink + /// public DebugConsoleSink(ITextFormatter formatProvider ) { _textFormatter = formatProvider ?? new JsonFormatter(); @@ -48,6 +51,9 @@ namespace PepperDash.Core } + /// + /// Provides extension methods for DebugConsoleSink + /// public static class DebugConsoleSinkExtensions { /// diff --git a/src/PepperDash.Core/Logging/DebugCrestronLoggerSink.cs b/src/PepperDash.Core/Logging/DebugCrestronLoggerSink.cs index 76859209..3fb9c8f2 100644 --- a/src/PepperDash.Core/Logging/DebugCrestronLoggerSink.cs +++ b/src/PepperDash.Core/Logging/DebugCrestronLoggerSink.cs @@ -27,6 +27,9 @@ namespace PepperDash.Core.Logging CrestronLogger.WriteToLog(message, (uint)logEvent.Level); } + /// + /// Constructor for DebugCrestronLoggerSink + /// public DebugCrestronLoggerSink() { CrestronLogger.Initialize(1, LoggerModeEnum.RM); diff --git a/src/PepperDash.Core/Logging/DebugErrorLogSink.cs b/src/PepperDash.Core/Logging/DebugErrorLogSink.cs index 9ab4dc6b..3f8a130d 100644 --- a/src/PepperDash.Core/Logging/DebugErrorLogSink.cs +++ b/src/PepperDash.Core/Logging/DebugErrorLogSink.cs @@ -63,6 +63,10 @@ namespace PepperDash.Core.Logging handler(message); } + /// + /// Constructor for DebugErrorLogSink + /// + /// text formatter for log output public DebugErrorLogSink(ITextFormatter formatter = null) { _formatter = formatter; diff --git a/src/PepperDash.Core/Logging/DebugExtensions.cs b/src/PepperDash.Core/Logging/DebugExtensions.cs index ccee4943..df6fe50a 100644 --- a/src/PepperDash.Core/Logging/DebugExtensions.cs +++ b/src/PepperDash.Core/Logging/DebugExtensions.cs @@ -4,6 +4,9 @@ using Log = PepperDash.Core.Debug; namespace PepperDash.Core.Logging { + /// + /// Provides extension methods for logging on IKeyed objects + /// public static class DebugExtensions { /// diff --git a/src/PepperDash.Core/Logging/DebugWebsocketSink.cs b/src/PepperDash.Core/Logging/DebugWebsocketSink.cs index 9c3df14e..a5152d89 100644 --- a/src/PepperDash.Core/Logging/DebugWebsocketSink.cs +++ b/src/PepperDash.Core/Logging/DebugWebsocketSink.cs @@ -32,6 +32,9 @@ namespace PepperDash.Core private const string _certificateName = "selfCres"; private const string _certificatePassword = "cres12345"; + /// + /// Gets the Port + /// public int Port { get { @@ -41,6 +44,9 @@ namespace PepperDash.Core } } + /// + /// Gets the Url + /// public string Url { get @@ -58,6 +64,11 @@ namespace PepperDash.Core private readonly ITextFormatter _textFormatter; + /// + /// Constructor for DebugWebsocketSink + /// + /// text formatter for log output + public DebugWebsocketSink(ITextFormatter formatProvider) { @@ -217,6 +228,9 @@ namespace PepperDash.Core } } + /// + /// Provides extension methods for DebugWebsocketSink + /// public static class DebugWebsocketSinkExtensions { /// @@ -237,6 +251,9 @@ namespace PepperDash.Core { private DateTime _connectionTime; + /// + /// Gets the ConnectedDuration + /// public TimeSpan ConnectedDuration { get @@ -252,11 +269,17 @@ namespace PepperDash.Core } } + /// + /// Constructor for DebugClient + /// public DebugClient() { Debug.Console(0, "DebugClient Created"); } + /// + /// OnOpen method + /// protected override void OnOpen() { base.OnOpen(); @@ -267,6 +290,9 @@ namespace PepperDash.Core _connectionTime = DateTime.Now; } + /// + /// OnMessage method + /// protected override void OnMessage(MessageEventArgs e) { base.OnMessage(e); @@ -274,6 +300,9 @@ namespace PepperDash.Core Debug.Console(0, "WebSocket UiClient Message: {0}", e.Data); } + /// + /// OnClose method + /// protected override void OnClose(CloseEventArgs e) { base.OnClose(e); @@ -282,6 +311,9 @@ namespace PepperDash.Core } + /// + /// OnError method + /// protected override void OnError(WebSocketSharp.ErrorEventArgs e) { base.OnError(e); diff --git a/src/PepperDash.Core/Web/RequestHandlers/WebApiBaseRequestAsyncHandler.cs b/src/PepperDash.Core/Web/RequestHandlers/WebApiBaseRequestAsyncHandler.cs index 927092db..82e5df4a 100644 --- a/src/PepperDash.Core/Web/RequestHandlers/WebApiBaseRequestAsyncHandler.cs +++ b/src/PepperDash.Core/Web/RequestHandlers/WebApiBaseRequestAsyncHandler.cs @@ -5,9 +5,16 @@ using System.Threading.Tasks; namespace PepperDash.Core.Web.RequestHandlers { + /// + /// CWS Base Async Handler, implements IHttpCwsHandler + /// public abstract class WebApiBaseRequestAsyncHandler:IHttpCwsHandler { private readonly Dictionary> _handlers; + + /// + /// Indicates whether CORS is enabled + /// protected readonly bool EnableCors; /// diff --git a/src/PepperDash.Core/Web/RequestHandlers/WebApiBaseRequestHandler.cs b/src/PepperDash.Core/Web/RequestHandlers/WebApiBaseRequestHandler.cs index a02f3497..e7681ac3 100644 --- a/src/PepperDash.Core/Web/RequestHandlers/WebApiBaseRequestHandler.cs +++ b/src/PepperDash.Core/Web/RequestHandlers/WebApiBaseRequestHandler.cs @@ -10,6 +10,10 @@ namespace PepperDash.Core.Web.RequestHandlers public abstract class WebApiBaseRequestHandler : IHttpCwsHandler { private readonly Dictionary> _handlers; + + /// + /// Indicates whether CORS is enabled + /// protected readonly bool EnableCors; /// diff --git a/src/PepperDash.Core/Web/WebApiServer.cs b/src/PepperDash.Core/Web/WebApiServer.cs index 11ec4e2f..769da961 100644 --- a/src/PepperDash.Core/Web/WebApiServer.cs +++ b/src/PepperDash.Core/Web/WebApiServer.cs @@ -45,9 +45,9 @@ namespace PepperDash.Core.Web /// public bool IsRegistered { get; private set; } - /// - /// Http request handler - /// + // /// + // /// Http request handler + // /// //public IHttpCwsHandler HttpRequestHandler //{ // get { return _server.HttpRequestHandler; } @@ -58,9 +58,9 @@ namespace PepperDash.Core.Web // } //} - /// - /// Received request event handler - /// + // /// + // /// Received request event handler + // /// //public event EventHandler ReceivedRequestEvent //{ // add { _server.ReceivedRequestEvent += new HttpCwsRequestEventHandler(value); }