docs(core): Resolves remaining XML comment compiler warnings

Pepperdash Core/Pepperdash Core/Comm/CommunicationGather.cs

@@ -51,7 +51,7 @@ namespace PepperDash.Core
 		string[] StringDelimiters;
 
 		/// <summary>
-		/// Fires up a gather, given a IBasicCommunicaion port and char for de
+		/// Constructor for using a char delimiter
 		/// </summary>
 		/// <param name="port"></param>
 		/// <param name="delimiter"></param>
@@ -63,7 +63,7 @@ namespace PepperDash.Core
 		}
 
 		/// <summary>
-		/// 
+		/// Constructor for using a single string delimiter
 		/// </summary>
 		/// <param name="port"></param>
 		/// <param name="delimiter"></param>
@@ -72,6 +72,11 @@ namespace PepperDash.Core
 		{
 		}
 
+        /// <summary>
+        /// Constructor for using an array of string delimiters
+        /// </summary>
+        /// <param name="port"></param>
+        /// <param name="delimiters"></param>
         public CommunicationGather(ICommunicationReceiver port, string[] delimiters)
         {
             Port = port;

Pepperdash Core/Pepperdash Core/Comm/CommunicationStreamDebugging.cs

@@ -137,9 +137,21 @@ namespace PepperDash.Core
     [Flags]
     public enum eStreamDebuggingSetting
     {
+        /// <summary>
+        /// Debug off
+        /// </summary>
         Off = 0,
+        /// <summary>
+        /// Debug received data
+        /// </summary>
         Rx = 1, 
+        /// <summary>
+        /// Debug transmitted data
+        /// </summary>
         Tx = 2,
+        /// <summary>
+        /// Debug both received and transmitted data
+        /// </summary>
         Both = Rx | Tx
     }
 
@@ -149,8 +161,17 @@ namespace PepperDash.Core
     [Flags]
     public enum eStreamDebuggingDataTypeSettings
     {
+        /// <summary>
+        /// Debug data in byte format
+        /// </summary>
         Bytes = 0,
+        /// <summary>
+        /// Debug data in text format
+        /// </summary>
         Text = 1,
+        /// <summary>
+        /// Debug data in both byte and text formats
+        /// </summary>
         Both = Bytes | Text,
     }
 }

Pepperdash Core/Pepperdash Core/Comm/GenericHttpSseClient.cs

@@ -159,7 +159,7 @@ namespace PepperDash.Core
         /// <summary>
         /// 
         /// </summary>
-        /// <param name="asynchronousResult"></param>
+        /// <param name="request"></param>
         /// <param name="error"></param>
         /// <param name="status"></param>
         private void GetResponseStreamCallback(HttpClientRequest request, HTTP_CALLBACK_ERROR error, object status)

Pepperdash Core/Pepperdash Core/Comm/GenericSecureTcpIpClient.cs

@@ -416,6 +416,10 @@ namespace PepperDash.Core
 
         }
 
+        /// <summary>
+        /// Deactivate the client
+        /// </summary>
+        /// <returns></returns>
         public override bool Deactivate()
         {
             if (_client != null)
@@ -604,30 +608,6 @@ namespace PepperDash.Core
             ConnectFailTimer.Dispose();
             ConnectFailTimer = null;
         }
-
-        /// <summary>
-        ///  Internal call to close up client. ALWAYS use this when disconnecting.
-        /// </summary>
-        //void Cleanup()
-        //{
-        //    IsTryingToConnect = false;
-
-        //    if (_client != null)
-        //    {
-        //        //SecureClient.DisconnectFromServer();
-        //        Debug.Console(2, this, "Disconnecting _client {0}", DisconnectCalledByUser ? ", Called by user" : "");
-        //        _client.SocketStatusChange -= Client_SocketStatusChange;
-        //        _client.Dispose();
-        //        _client = null;
-        //    }
-        //    if (ConnectFailTimer != null)
-        //    {
-        //        ConnectFailTimer.Stop();
-        //        ConnectFailTimer.Dispose();
-        //        ConnectFailTimer = null;
-        //    }
-        //}
-
        
         #region Methods
 

Pepperdash Core/Pepperdash Core/Comm/GenericSecureTcpIpClient_ForServer.cs

@@ -223,13 +223,22 @@ namespace PepperDash.Core
         CTimer RetryTimer;
 
 
+        /// <summary>
+        /// 
+        /// </summary>
         public bool HeartbeatEnabled { get; set; }
+        /// <summary>
+        /// 
+        /// </summary>
         public ushort UHeartbeatEnabled
         {
             get { return (ushort)(HeartbeatEnabled ? 1 : 0); }
             set { HeartbeatEnabled = value == 1; }
         }
 
