mirror of
https://github.com/PepperDash/Essentials.git
synced 2026-01-27 19:34:51 +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:
@@ -80,9 +80,9 @@ namespace PepperDash.Essentials.Core
|
||||
CrestronInvoke.BeginInvoke(o => FireUpdate());
|
||||
}
|
||||
|
||||
///// <summary>
|
||||
///// Helper method that fires event. Use this intstead of calling OutputChange
|
||||
///// </summary>
|
||||
/// <summary>
|
||||
/// Helper method that fires event. Use this intstead of calling OutputChange
|
||||
/// </summary>
|
||||
//protected void OnOutputChange()
|
||||
//{
|
||||
// if (OutputChange != null) OutputChange(this, EventArgs.Empty);
|
||||
|
||||
@@ -303,22 +303,22 @@ namespace PepperDash.Essentials.Core
|
||||
PrintJoinMapInfo();
|
||||
}
|
||||
|
||||
///// <summary>
|
||||
///// Returns the join number for the join with the specified key
|
||||
///// </summary>
|
||||
///// <param name="key"></param>
|
||||
///// <returns></returns>
|
||||
/// <summary>
|
||||
/// Returns the join number for the join with the specified key
|
||||
/// </summary>
|
||||
/// <param name="key"></param>
|
||||
/// <returns></returns>
|
||||
//public uint GetJoinForKey(string key)
|
||||
//{
|
||||
// return Joins.ContainsKey(key) ? Joins[key].JoinNumber : 0;
|
||||
//}
|
||||
|
||||
|
||||
///// <summary>
|
||||
///// Returns the join span for the join with the specified key
|
||||
///// </summary>
|
||||
///// <param name="key"></param>
|
||||
///// <returns></returns>
|
||||
/// <summary>
|
||||
/// Returns the join span for the join with the specified key
|
||||
/// </summary>
|
||||
/// <param name="key"></param>
|
||||
/// <returns></returns>
|
||||
//public uint GetJoinSpanForKey(string key)
|
||||
//{
|
||||
// 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.
|
||||
/// </summary>
|
||||
/// <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)
|
||||
{
|
||||
foreach (var route in Routes.Where(r => r.SwitchingDevice is IRouting))
|
||||
@@ -146,7 +149,10 @@ namespace PepperDash.Essentials.Core
|
||||
}
|
||||
|
||||
/*/// <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>
|
||||
public class RouteDescriptor<TInputSelector, TOutputSelector>
|
||||
{
|
||||
|
||||
@@ -83,7 +83,10 @@ namespace PepperDash.Essentials.Core
|
||||
}
|
||||
|
||||
/*/// <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>
|
||||
public class RouteDescriptorCollection<TInputSelector, TOutputSelector>
|
||||
{
|
||||
|
||||
@@ -53,20 +53,23 @@
|
||||
}
|
||||
|
||||
/*/// <summary>
|
||||
/// Represents a RouteSwitchDescriptor with generic input and output selectors.
|
||||
/// Represents an individual link for a route
|
||||
/// </summary>
|
||||
/// <summary>
|
||||
/// Represents a RouteSwitchDescriptor
|
||||
/// </summary>
|
||||
public class RouteSwitchDescriptor<TInputSelector, TOutputSelector>
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets or sets the SwitchingDevice.
|
||||
/// Gets or sets the SwitchingDevice
|
||||
/// </summary>
|
||||
public IRoutingInputs<TInputSelector> SwitchingDevice { get { return InputPort.ParentDevice; } }
|
||||
/// <summary>
|
||||
/// Gets or sets the OutputPort.
|
||||
/// Gets or sets the OutputPort
|
||||
/// </summary>
|
||||
public RoutingOutputPort<TOutputSelector> OutputPort { get; set; }
|
||||
/// <summary>
|
||||
/// Gets or sets the InputPort.
|
||||
/// Gets or sets the InputPort
|
||||
/// </summary>
|
||||
public RoutingInputPort<TInputSelector> InputPort { get; set; }
|
||||
|
||||
|
||||
@@ -15,9 +15,9 @@ using Serilog.Events;
|
||||
namespace PepperDash.Essentials.Core
|
||||
{
|
||||
////*****************************************************************************
|
||||
///// <summary>
|
||||
///// Base class for all subpage reference list controllers
|
||||
///// </summary>
|
||||
/// <summary>
|
||||
/// Base class for all subpage reference list controllers
|
||||
/// </summary>
|
||||
//public class SubpageReferenceListController
|
||||
//{
|
||||
// public SubpageReferenceList TheList { get; protected set; }
|
||||
|
||||
@@ -94,9 +94,9 @@ namespace PepperDash.Essentials.Core
|
||||
}
|
||||
}
|
||||
|
||||
///// <summary>
|
||||
///// Wraps up the common video statuses exposed on a video input port
|
||||
///// </summary>
|
||||
/// <summary>
|
||||
/// Wraps up the common video statuses exposed on a video input port
|
||||
/// </summary>
|
||||
//public class BasicVideoStatus : IBasicVideoStatus
|
||||
//{
|
||||
// public event VideoStatusChangeHandler VideoStatusChange;
|
||||
|
||||
Reference in New Issue
Block a user