feat: enhance documentation for IDtmfDecode interface and DtmfReceivedEventArgs class

This commit is contained in:
Neil Dorin 2026-07-23 08:49:11 -06:00
parent dac5325ecf
commit a782651e4d

View file

@ -1,5 +1,8 @@
namespace PepperDash.Essentials.Devices.Common.AudioCodec; namespace PepperDash.Essentials.Devices.Common.AudioCodec;
/// <summary>
/// Interface for devices that can decode DTMF digits
/// </summary>
public interface IDtmfDecode public interface IDtmfDecode
{ {
/// <summary> /// <summary>
@ -8,10 +11,20 @@ public interface IDtmfDecode
event EventHandler<DtmfReceivedEventArgs> DtmfReceived; event EventHandler<DtmfReceivedEventArgs> DtmfReceived;
} }
/// <summary>
/// Event args for DTMF received event
/// </summary>
public class DtmfReceivedEventArgs : EventArgs public class DtmfReceivedEventArgs : EventArgs
{ {
/// <summary>
/// The DTMF digit that was received
/// </summary>
public string Digit { get; private set; } public string Digit { get; private set; }
/// <summary>
/// Event args for DTMF received event
/// </summary>
/// <param name="digit">The DTMF digit that was received</param>
public DtmfReceivedEventArgs(string digit) public DtmfReceivedEventArgs(string digit)
{ {
Digit = digit; Digit = digit;