Xml docs essentials core

src/PepperDash.Core/Device.cs

@@ -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>
-		/// Gets or sets a value indicating whether the device is enabled
+		/// 
 		/// </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/Logging/DebugConsoleSink.cs

@@ -41,19 +41,13 @@ 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/DebugCrestronLoggerSink.cs

@@ -27,9 +27,6 @@ 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/DebugErrorLogSink.cs

@@ -63,10 +63,6 @@ public void Emit(LogEvent logEvent)
             handler(message);
         }
 
-        /// <summary>
-        /// Constructor for DebugErrorLogSink
-        /// </summary>
-        /// <param name="formatter">text formatter for log output</param>
         public DebugErrorLogSink(ITextFormatter formatter = null)
         {
             _formatter = formatter;

src/PepperDash.Core/Logging/DebugExtensions.cs

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

src/PepperDash.Core/Logging/DebugWebsocketSink.cs

@@ -32,9 +32,6 @@ public class DebugWebsocketSink : ILogEventSink
         private const string _certificateName = "selfCres";
         private const string _certificatePassword = "cres12345";
 
-        /// <summary>
-        /// Gets the Port
-        /// </summary>
         public int Port 
         { get 
             { 
@@ -44,9 +41,6 @@ public int Port
             } 
         }
 
-        /// <summary>
-        /// Gets the Url
-        /// </summary>
         public string Url
         {
             get
@@ -64,11 +58,6 @@ public string Url
 
         private readonly ITextFormatter _textFormatter;
 
-        /// <summary>
-        /// Constructor for DebugWebsocketSink
-        /// </summary>
-        /// <param name="formatProvider">text formatter for log output</param>
-
         public DebugWebsocketSink(ITextFormatter formatProvider)
         {
 
@@ -228,9 +217,6 @@ public void StopServer()
         }
     }
 
-    /// <summary>
-    /// Provides extension methods for DebugWebsocketSink
-    /// </summary>
     public static class DebugWebsocketSinkExtensions
     {
         /// <summary>
@@ -251,9 +237,6 @@ public class DebugClient : WebSocketBehavior
     {
         private DateTime _connectionTime;
 
-        /// <summary>
-        /// Gets the ConnectedDuration
-        /// </summary>
         public TimeSpan ConnectedDuration
         {
             get
@@ -269,17 +252,11 @@ 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();
@@ -290,19 +267,13 @@ 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);
@@ -311,9 +282,6 @@ protected override void OnClose(CloseEventArgs e)
 
         }
 
-        /// <summary>
-        /// OnError method
-        /// </summary>
         protected override void OnError(WebSocketSharp.ErrorEventArgs e)
         {
             base.OnError(e);

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

@@ -5,16 +5,9 @@
 
 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/WebApiBaseRequestHandler.cs

@@ -10,10 +10,6 @@ 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/WebApiServer.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); }

src/PepperDash.Essentials.Core/Bridges/BridgeHelper.cs

@@ -10,6 +10,10 @@ namespace PepperDash.Essentials.Core.Bridges
     /// </summary>
     public static class BridgeHelper
     {
+        /// <summary>
+        /// PrintJoinMp method
+        /// </summary>
+        /// <param name="command">target bridgekey to print join map for</param>
         public static void PrintJoinMap(string command)
         {
             var targets = command.Split(' ');

src/PepperDash.Essentials.Core/Bridges/JoinMaps/AirMediaControllerJoinMap.cs

@@ -7,50 +7,86 @@ namespace PepperDash.Essentials.Core.Bridges
     /// </summary>
     public class AirMediaControllerJoinMap : JoinMapBaseAdvanced
     {
+        /// <summary>
+        /// Air Media Online status
+        /// </summary>
         [JoinName("IsOnline")]
         public JoinDataComplete IsOnline = new JoinDataComplete(new JoinData { JoinNumber = 1, JoinSpan = 1 },
             new JoinMetadata { Description = "Air Media Online", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinType = eJoinType.Digital });
 
+        /// <summary>
+        /// Air Media In Sharing Session status
+        /// </summary>
         [JoinName("IsInSession")]
         public JoinDataComplete IsInSession = new JoinDataComplete(new JoinData { JoinNumber = 2, JoinSpan = 1 },
             new JoinMetadata { Description = "Air Media In Sharing Session", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinType = eJoinType.Digital });
 
+        /// <summary>
+        /// Air Media Has HDMI Video Sync status
+        /// </summary>
         [JoinName("HdmiVideoSync")]
         public JoinDataComplete HdmiVideoSync = new JoinDataComplete(new JoinData { JoinNumber = 3, JoinSpan = 1 },
             new JoinMetadata { Description = "Air Media Has HDMI Video Sync", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinType = eJoinType.Digital });
 
+        /// <summary>
+        /// Air Media Automatic Input Routing Enable(d)
+        /// </summary>
         [JoinName("AutomaticInputRoutingEnabled")]
         public JoinDataComplete AutomaticInputRoutingEnabled = new JoinDataComplete(new JoinData { JoinNumber = 4, JoinSpan = 1 },
             new JoinMetadata { Description = "Air Media Automatic Input Routing Enable(d)", JoinCapabilities = eJoinCapabilities.ToFromSIMPL, JoinType = eJoinType.Digital });
 
+        /// <summary>
+        /// Air Media Video Route Select / Feedback
+        /// </summary>
         [JoinName("VideoOut")]
         public JoinDataComplete VideoOut = new JoinDataComplete(new JoinData { JoinNumber = 1, JoinSpan = 1 },
             new JoinMetadata { Description = "Air Media Video Route Select / Feedback", JoinCapabilities = eJoinCapabilities.ToFromSIMPL, JoinType = eJoinType.Analog });
 
+        /// <summary>
+        /// Air Media Error Status Feedback
+        /// </summary>
         [JoinName("ErrorFB")]
         public JoinDataComplete ErrorFB = new JoinDataComplete(new JoinData { JoinNumber = 2, JoinSpan = 1 },
             new JoinMetadata { Description = "Air Media Error Status", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinType = eJoinType.Analog });
 
+        /// <summary>
+        /// Air Media Number of Users Connected Feedback
+        /// </summary>
         [JoinName("NumberOfUsersConnectedFB")]
         public JoinDataComplete NumberOfUsersConnectedFB = new JoinDataComplete(new JoinData { JoinNumber = 3, JoinSpan = 1 },
             new JoinMetadata { Description = "Air Media Number of Users Connected", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinType = eJoinType.Analog });
 
+        /// <summary>
+        /// Air Media Login Code Set / Get
+        /// </summary>
         [JoinName("LoginCode")]
         public JoinDataComplete LoginCode = new JoinDataComplete(new JoinData { JoinNumber = 4, JoinSpan = 1 },
             new JoinMetadata { Description = "Air Media Login Code Set / Get", JoinCapabilities = eJoinCapabilities.ToFromSIMPL, JoinType = eJoinType.Analog });
 
+        /// <summary>
+        /// Air Media Device Name
+        /// </summary>
         [JoinName("Name")]
         public JoinDataComplete Name = new JoinDataComplete(new JoinData { JoinNumber = 1, JoinSpan = 1 },
             new JoinMetadata { Description = "Air Media Device Name", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinType = eJoinType.Serial });
 
+        /// <summary>
+        /// Air Media IP Address Feedback
+        /// </summary>
         [JoinName("ConnectionAddressFB")]
         public JoinDataComplete ConnectionAddressFB = new JoinDataComplete(new JoinData { JoinNumber = 2, JoinSpan = 1 },
             new JoinMetadata { Description = "Air Media IP Address", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinType = eJoinType.Serial });
 
+        /// <summary>
+        /// Air Media Hostname Feedback
+        /// </summary>
         [JoinName("HostnameFB")]
         public JoinDataComplete HostnameFB = new JoinDataComplete(new JoinData { JoinNumber = 3, JoinSpan = 1 },
             new JoinMetadata { Description = "Air Media Hostname", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinType = eJoinType.Serial });
 
+        /// <summary>
+        /// Air Media Serial Number Feedback
+        /// </summary>
         [JoinName("SerialNumberFeedback")]
         public JoinDataComplete SerialNumberFeedback = new JoinDataComplete(new JoinData { JoinNumber = 4, JoinSpan = 1 },
             new JoinMetadata { Description = "Air Media Serial Number", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinType = eJoinType.Serial });

src/PepperDash.Essentials.Core/Bridges/JoinMaps/AppleTvJoinMap.cs

@@ -7,30 +7,51 @@ namespace PepperDash.Essentials.Core.Bridges
     /// </summary>
     public class AppleTvJoinMap : JoinMapBaseAdvanced
     {
+        /// <summary>
+        /// AppleTv Nav Up
+        /// </summary>
         [JoinName("UpArrow")]
         public JoinDataComplete UpArrow = new JoinDataComplete(new JoinData { JoinNumber = 1, JoinSpan = 1 },
             new JoinMetadata { Description = "AppleTv Nav Up", JoinCapabilities = eJoinCapabilities.FromSIMPL, JoinType = eJoinType.Digital });
 
+        /// <summary>
+        /// AppleTv Nav Down
+        /// </summary>
         [JoinName("DnArrow")]
         public JoinDataComplete DnArrow = new JoinDataComplete(new JoinData { JoinNumber = 2, JoinSpan = 1 },
             new JoinMetadata { Description = "AppleTv Nav Down", JoinCapabilities = eJoinCapabilities.FromSIMPL, JoinType = eJoinType.Digital });
 
+        /// <summary>
+        /// AppleTv Nav Left
+        /// </summary>
         [JoinName("LeftArrow")]
         public JoinDataComplete LeftArrow = new JoinDataComplete(new JoinData { JoinNumber = 3, JoinSpan = 1 },
             new JoinMetadata { Description = "AppleTv Nav Left", JoinCapabilities = eJoinCapabilities.FromSIMPL, JoinType = eJoinType.Digital });
 
+        /// <summary>
+        /// AppleTv Nav Right
+        /// </summary>
         [JoinName("RightArrow")]
         public JoinDataComplete RightArrow = new JoinDataComplete(new JoinData { JoinNumber = 4, JoinSpan = 1 },
             new JoinMetadata { Description = "AppleTv Nav Right", JoinCapabilities = eJoinCapabilities.FromSIMPL, JoinType = eJoinType.Digital });
 
+        /// <summary>
+        /// AppleTv Menu
+        /// </summary>
         [JoinName("Menu")]
         public JoinDataComplete Menu = new JoinDataComplete(new JoinData { JoinNumber = 5, JoinSpan = 1 },
             new JoinMetadata { Description = "AppleTv Menu", JoinCapabilities = eJoinCapabilities.FromSIMPL, JoinType = eJoinType.Digital });
 
+        /// <summary>
+        /// AppleTv Select
+        /// </summary>
         [JoinName("Select")]
         public JoinDataComplete Select = new JoinDataComplete(new JoinData { JoinNumber = 6, JoinSpan = 1 },
             new JoinMetadata { Description = "AppleTv Select", JoinCapabilities = eJoinCapabilities.FromSIMPL, JoinType = eJoinType.Digital });
 
+        /// <summary>
+        /// AppleTv Play/Pause
+        /// </summary>
         [JoinName("PlayPause")]
         public JoinDataComplete PlayPause = new JoinDataComplete(new JoinData { JoinNumber = 7, JoinSpan = 1 },
             new JoinMetadata { Description = "AppleTv Play/Pause", JoinCapabilities = eJoinCapabilities.FromSIMPL, JoinType = eJoinType.Digital });