+        /// <summary>
+        /// 
+        /// </summary>
         public string HeartbeatString { get; set; }
         //public int HeartbeatInterval = 50000;
 
@@ -280,7 +289,13 @@ namespace PepperDash.Core
 
         #region Constructors
 
-        //Base class constructor
+        /// <summary>
+        /// Constructor
+        /// </summary>
+        /// <param name="key"></param>
+        /// <param name="address"></param>
+        /// <param name="port"></param>
+        /// <param name="bufferSize"></param>
         public GenericSecureTcpIpClient_ForServer(string key, string address, int port, int bufferSize)
             : base(key)
         {
@@ -292,7 +307,9 @@ namespace PepperDash.Core
 
         }
 
-        //base class constructor
+        /// <summary>
+        /// Constructor for S+
+        /// </summary>
         public GenericSecureTcpIpClient_ForServer()
             : base("Uninitialized Secure Tcp Client For Server")
         {
@@ -304,7 +321,8 @@ namespace PepperDash.Core
         /// <summary>
         /// Contstructor that sets all properties by calling the initialize method with a config object. 
         /// </summary>
-        /// <param name="serverConfigObject"></param>
+        /// <param name="key"></param>
+        /// <param name="clientConfigObject"></param>
         public GenericSecureTcpIpClient_ForServer(string key, TcpClientConfigObject clientConfigObject)
             : base(key)
         {

Pepperdash Core/Pepperdash Core/Comm/GenericSecureTcpIpServer.cs

@@ -271,7 +271,9 @@ namespace PepperDash.Core
 
         List<uint> ClientReadyAfterKeyExchange = new List<uint>();
 
-        //Store the connected client indexes
+        /// <summary>
+        /// The connected client indexes
+        /// </summary>
         public List<uint> ConnectedClientsIndexes = new List<uint>();
 
         /// <summary>
@@ -360,6 +362,10 @@ namespace PepperDash.Core
             Key = key;
         }
 
+        /// <summary>
+        /// Initialze the server
+        /// </summary>
+        /// <param name="serverConfigObject"></param>
         public void Initialize(TcpServerConfigObject serverConfigObject)
         {
             try
@@ -624,6 +630,11 @@ namespace PepperDash.Core
             return received;
         }
 
+        /// <summary>
+        /// Get the IP Address for the client at the specifed index
+        /// </summary>
+        /// <param name="clientIndex"></param>
+        /// <returns></returns>
         public string GetClientIPAddress(uint clientIndex)
         {
             Debug.Console(1, this, Debug.ErrorLogLevel.Notice, "GetClientIPAddress Index: {0}", clientIndex);
@@ -681,7 +692,7 @@ namespace PepperDash.Core
         /// <summary>
         /// Secure Server Socket Status Changed Callback
         /// </summary>
-        /// <param name="mySecureTCPServer"></param>
+        /// <param name="server"></param>
         /// <param name="clientIndex"></param>
         /// <param name="serverSocketStatus"></param>
         void SecureServer_SocketStatusChange(SecureTCPServer server, uint clientIndex, SocketStatus serverSocketStatus)
@@ -729,7 +740,7 @@ namespace PepperDash.Core
         /// <summary>
         /// Secure TCP Client Connected to Secure Server Callback
         /// </summary>
-        /// <param name="mySecureTCPServer"></param>
+        /// <param name="server"></param>
         /// <param name="clientIndex"></param>
         void SecureConnectCallback(SecureTCPServer server, uint clientIndex)
         {

Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient.cs

@@ -128,10 +128,10 @@ namespace PepperDash.Core
 		/// </summary>
 		public string ClientStatusText { get { return ClientStatus.ToString(); } }
 
-        [Obsolete]
 		/// <summary>
 		/// Ushort representation of client status
 		/// </summary>
+        [Obsolete]
 		public ushort UClientStatus { get { return (ushort)ClientStatus; } }
 
 		/// <summary>
@@ -505,6 +505,9 @@ namespace PepperDash.Core
 		/// </summary>
 		public int AutoReconnectIntervalMs { get; set; }
 
+        /// <summary>
+        /// Default constructor
+        /// </summary>
 		public TcpSshPropertiesConfig()
 		{
 			BufferSize = 32768;

Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient_ForServer.cs

@@ -212,14 +212,30 @@ namespace PepperDash.Core
         CTimer RetryTimer;
 
 
+        /// <summary>
+        /// 
+        /// </summary>
         public bool HeartbeatEnabled { get; set; }
+
+        /// <summary>
+        /// 
+        /// </summary>
         public ushort UHeartbeatEnabled
         {
             get { return (ushort)(HeartbeatEnabled ? 1 : 0); }
             set { HeartbeatEnabled = value == 1; }
         }
+
+        /// <summary>
+        /// 
+        /// </summary>
         public string HeartbeatString = "heartbeat";
+
+        /// <summary>
+        /// 
+        /// </summary>
         public int HeartbeatInterval = 50000;
+
         CTimer HeartbeatSendTimer;
         CTimer HeartbeatAckTimer;
         /// <summary>
@@ -239,7 +255,13 @@ namespace PepperDash.Core
 
         #region Constructors
 
-        //Base class constructor
+        /// <summary>
+        /// Constructor
+        /// </summary>
+        /// <param name="key"></param>
+        /// <param name="address"></param>
+        /// <param name="port"></param>
+        /// <param name="bufferSize"></param>
         public GenericTcpIpClient_ForServer(string key, string address, int port, int bufferSize)
             : base(key)
         {
@@ -251,7 +273,9 @@ namespace PepperDash.Core
 
         }
 
-        //base class constructor
+        /// <summary>
+        /// Constructor for S+
+        /// </summary>
         public GenericTcpIpClient_ForServer()
             : base("Uninitialized DynamicTcpClient")
         {

Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpServer.cs

@@ -152,7 +152,12 @@ namespace PepperDash.Core
             get { return (ushort)(IsListening ? 1 : 0); }
         }
 
-        public ushort MaxClients { get; set; } // should be set by parameter in SIMPL+ in the MAIN method, Should not ever need to be configurable
+        /// <summary>
+        /// The maximum number of clients.
+        /// Should be set by parameter in SIMPL+ in the MAIN method, Should not ever need to be configurable
+        /// </summary>
+        public ushort MaxClients { get; set; }
+
         /// <summary>
         /// Number of clients currently connected.
         /// </summary>
@@ -247,7 +252,9 @@ namespace PepperDash.Core
 
         List<uint> ClientReadyAfterKeyExchange = new List<uint>();
 
-        //Store the connected client indexes
+        /// <summary>
+        /// The connected client indexes
+        /// </summary>
         public List<uint> ConnectedClientsIndexes = new List<uint>();
 
         /// <summary>
@@ -664,7 +671,7 @@ namespace PepperDash.Core
         /// <summary>
         /// Secure Server Socket Status Changed Callback
         /// </summary>
-        /// <param name="mySecureTCPServer"></param>
+        /// <param name="server"></param>
         /// <param name="clientIndex"></param>
         /// <param name="serverSocketStatus"></param>
         void TcpServer_SocketStatusChange(TCPServer server, uint clientIndex, SocketStatus serverSocketStatus)
@@ -702,7 +709,7 @@ namespace PepperDash.Core
         /// <summary>
         /// Secure TCP Client Connected to Secure Server Callback
         /// </summary>
-        /// <param name="mySecureTCPServer"></param>
+        /// <param name="server"></param>
         /// <param name="clientIndex"></param>
         void TcpConnectCallback(TCPServer server, uint clientIndex)
         {
@@ -777,7 +784,7 @@ namespace PepperDash.Core
         /// <summary>
         /// Secure Received Data Async Callback
         /// </summary>
-        /// <param name="mySecureTCPServer"></param>
+        /// <param name="myTCPServer"></param>
         /// <param name="clientIndex"></param>
         /// <param name="numberOfBytesReceived"></param>
         void TcpServerReceivedDataAsyncCallback(TCPServer myTCPServer, uint clientIndex, int numberOfBytesReceived)

Pepperdash Core/Pepperdash Core/Comm/GenericUdpServer.cs

@@ -74,10 +74,6 @@ namespace PepperDash.Core
         /// </summary>
         public string Hostname { get; set; }
 
-		/// <summary>
-		/// IP Address of the sender of the last recieved message 
-		/// </summary>
-
 
         /// <summary>
         /// Port on server
@@ -103,6 +99,9 @@ namespace PepperDash.Core
             private set;
         }
 
+        /// <summary>
+        /// Numeric value indicating 
+        /// </summary>
         public ushort UIsConnected
         {
             get { return IsConnected ? (ushort)1 : (ushort)0; }
@@ -113,6 +112,9 @@ namespace PepperDash.Core
         /// </summary>
         public int BufferSize { get; set; }
 
+        /// <summary>
+        /// The server
+        /// </summary>
         public UDPServer Server { get; private set; }
 
         /// <summary>

Pepperdash Core/Pepperdash Core/Config/PortalConfigReader.cs

@@ -173,8 +173,9 @@ namespace PepperDash.Core.Config
 		/// <summary>
 		/// Merge o2 onto o1
 		/// </summary>
-		/// <param name="a"></param>
+        /// <param name="o1"></param>
-		/// <param name="b"></param>
+        /// <param name="o2"></param>
+        /// <param name="path"></param>
 		static JObject Merge(JObject o1, JObject o2, string path)
 		{
 			foreach (var o2Prop in o2)

Pepperdash Core/Pepperdash Core/GenericRESTfulCommunications/GenericRESTfulClient.cs

@@ -65,6 +65,7 @@ namespace PepperDash.Core.GenericRESTfulCommunications
 		/// <param name="url"></param>
 		/// <param name="port"></param>
 		/// <param name="requestType"></param>
+        /// <param name="contentType"></param>
 		/// <param name="username"></param>
 		/// <param name="password"></param>
 		private void SubmitRequestHttp(string url, ushort port, ushort requestType, string contentType, string username, string password)
@@ -122,6 +123,7 @@ namespace PepperDash.Core.GenericRESTfulCommunications
 		/// <param name="url"></param>
 		/// <param name="port"></param>
 		/// <param name="requestType"></param>
+        /// <param name="contentType"></param>
 		/// <param name="username"></param>
 		/// <param name="password"></param>
 		private void SubmitRequestHttps(string url, ushort port, ushort requestType, string contentType, string username, string password)

Pepperdash Core/Pepperdash Core/JsonStandardObjects/JsonToSimplDeviceConfig.cs

@@ -141,7 +141,6 @@ namespace PepperDash.Core.JsonStandardObjects
         /// 
         /// </summary>
 		public int autoReconnectIntervalMs { get; set; }
-        ///
 
 		// convert properties for simpl
         /// <summary>
@@ -250,6 +249,9 @@ namespace PepperDash.Core.JsonStandardObjects
 	/// </summary>
 	public class RootObject
 	{
+        /// <summary>
+        /// The collection of devices
+        /// </summary>
 		public List<DeviceConfig> devices { get; set; }
 	}
 }

Pepperdash Core/Pepperdash Core/JsonToSimpl/Constants.cs

@@ -97,6 +97,17 @@ namespace PepperDash.Core.JsonToSimpl
 	/// </summary>
 	public enum SPlusType
 	{
-		Digital, Analog, String
+        /// <summary>
+        /// Digital
+        /// </summary>
+		Digital, 
+        /// <summary>
+        /// Analog
+        /// </summary>
+        Analog, 
+        /// <summary>
+        /// String
+        /// </summary>
+        String
 	}
 }

Pepperdash Core/Pepperdash Core/JsonToSimpl/JsonToSimplArrayLookupChild.cs

@@ -79,6 +79,9 @@ namespace PepperDash.Core.JsonToSimpl
 				PathSuffix == null ? "" : PathSuffix);
 		}
 
+        /// <summary>
+        /// Process all values
+        /// </summary>
 		public override void ProcessAll()
 		{
 			if (FindInArray())

Pepperdash Core/Pepperdash Core/JsonToSimpl/JsonToSimplChildObjectBase.cs

@@ -62,9 +62,17 @@ namespace PepperDash.Core.JsonToSimpl
         /// </summary>
 		protected JsonToSimplMaster Master;
 
-		// The sent-in JPaths for the various types
+        /// <summary>
-		protected Dictionary<ushort, string> BoolPaths = new Dictionary<ushort, string>();
+        /// Paths to boolean values in JSON structure
+        /// </summary>
+        protected Dictionary<ushort, string> BoolPaths = new Dictionary<ushort, string>();
+        /// <summary>
+        /// Paths to numeric values in JSON structure
+        /// </summary>
 		protected Dictionary<ushort, string> UshortPaths = new Dictionary<ushort, string>();
+        /// <summary>
+        /// Paths to string values in JSON structure
+        /// </summary>
 		protected Dictionary<ushort, string> StringPaths = new Dictionary<ushort, string>();
 
 		/// <summary>

Pepperdash Core/Pepperdash Core/JsonToSimpl/JsonToSimplFileMaster.cs

@@ -113,11 +113,20 @@ namespace PepperDash.Core.JsonToSimpl
 				return;
 			}
 		}
+
+
+        /// <summary>
+        /// Sets the debug level
+        /// </summary>
+        /// <param name="level"></param>
 		public void setDebugLevel(int level)
 		{
 			Debug.SetDebugLevel(level);
 		}
 
+        /// <summary>
+        /// Saves the values to the file
+        /// </summary>
 		public override void Save()
 		{
 			// this code is duplicated in the other masters!!!!!!!!!!!!!

Pepperdash Core/Pepperdash Core/Logging/Debug.cs

@@ -561,9 +561,27 @@ namespace PepperDash.Core
             Directory.Delete(@"\nvram\debugSettings");
         }
 
+        /// <summary>
+        /// Error level to for message to be logged at
+        /// </summary>
         public enum ErrorLogLevel
         {
-            Error, Warning, Notice, None
+            /// <summary>
+            /// Error
+            /// </summary>
+            Error, 
+            /// <summary>
+            /// Warning
+            /// </summary>
+            Warning, 
+            /// <summary>
+            /// Notice
+            /// </summary>
+            Notice, 
+            /// <summary>
+            /// None
+            /// </summary>
+            None,
         }
     }
 }

