mirror of
https://github.com/PepperDash/Essentials.git
synced 2026-01-11 19:44:52 +00:00
docs: fix duplicate and malformed XML documentation tags
Co-authored-by: andrew-welker <1765622+andrew-welker@users.noreply.github.com>
This commit is contained in:
@@ -36,7 +36,7 @@ namespace PepperDash.Core
|
|||||||
/// </summary>
|
/// </summary>
|
||||||
public event EventHandler<GenericSocketStatusChageEventArgs> ConnectionChange;
|
public event EventHandler<GenericSocketStatusChageEventArgs> ConnectionChange;
|
||||||
|
|
||||||
///// <summary>
|
/// <summary>
|
||||||
/////
|
/////
|
||||||
///// </summary>
|
///// </summary>
|
||||||
//public event GenericSocketStatusChangeEventDelegate SocketStatusChange;
|
//public event GenericSocketStatusChangeEventDelegate SocketStatusChange;
|
||||||
@@ -79,7 +79,7 @@ namespace PepperDash.Core
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
///
|
/// Socket status change event
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public SocketStatus ClientStatus
|
public SocketStatus ClientStatus
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -24,14 +24,14 @@ namespace PepperDash.Core
|
|||||||
/// </summary>
|
/// </summary>
|
||||||
public bool Enabled { get; protected set; }
|
public bool Enabled { get; protected set; }
|
||||||
|
|
||||||
///// <summary>
|
/// <summary>
|
||||||
///// A place to store reference to the original config object, if any. These values should
|
/// 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.
|
/// NOT be used as properties on the device as they are all publicly-settable values.
|
||||||
///// </summary>
|
/// </summary>
|
||||||
//public DeviceConfig Config { get; private set; }
|
//public DeviceConfig Config { get; private set; }
|
||||||
///// <summary>
|
/// <summary>
|
||||||
///// Helper method to check if Config exists
|
/// Helper method to check if Config exists
|
||||||
///// </summary>
|
/// </summary>
|
||||||
//public bool HasConfig { get { return Config != null; } }
|
//public bool HasConfig { get { return Config != null; } }
|
||||||
|
|
||||||
List<Action> _PreActivationActions;
|
List<Action> _PreActivationActions;
|
||||||
|
|||||||
@@ -19,9 +19,9 @@ namespace PepperDash.Core
|
|||||||
/// </summary>
|
/// </summary>
|
||||||
public string Key { get; private set; }
|
public string Key { get; private set; }
|
||||||
|
|
||||||
///// <summary>
|
/// <summary>
|
||||||
///// The name of the file containing the current debug settings.
|
/// The name of the file containing the current debug settings.
|
||||||
///// </summary>
|
/// </summary>
|
||||||
//string FileName = string.Format(@"\nvram\debug\app{0}Debug.json", InitialParametersClass.ApplicationNumber);
|
//string FileName = string.Format(@"\nvram\debug\app{0}Debug.json", InitialParametersClass.ApplicationNumber);
|
||||||
|
|
||||||
DebugContextSaveData SaveData;
|
DebugContextSaveData SaveData;
|
||||||
|
|||||||
@@ -80,9 +80,9 @@ namespace PepperDash.Essentials.Core
|
|||||||
CrestronInvoke.BeginInvoke(o => FireUpdate());
|
CrestronInvoke.BeginInvoke(o => FireUpdate());
|
||||||
}
|
}
|
||||||
|
|
||||||
///// <summary>
|
/// <summary>
|
||||||
///// Helper method that fires event. Use this intstead of calling OutputChange
|
/// Helper method that fires event. Use this intstead of calling OutputChange
|
||||||
///// </summary>
|
/// </summary>
|
||||||
//protected void OnOutputChange()
|
//protected void OnOutputChange()
|
||||||
//{
|
//{
|
||||||
// if (OutputChange != null) OutputChange(this, EventArgs.Empty);
|
// if (OutputChange != null) OutputChange(this, EventArgs.Empty);
|
||||||
|
|||||||
@@ -303,22 +303,22 @@ namespace PepperDash.Essentials.Core
|
|||||||
PrintJoinMapInfo();
|
PrintJoinMapInfo();
|
||||||
}
|
}
|
||||||
|
|
||||||
///// <summary>
|
/// <summary>
|
||||||
///// Returns the join number for the join with the specified key
|
/// Returns the join number for the join with the specified key
|
||||||
///// </summary>
|
/// </summary>
|
||||||
///// <param name="key"></param>
|
/// <param name="key"></param>
|
||||||
///// <returns></returns>
|
/// <returns></returns>
|
||||||
//public uint GetJoinForKey(string key)
|
//public uint GetJoinForKey(string key)
|
||||||
//{
|
//{
|
||||||
// return Joins.ContainsKey(key) ? Joins[key].JoinNumber : 0;
|
// return Joins.ContainsKey(key) ? Joins[key].JoinNumber : 0;
|
||||||
//}
|
//}
|
||||||
|
|
||||||
|
|
||||||
///// <summary>
|
/// <summary>
|
||||||
///// Returns the join span for the join with the specified key
|
/// Returns the join span for the join with the specified key
|
||||||
///// </summary>
|
/// </summary>
|
||||||
///// <param name="key"></param>
|
/// <param name="key"></param>
|
||||||
///// <returns></returns>
|
/// <returns></returns>
|
||||||
//public uint GetJoinSpanForKey(string key)
|
//public uint GetJoinSpanForKey(string key)
|
||||||
//{
|
//{
|
||||||
// return Joins.ContainsKey(key) ? Joins[key].JoinSpan : 0;
|
// return Joins.ContainsKey(key) ? Joins[key].JoinSpan : 0;
|
||||||
|
|||||||
@@ -95,6 +95,9 @@ namespace PepperDash.Essentials.Core
|
|||||||
/// Releases the usage tracking for the route and optionally clears the route on the switching devices.
|
/// Releases the usage tracking for the route and optionally clears the route on the switching devices.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="clearRoute">If true, attempts to clear the route on the switching devices (e.g., set input to null/0).</param>
|
/// <param name="clearRoute">If true, attempts to clear the route on the switching devices (e.g., set input to null/0).</param>
|
||||||
|
/// <summary>
|
||||||
|
/// ReleaseRoutes method
|
||||||
|
/// </summary>
|
||||||
public void ReleaseRoutes(bool clearRoute = false)
|
public void ReleaseRoutes(bool clearRoute = false)
|
||||||
{
|
{
|
||||||
foreach (var route in Routes.Where(r => r.SwitchingDevice is IRouting))
|
foreach (var route in Routes.Where(r => r.SwitchingDevice is IRouting))
|
||||||
@@ -146,7 +149,10 @@ namespace PepperDash.Essentials.Core
|
|||||||
}
|
}
|
||||||
|
|
||||||
/*/// <summary>
|
/*/// <summary>
|
||||||
/// Represents a collection of individual route steps between Source and Destination for a specific signal type.
|
/// Represents an collection of individual route steps between Source and Destination
|
||||||
|
/// </summary>
|
||||||
|
/// <summary>
|
||||||
|
/// Represents a RouteDescriptor
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public class RouteDescriptor<TInputSelector, TOutputSelector>
|
public class RouteDescriptor<TInputSelector, TOutputSelector>
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -83,7 +83,10 @@ namespace PepperDash.Essentials.Core
|
|||||||
}
|
}
|
||||||
|
|
||||||
/*/// <summary>
|
/*/// <summary>
|
||||||
/// Represents a RouteDescriptorCollection - typically the static DefaultCollection is used
|
/// A collection of RouteDescriptors - typically the static DefaultCollection is used
|
||||||
|
/// </summary>
|
||||||
|
/// <summary>
|
||||||
|
/// Represents a RouteDescriptorCollection
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public class RouteDescriptorCollection<TInputSelector, TOutputSelector>
|
public class RouteDescriptorCollection<TInputSelector, TOutputSelector>
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -53,20 +53,23 @@
|
|||||||
}
|
}
|
||||||
|
|
||||||
/*/// <summary>
|
/*/// <summary>
|
||||||
/// Represents a RouteSwitchDescriptor with generic input and output selectors.
|
/// Represents an individual link for a route
|
||||||
|
/// </summary>
|
||||||
|
/// <summary>
|
||||||
|
/// Represents a RouteSwitchDescriptor
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public class RouteSwitchDescriptor<TInputSelector, TOutputSelector>
|
public class RouteSwitchDescriptor<TInputSelector, TOutputSelector>
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets the SwitchingDevice.
|
/// Gets or sets the SwitchingDevice
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public IRoutingInputs<TInputSelector> SwitchingDevice { get { return InputPort.ParentDevice; } }
|
public IRoutingInputs<TInputSelector> SwitchingDevice { get { return InputPort.ParentDevice; } }
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets the OutputPort.
|
/// Gets or sets the OutputPort
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public RoutingOutputPort<TOutputSelector> OutputPort { get; set; }
|
public RoutingOutputPort<TOutputSelector> OutputPort { get; set; }
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets the InputPort.
|
/// Gets or sets the InputPort
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public RoutingInputPort<TInputSelector> InputPort { get; set; }
|
public RoutingInputPort<TInputSelector> InputPort { get; set; }
|
||||||
|
|
||||||
|
|||||||
@@ -15,9 +15,9 @@ using Serilog.Events;
|
|||||||
namespace PepperDash.Essentials.Core
|
namespace PepperDash.Essentials.Core
|
||||||
{
|
{
|
||||||
////*****************************************************************************
|
////*****************************************************************************
|
||||||
///// <summary>
|
/// <summary>
|
||||||
///// Base class for all subpage reference list controllers
|
/// Base class for all subpage reference list controllers
|
||||||
///// </summary>
|
/// </summary>
|
||||||
//public class SubpageReferenceListController
|
//public class SubpageReferenceListController
|
||||||
//{
|
//{
|
||||||
// public SubpageReferenceList TheList { get; protected set; }
|
// public SubpageReferenceList TheList { get; protected set; }
|
||||||
|
|||||||
@@ -94,9 +94,9 @@ namespace PepperDash.Essentials.Core
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
///// <summary>
|
/// <summary>
|
||||||
///// Wraps up the common video statuses exposed on a video input port
|
/// Wraps up the common video statuses exposed on a video input port
|
||||||
///// </summary>
|
/// </summary>
|
||||||
//public class BasicVideoStatus : IBasicVideoStatus
|
//public class BasicVideoStatus : IBasicVideoStatus
|
||||||
//{
|
//{
|
||||||
// public event VideoStatusChangeHandler VideoStatusChange;
|
// public event VideoStatusChangeHandler VideoStatusChange;
|
||||||
|
|||||||
@@ -15,9 +15,9 @@ namespace PepperDash.Essentials.Devices.Common.AudioCodec
|
|||||||
{
|
{
|
||||||
AudioCodecBase AudioCodec { get; }
|
AudioCodecBase AudioCodec { get; }
|
||||||
|
|
||||||
///// <summary>
|
/// <summary>
|
||||||
///// Make this more specific
|
/// Make this more specific
|
||||||
///// </summary>
|
/// </summary>
|
||||||
//List<PepperDash.Essentials.Devices.Common.Codec.CodecActiveCallItem> ActiveCalls { get; }
|
//List<PepperDash.Essentials.Devices.Common.Codec.CodecActiveCallItem> ActiveCalls { get; }
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -15,9 +15,9 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec
|
|||||||
{
|
{
|
||||||
VideoCodecBase VideoCodec { get; }
|
VideoCodecBase VideoCodec { get; }
|
||||||
|
|
||||||
///// <summary>
|
/// <summary>
|
||||||
///// Make this more specific
|
/// Make this more specific
|
||||||
///// </summary>
|
/// </summary>
|
||||||
//List<PepperDash.Essentials.Devices.Common.Codec.CodecActiveCallItem> ActiveCalls { get; }
|
//List<PepperDash.Essentials.Devices.Common.Codec.CodecActiveCallItem> ActiveCalls { get; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
|
|||||||
Reference in New Issue
Block a user