docs: apply suggestions from copilot

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
Andrew Welker
2025-07-23 09:08:10 -05:00
committed by GitHub
parent 80da4ad98f
commit b12cdbc75c
6 changed files with 14 additions and 15 deletions

View File

@@ -304,14 +304,10 @@ namespace PepperDash.Essentials.Core
}
/// <summary>
/// Returns the join number for the join with the specified key
/// Returns the join span 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>

View File

@@ -95,9 +95,8 @@ 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))
@@ -138,9 +137,9 @@ namespace PepperDash.Essentials.Core
/// Returns a string representation of the route descriptor, including source, destination, and individual route steps.
/// </summary>
/// <returns>A string describing the route.</returns>
/// <summary>
/// ToString method
/// </summary>
public override string ToString()
{
var routesText = Routes.Select(r => r.ToString()).ToArray();

View File

@@ -64,8 +64,11 @@ namespace PepperDash.Essentials.Core
}
/// <summary>
/// RemoveRouteDescriptor method
/// Removes a RouteDescriptor from the collection based on the specified destination and input port key.
/// </summary>
/// <param name="destination">The destination for which the route descriptor is to be removed.</param>
/// <param name="inputPortKey">The key of the input port associated with the route descriptor. If empty, the method will attempt to remove a descriptor based solely on the destination.</param>
/// <returns>The removed RouteDescriptor object if a matching descriptor was found; otherwise, null.</returns>
public RouteDescriptor RemoveRouteDescriptor(IRoutingInputs destination, string inputPortKey = "")
{
Debug.LogMessage(LogEventLevel.Information, "Removing route descriptor for '{destination}':'{inputPortKey}'", destination.Key ?? null, string.IsNullOrEmpty(inputPortKey) ? "auto" : inputPortKey);

View File

@@ -5,7 +5,7 @@ using System.Linq;
namespace PepperDash.Essentials.Core
{
/// <summary>
/// Represents a RoutingPortCollection
/// Represents a RoutingPortCollection, which is essentially a List with an indexer for case-insensitive lookup of ports by their key names.
/// </summary>
public class RoutingPortCollection<T> : List<T> where T: RoutingPort
{

View File

@@ -128,7 +128,8 @@ namespace PepperDash.Essentials.Core
//********************************************************************************
/// <summary>
/// Represents a TieLineCollection
/// Represents a collection of <see cref="TieLine"/> objects, which define signal paths for routing algorithms.
/// This class provides functionality for managing tie lines and includes a singleton instance for global access.
/// </summary>
public class TieLineCollection : List<TieLine>
{

View File

@@ -29,7 +29,7 @@ namespace PepperDash.Essentials.Core.Config
public string SourceCard { get; set; }
/// <summary>
/// Gets or sets the SourcePort
/// The key of the source output port, used for routing configurations.
/// </summary>
public string SourcePort { get; set; }