Pepperdash Core/Pepperdash Core/Logging/DebugContext.cs

@@ -271,8 +271,14 @@ namespace PepperDash.Core
         }
     }
 
+    /// <summary>
+    /// 
+    /// </summary>
     public class DebugContextSaveData
     {
+        /// <summary>
+        /// 
+        /// </summary>
         public int Level { get; set; }
     }
 }

Pepperdash Core/Pepperdash Core/PasswordManagement/PasswordManager.cs

@@ -196,7 +196,7 @@ namespace PepperDash.Core.PasswordManagement
 		/// <summary>
 		/// Protected ushort change event handler
 		/// </summary>
-		/// <param name="state"></param>
+        /// <param name="value"></param>
 		/// <param name="index"></param>
 		/// <param name="type"></param>
 		protected void OnUshrtChange(ushort value, ushort index, ushort type)

Pepperdash Core/Pepperdash Core/SystemInfo/EventArgs and Constants.cs

@@ -143,7 +143,7 @@ namespace PepperDash.Core.SystemInfo
 		/// <summary>
 		/// Constructor overload
 		/// </summary>
-		/// <param name="Ethernet"></param>
+        /// <param name="ethernet"></param>
 		/// <param name="type"></param>
 		public EthernetChangeEventArgs(EthernetInfo ethernet, ushort type)
 		{
@@ -154,8 +154,9 @@ namespace PepperDash.Core.SystemInfo
 		/// <summary>
 		/// Constructor overload
 		/// </summary>
-		/// <param name="Ethernet"></param>
+        /// <param name="ethernet"></param>
 		/// <param name="type"></param>
+        /// <param name="index"></param>
 		public EthernetChangeEventArgs(EthernetInfo ethernet, ushort type, ushort index)
 		{
 			Adapter = ethernet;
@@ -239,7 +240,7 @@ namespace PepperDash.Core.SystemInfo
 		/// <summary>
 		/// Constructor overload
 		/// </summary>
-		/// <param name="Program"></param>
+        /// <param name="program"></param>
 		/// <param name="type"></param>
 		public ProgramChangeEventArgs(ProgramInfo program, ushort type)
 		{
@@ -250,8 +251,9 @@ namespace PepperDash.Core.SystemInfo
 		/// <summary>
 		/// Constructor overload
 		/// </summary>
-		/// <param name="Program"></param>
+        /// <param name="program"></param>
 		/// <param name="type"></param>
+        /// <param name="index"></param>
 		public ProgramChangeEventArgs(ProgramInfo program, ushort type, ushort index)
 		{
 			Program = program;

Pepperdash Core/Pepperdash Core/SystemInfo/SystemInfoToSimpl.cs

@@ -327,10 +327,10 @@ namespace PepperDash.Core.SystemInfo
 		/// <summary>
 		/// private method to parse console messages
 		/// </summary>
-		/// <param name="response"></param>
+        /// <param name="data"></param>
 		/// <param name="line"></param>
-		/// <param name="start"></param>
+        /// <param name="dataStart"></param>
-		/// <param name="end"></param>
+        /// <param name="dataEnd"></param>
 		/// <returns></returns>
 		private string ParseConsoleResponse(string data, string line, string dataStart, string dataEnd)
 		{

Pepperdash Core/Pepperdash Core/WebApi/Presets/Preset.cs

@@ -66,10 +66,13 @@ namespace PepperDash.Core.WebApi.Presets
         public bool LookupSuccess { get; private set; }
         
         /// <summary>
-        /// S+ helper for stupid S+
+        /// S+ helper
         /// </summary>
         public ushort ULookupSuccess { get { return (ushort)(LookupSuccess ? 1 : 0); } }
 
+        /// <summary>
+        /// The preset
+        /// </summary>
         public Preset Preset { get; private set; }
 
 		/// <summary>