docs: XML comments for Devices.Common

src/PepperDash.Essentials.Devices.Common/AudioCodec/AudioCodecBase.cs

@@ -1,18 +1,20 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using System.Text;
-using Crestron.SimplSharp;
-
-using PepperDash.Core;
 using PepperDash.Essentials.Core;
 using PepperDash.Essentials.Devices.Common.Codec;
 
 namespace PepperDash.Essentials.Devices.Common.AudioCodec
 {
+    /// <summary>
+    /// Abstract base class for audio codec devices
+    /// </summary>
     public abstract class AudioCodecBase : EssentialsDevice, IHasDialer, IUsageTracking, IAudioCodecInfo
     {
 
+        /// <summary>
+        /// Event fired when call status changes
+        /// </summary>
         public event EventHandler<CodecCallStatusItemChangeEventArgs> CallStatusChange;
 
         /// <summary>
@@ -52,6 +54,11 @@ namespace PepperDash.Essentials.Devices.Common.AudioCodec
         /// </summary>
         public List<CodecActiveCallItem> ActiveCalls { get; set; }
 
+        /// <summary>
+        /// Constructor for AudioCodecBase
+        /// </summary>
+        /// <param name="key">Device key</param>
+        /// <param name="name">Device name</param>
         public AudioCodecBase(string key, string name)
             : base(key, name)
         {
@@ -70,11 +77,9 @@ namespace PepperDash.Essentials.Devices.Common.AudioCodec
         }
 
         /// <summary>
-        /// 
+        /// Handles call status change events
         /// </summary>
-        /// <param name="previousStatus"></param>
-        /// <param name="newStatus"></param>
-        /// <param name="item"></param>
+        /// <param name="item">The call item that changed status</param>
         protected void OnCallStatusChange(CodecActiveCallItem item)
         {
             var handler = CallStatusChange;
@@ -92,16 +97,22 @@ namespace PepperDash.Essentials.Devices.Common.AudioCodec
 
         #region IHasDialer Members
 
+        /// <inheritdoc />
         public abstract void Dial(string number);
 
+        /// <inheritdoc />
         public abstract void EndCall(CodecActiveCallItem activeCall);
 
+        /// <inheritdoc />
         public abstract void EndAllCalls();
 
+        /// <inheritdoc />
         public abstract void AcceptCall(CodecActiveCallItem item);
 
+        /// <inheritdoc />
         public abstract void RejectCall(CodecActiveCallItem item);
 
+        /// <inheritdoc />
         public abstract void SendDtmf(string digit);
 
         #endregion

src/PepperDash.Essentials.Devices.Common/AudioCodec/Interfaces/IAudioCodecInfo.cs

@@ -1,16 +1,13 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using Crestron.SimplSharp;
-
-namespace PepperDash.Essentials.Devices.Common.AudioCodec
+namespace PepperDash.Essentials.Devices.Common.AudioCodec
 {
     /// <summary>
     /// Implements a common set of data about a codec
     /// </summary>
     public interface IAudioCodecInfo
     {
+        /// <summary>
+        /// Gets the codec information
+        /// </summary>
         AudioCodecInfo CodecInfo { get; }
     }
 
@@ -19,6 +16,9 @@ namespace PepperDash.Essentials.Devices.Common.AudioCodec
     /// </summary>
     public abstract class AudioCodecInfo
     {
+        /// <summary>
+        /// Gets or sets the phone number
+        /// </summary>
         public abstract string PhoneNumber { get; set; }
     }
 }

src/PepperDash.Essentials.Devices.Common/AudioCodec/Interfaces/IHasAudioCodec.cs

@@ -1,23 +1,17 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using Crestron.SimplSharp;
-
-using PepperDash.Essentials.Core;
+using PepperDash.Essentials.Core;
 
 namespace PepperDash.Essentials.Devices.Common.AudioCodec
 {
     /// <summary>
     /// For rooms that have audio codec
     /// </summary>
-    public interface IHasAudioCodec:IHasInCallFeedback
+    public interface IHasAudioCodec : IHasInCallFeedback
     {
+        /// <summary>
+        /// Gets the audio codec device
+        /// </summary>
         AudioCodecBase AudioCodec { get; }
 
-        /// <summary>
-        /// Make this more specific
-        /// </summary>
         //List<PepperDash.Essentials.Devices.Common.Codec.CodecActiveCallItem> ActiveCalls { get; }
     }
 }

src/PepperDash.Essentials.Devices.Common/AudioCodec/MockAC/MockAC.cs

@@ -1,8 +1,4 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using Crestron.SimplSharp;
+using System.Collections.Generic;
 
 using PepperDash.Core;
 using PepperDash.Essentials.Core;
@@ -17,6 +13,12 @@ namespace PepperDash.Essentials.Devices.Common.AudioCodec
     /// </summary>
     public class MockAC : AudioCodecBase
     {
+        /// <summary>
+        /// Constructor for MockAC
+        /// </summary>
+        /// <param name="key">Device key</param>
+        /// <param name="name">Device name</param>
+        /// <param name="props">MockAC properties configuration</param>
         public MockAC(string key, string name, MockAcPropertiesConfig props)
             : base(key, name)
         {
@@ -109,13 +111,10 @@ namespace PepperDash.Essentials.Devices.Common.AudioCodec
             Debug.LogMessage(LogEventLevel.Debug, this, "BEEP BOOP SendDTMF: {0}", s);
         }
 
-        /// <summary>
-        /// 
-        /// </summary>
-        /// <param name="url"></param>
         /// <summary>
         /// TestIncomingAudioCall method
         /// </summary>
+        /// <param name="number">Phone number to call from</param>
         public void TestIncomingAudioCall(string number)
         {
             Debug.LogMessage(LogEventLevel.Debug, this, "TestIncomingAudioCall from {0}", number);
@@ -133,6 +132,7 @@ namespace PepperDash.Essentials.Devices.Common.AudioCodec
     {
         string _phoneNumber;
 
+        /// <inheritdoc />
         public override string PhoneNumber
         {
             get
@@ -151,6 +151,9 @@ namespace PepperDash.Essentials.Devices.Common.AudioCodec
     /// </summary>
     public class MockACFactory : EssentialsDeviceFactory<MockAC>
     {
+        /// <summary>
+        /// Constructor for MockACFactory
+        /// </summary>
         public MockACFactory()
         {
             TypeNames = new List<string>() { "mockac" };

src/PepperDash.Essentials.Devices.Common/AudioCodec/MockAC/MockAcPropertiesConfig.cs

@@ -1,12 +1,4 @@
-
-
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using Crestron.SimplSharp;
-
-using Newtonsoft.Json;
+using Newtonsoft.Json;
 
 namespace PepperDash.Essentials.Devices.Common.AudioCodec
 {
@@ -15,10 +7,10 @@ namespace PepperDash.Essentials.Devices.Common.AudioCodec
     /// </summary>
     public class MockAcPropertiesConfig
     {
-        [JsonProperty("phoneNumber")]
         /// <summary>
         /// Gets or sets the PhoneNumber
         /// </summary>
+        [JsonProperty("phoneNumber")]
         public string PhoneNumber { get; set; }
     }
 }