docs: complete XML documentation for all projects with inheritdoc tags

Co-authored-by: andrew-welker <1765622+andrew-welker@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2025-07-22 15:53:01 +00:00
parent 260677a37f
commit 7987eb8f9b
485 changed files with 8099 additions and 2490 deletions

View File

@@ -15,13 +15,15 @@ namespace PepperDash.Essentials.Devices.Common.AudioCodec
public event EventHandler<CodecCallStatusItemChangeEventArgs> CallStatusChange;
/// <summary>
/// Gets or sets the CodecInfo
/// </summary>
public AudioCodecInfo CodecInfo { get; protected set; }
#region IUsageTracking Members
/// <summary>
/// This object can be added by outside users of this class to provide usage tracking
/// for various services
/// Gets or sets the UsageTracker
/// </summary>
public UsageTracking UsageTracker { get; set; }
@@ -45,6 +47,9 @@ namespace PepperDash.Essentials.Devices.Common.AudioCodec
}
// In most cases only a single call can be active
/// <summary>
/// Gets or sets the ActiveCalls
/// </summary>
public List<CodecActiveCallItem> ActiveCalls { get; set; }
public AudioCodecBase(string key, string name)

View File

@@ -12,6 +12,9 @@ using Serilog.Events;
namespace PepperDash.Essentials.Devices.Common.AudioCodec
{
/// <summary>
/// Represents a MockAC
/// </summary>
public class MockAC : AudioCodecBase
{
public MockAC(string key, string name, MockAcPropertiesConfig props)
@@ -22,6 +25,10 @@ namespace PepperDash.Essentials.Devices.Common.AudioCodec
CodecInfo.PhoneNumber = props.PhoneNumber;
}
/// <summary>
/// Dial method
/// </summary>
/// <inheritdoc />
public override void Dial(string number)
{
if (!IsInCall)
@@ -47,6 +54,10 @@ namespace PepperDash.Essentials.Devices.Common.AudioCodec
}
}
/// <summary>
/// EndCall method
/// </summary>
/// <inheritdoc />
public override void EndCall(CodecActiveCallItem call)
{
Debug.LogMessage(LogEventLevel.Debug, this, "EndCall");
@@ -54,6 +65,10 @@ namespace PepperDash.Essentials.Devices.Common.AudioCodec
SetNewCallStatusAndFireCallStatusChange(eCodecCallStatus.Disconnected, call);
}
/// <summary>
/// EndAllCalls method
/// </summary>
/// <inheritdoc />
public override void EndAllCalls()
{
Debug.LogMessage(LogEventLevel.Debug, this, "EndAllCalls");
@@ -65,12 +80,19 @@ namespace PepperDash.Essentials.Devices.Common.AudioCodec
}
}
/// <summary>
/// AcceptCall method
/// </summary>
/// <inheritdoc />
public override void AcceptCall(CodecActiveCallItem call)
{
Debug.LogMessage(LogEventLevel.Debug, this, "AcceptCall");
SetNewCallStatusAndFireCallStatusChange(eCodecCallStatus.Connecting, call);
}
/// <summary>
/// RejectCall method
/// </summary>
public override void RejectCall(CodecActiveCallItem call)
{
Debug.LogMessage(LogEventLevel.Debug, this, "RejectCall");
@@ -78,6 +100,10 @@ namespace PepperDash.Essentials.Devices.Common.AudioCodec
SetNewCallStatusAndFireCallStatusChange(eCodecCallStatus.Disconnected, call);
}
/// <summary>
/// SendDtmf method
/// </summary>
/// <inheritdoc />
public override void SendDtmf(string s)
{
Debug.LogMessage(LogEventLevel.Debug, this, "BEEP BOOP SendDTMF: {0}", s);
@@ -87,6 +113,9 @@ namespace PepperDash.Essentials.Devices.Common.AudioCodec
///
/// </summary>
/// <param name="url"></param>
/// <summary>
/// TestIncomingAudioCall method
/// </summary>
public void TestIncomingAudioCall(string number)
{
Debug.LogMessage(LogEventLevel.Debug, this, "TestIncomingAudioCall from {0}", number);
@@ -97,6 +126,9 @@ namespace PepperDash.Essentials.Devices.Common.AudioCodec
}
/// <summary>
/// Represents a MockAudioCodecInfo
/// </summary>
public class MockAudioCodecInfo : AudioCodecInfo
{
string _phoneNumber;
@@ -114,6 +146,9 @@ namespace PepperDash.Essentials.Devices.Common.AudioCodec
}
}
/// <summary>
/// Represents a MockACFactory
/// </summary>
public class MockACFactory : EssentialsDeviceFactory<MockAC>
{
public MockACFactory()
@@ -121,6 +156,10 @@ namespace PepperDash.Essentials.Devices.Common.AudioCodec
TypeNames = new List<string>() { "mockac" };
}
/// <summary>
/// BuildDevice method
/// </summary>
/// <inheritdoc />
public override EssentialsDevice BuildDevice(DeviceConfig dc)
{
Debug.LogMessage(LogEventLevel.Debug, "Factory Attempting to create new MockAc Device");

View File

@@ -10,9 +10,15 @@ using Newtonsoft.Json;
namespace PepperDash.Essentials.Devices.Common.AudioCodec
{
/// <summary>
/// Represents a MockAcPropertiesConfig
/// </summary>
public class MockAcPropertiesConfig
{
[JsonProperty("phoneNumber")]
/// <summary>
/// Gets or sets the PhoneNumber
/// </summary>
public string PhoneNumber { get; set; }
}
}