diff --git a/src/PepperDash.Essentials.Core/JoinMaps/JoinMapBase.cs b/src/PepperDash.Essentials.Core/JoinMaps/JoinMapBase.cs index 9fca8e12..01f71098 100644 --- a/src/PepperDash.Essentials.Core/JoinMaps/JoinMapBase.cs +++ b/src/PepperDash.Essentials.Core/JoinMaps/JoinMapBase.cs @@ -304,14 +304,10 @@ namespace PepperDash.Essentials.Core } /// - /// Returns the join number for the join with the specified key + /// Returns the join span for the join with the specified key /// /// /// - //public uint GetJoinForKey(string key) - //{ - // return Joins.ContainsKey(key) ? Joins[key].JoinNumber : 0; - //} /// diff --git a/src/PepperDash.Essentials.Core/Routing/RouteDescriptor.cs b/src/PepperDash.Essentials.Core/Routing/RouteDescriptor.cs index 4f07b692..aab82d38 100644 --- a/src/PepperDash.Essentials.Core/Routing/RouteDescriptor.cs +++ b/src/PepperDash.Essentials.Core/Routing/RouteDescriptor.cs @@ -95,9 +95,8 @@ namespace PepperDash.Essentials.Core /// Releases the usage tracking for the route and optionally clears the route on the switching devices. /// /// If true, attempts to clear the route on the switching devices (e.g., set input to null/0). - /// - /// ReleaseRoutes method - /// + + 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. /// /// A string describing the route. - /// - /// ToString method - /// + + + public override string ToString() { var routesText = Routes.Select(r => r.ToString()).ToArray(); diff --git a/src/PepperDash.Essentials.Core/Routing/RouteDescriptorCollection.cs b/src/PepperDash.Essentials.Core/Routing/RouteDescriptorCollection.cs index dd4f9f7d..f389f719 100644 --- a/src/PepperDash.Essentials.Core/Routing/RouteDescriptorCollection.cs +++ b/src/PepperDash.Essentials.Core/Routing/RouteDescriptorCollection.cs @@ -64,8 +64,11 @@ namespace PepperDash.Essentials.Core } /// - /// RemoveRouteDescriptor method + /// Removes a RouteDescriptor from the collection based on the specified destination and input port key. /// + /// The destination for which the route descriptor is to be removed. + /// 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. + /// The removed RouteDescriptor object if a matching descriptor was found; otherwise, null. 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); diff --git a/src/PepperDash.Essentials.Core/Routing/RoutingPortCollection.cs b/src/PepperDash.Essentials.Core/Routing/RoutingPortCollection.cs index 14758d79..7ee349b5 100644 --- a/src/PepperDash.Essentials.Core/Routing/RoutingPortCollection.cs +++ b/src/PepperDash.Essentials.Core/Routing/RoutingPortCollection.cs @@ -5,7 +5,7 @@ using System.Linq; namespace PepperDash.Essentials.Core { /// - /// Represents a RoutingPortCollection + /// Represents a RoutingPortCollection, which is essentially a List with an indexer for case-insensitive lookup of ports by their key names. /// public class RoutingPortCollection : List where T: RoutingPort { diff --git a/src/PepperDash.Essentials.Core/Routing/TieLine.cs b/src/PepperDash.Essentials.Core/Routing/TieLine.cs index d85f1c88..42f024b4 100644 --- a/src/PepperDash.Essentials.Core/Routing/TieLine.cs +++ b/src/PepperDash.Essentials.Core/Routing/TieLine.cs @@ -128,7 +128,8 @@ namespace PepperDash.Essentials.Core //******************************************************************************** /// - /// Represents a TieLineCollection + /// Represents a collection of objects, which define signal paths for routing algorithms. + /// This class provides functionality for managing tie lines and includes a singleton instance for global access. /// public class TieLineCollection : List { diff --git a/src/PepperDash.Essentials.Core/Routing/TieLineConfig.cs b/src/PepperDash.Essentials.Core/Routing/TieLineConfig.cs index 7c09a40d..8143c1f5 100644 --- a/src/PepperDash.Essentials.Core/Routing/TieLineConfig.cs +++ b/src/PepperDash.Essentials.Core/Routing/TieLineConfig.cs @@ -29,7 +29,7 @@ namespace PepperDash.Essentials.Core.Config public string SourceCard { get; set; } /// - /// Gets or sets the SourcePort + /// The key of the source output port, used for routing configurations. /// public string SourcePort { get; set; }