From 80da4ad98f79445cd5da2cfe44fd6184ea9e8743 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 22 Jul 2025 17:40:17 +0000 Subject: [PATCH] docs: fix duplicate and malformed XML documentation tags Co-authored-by: andrew-welker <1765622+andrew-welker@users.noreply.github.com> --- src/PepperDash.Core/Comm/GenericSshClient.cs | 4 ++-- src/PepperDash.Core/Device.cs | 14 ++++++------- src/PepperDash.Core/Logging/DebugContext.cs | 6 +++--- .../Feedbacks/FeedbackBase.cs | 6 +++--- .../JoinMaps/JoinMapBase.cs | 20 +++++++++---------- .../Routing/RouteDescriptor.cs | 8 +++++++- .../Routing/RouteDescriptorCollection.cs | 5 ++++- .../Routing/RouteSwitchDescriptor.cs | 11 ++++++---- .../SubpageReferenceList.cs | 6 +++--- .../VideoStatus/VideoStatusOutputs.cs | 6 +++--- .../AudioCodec/Interfaces/IHasAudioCodec.cs | 6 +++--- .../VideoCodec/Interfaces/IHasVideoCodec.cs | 6 +++--- 12 files changed, 55 insertions(+), 43 deletions(-) diff --git a/src/PepperDash.Core/Comm/GenericSshClient.cs b/src/PepperDash.Core/Comm/GenericSshClient.cs index 2817ccd4..3ba9059e 100644 --- a/src/PepperDash.Core/Comm/GenericSshClient.cs +++ b/src/PepperDash.Core/Comm/GenericSshClient.cs @@ -36,7 +36,7 @@ namespace PepperDash.Core /// public event EventHandler ConnectionChange; - ///// + /// ///// ///// //public event GenericSocketStatusChangeEventDelegate SocketStatusChange; @@ -79,7 +79,7 @@ namespace PepperDash.Core } /// - /// + /// Socket status change event /// public SocketStatus ClientStatus { diff --git a/src/PepperDash.Core/Device.cs b/src/PepperDash.Core/Device.cs index 27548b0a..7124550e 100644 --- a/src/PepperDash.Core/Device.cs +++ b/src/PepperDash.Core/Device.cs @@ -24,14 +24,14 @@ namespace PepperDash.Core /// public bool Enabled { get; protected set; } - ///// - ///// 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. - ///// + /// + /// 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. + /// //public DeviceConfig Config { get; private set; } - ///// - ///// Helper method to check if Config exists - ///// + /// + /// Helper method to check if Config exists + /// //public bool HasConfig { get { return Config != null; } } List _PreActivationActions; diff --git a/src/PepperDash.Core/Logging/DebugContext.cs b/src/PepperDash.Core/Logging/DebugContext.cs index bb1a5f65..e90ec86a 100644 --- a/src/PepperDash.Core/Logging/DebugContext.cs +++ b/src/PepperDash.Core/Logging/DebugContext.cs @@ -19,9 +19,9 @@ namespace PepperDash.Core /// public string Key { get; private set; } - ///// - ///// The name of the file containing the current debug settings. - ///// + /// + /// The name of the file containing the current debug settings. + /// //string FileName = string.Format(@"\nvram\debug\app{0}Debug.json", InitialParametersClass.ApplicationNumber); DebugContextSaveData SaveData; diff --git a/src/PepperDash.Essentials.Core/Feedbacks/FeedbackBase.cs b/src/PepperDash.Essentials.Core/Feedbacks/FeedbackBase.cs index 29122bf3..d4caa7e5 100644 --- a/src/PepperDash.Essentials.Core/Feedbacks/FeedbackBase.cs +++ b/src/PepperDash.Essentials.Core/Feedbacks/FeedbackBase.cs @@ -80,9 +80,9 @@ namespace PepperDash.Essentials.Core CrestronInvoke.BeginInvoke(o => FireUpdate()); } - ///// - ///// Helper method that fires event. Use this intstead of calling OutputChange - ///// + /// + /// Helper method that fires event. Use this intstead of calling OutputChange + /// //protected void OnOutputChange() //{ // if (OutputChange != null) OutputChange(this, EventArgs.Empty); diff --git a/src/PepperDash.Essentials.Core/JoinMaps/JoinMapBase.cs b/src/PepperDash.Essentials.Core/JoinMaps/JoinMapBase.cs index 9ad1d8ea..9fca8e12 100644 --- a/src/PepperDash.Essentials.Core/JoinMaps/JoinMapBase.cs +++ b/src/PepperDash.Essentials.Core/JoinMaps/JoinMapBase.cs @@ -303,22 +303,22 @@ namespace PepperDash.Essentials.Core PrintJoinMapInfo(); } - ///// - ///// Returns the join number for the join with the specified key - ///// - ///// - ///// + /// + /// Returns the join number for the join with the specified key + /// + /// + /// //public uint GetJoinForKey(string key) //{ // return Joins.ContainsKey(key) ? Joins[key].JoinNumber : 0; //} - ///// - ///// Returns the join span for the join with the specified key - ///// - ///// - ///// + /// + /// Returns the join span for the join with the specified key + /// + /// + /// //public uint GetJoinSpanForKey(string key) //{ // return Joins.ContainsKey(key) ? Joins[key].JoinSpan : 0; diff --git a/src/PepperDash.Essentials.Core/Routing/RouteDescriptor.cs b/src/PepperDash.Essentials.Core/Routing/RouteDescriptor.cs index 5fcf10cb..4f07b692 100644 --- a/src/PepperDash.Essentials.Core/Routing/RouteDescriptor.cs +++ b/src/PepperDash.Essentials.Core/Routing/RouteDescriptor.cs @@ -95,6 +95,9 @@ 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)) @@ -146,7 +149,10 @@ namespace PepperDash.Essentials.Core } /*/// - /// 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 + /// + /// + /// Represents a RouteDescriptor /// public class RouteDescriptor { diff --git a/src/PepperDash.Essentials.Core/Routing/RouteDescriptorCollection.cs b/src/PepperDash.Essentials.Core/Routing/RouteDescriptorCollection.cs index 532a1b64..dd4f9f7d 100644 --- a/src/PepperDash.Essentials.Core/Routing/RouteDescriptorCollection.cs +++ b/src/PepperDash.Essentials.Core/Routing/RouteDescriptorCollection.cs @@ -83,7 +83,10 @@ namespace PepperDash.Essentials.Core } /*/// - /// Represents a RouteDescriptorCollection - typically the static DefaultCollection is used + /// A collection of RouteDescriptors - typically the static DefaultCollection is used + /// + /// + /// Represents a RouteDescriptorCollection /// public class RouteDescriptorCollection { diff --git a/src/PepperDash.Essentials.Core/Routing/RouteSwitchDescriptor.cs b/src/PepperDash.Essentials.Core/Routing/RouteSwitchDescriptor.cs index 0edf2de7..12aebdcf 100644 --- a/src/PepperDash.Essentials.Core/Routing/RouteSwitchDescriptor.cs +++ b/src/PepperDash.Essentials.Core/Routing/RouteSwitchDescriptor.cs @@ -53,20 +53,23 @@ } /*/// - /// Represents a RouteSwitchDescriptor with generic input and output selectors. + /// Represents an individual link for a route + /// + /// + /// Represents a RouteSwitchDescriptor /// public class RouteSwitchDescriptor { /// - /// Gets or sets the SwitchingDevice. + /// Gets or sets the SwitchingDevice /// public IRoutingInputs SwitchingDevice { get { return InputPort.ParentDevice; } } /// - /// Gets or sets the OutputPort. + /// Gets or sets the OutputPort /// public RoutingOutputPort OutputPort { get; set; } /// - /// Gets or sets the InputPort. + /// Gets or sets the InputPort /// public RoutingInputPort InputPort { get; set; } diff --git a/src/PepperDash.Essentials.Core/SmartObjects/SubpageReferencList/SubpageReferenceList.cs b/src/PepperDash.Essentials.Core/SmartObjects/SubpageReferencList/SubpageReferenceList.cs index 70468301..f955011a 100644 --- a/src/PepperDash.Essentials.Core/SmartObjects/SubpageReferencList/SubpageReferenceList.cs +++ b/src/PepperDash.Essentials.Core/SmartObjects/SubpageReferencList/SubpageReferenceList.cs @@ -15,9 +15,9 @@ using Serilog.Events; namespace PepperDash.Essentials.Core { ////***************************************************************************** - ///// - ///// Base class for all subpage reference list controllers - ///// + /// + /// Base class for all subpage reference list controllers + /// //public class SubpageReferenceListController //{ // public SubpageReferenceList TheList { get; protected set; } diff --git a/src/PepperDash.Essentials.Core/VideoStatus/VideoStatusOutputs.cs b/src/PepperDash.Essentials.Core/VideoStatus/VideoStatusOutputs.cs index ea7620e0..9a929234 100644 --- a/src/PepperDash.Essentials.Core/VideoStatus/VideoStatusOutputs.cs +++ b/src/PepperDash.Essentials.Core/VideoStatus/VideoStatusOutputs.cs @@ -94,9 +94,9 @@ namespace PepperDash.Essentials.Core } } - ///// - ///// Wraps up the common video statuses exposed on a video input port - ///// + /// + /// Wraps up the common video statuses exposed on a video input port + /// //public class BasicVideoStatus : IBasicVideoStatus //{ // public event VideoStatusChangeHandler VideoStatusChange; diff --git a/src/PepperDash.Essentials.Devices.Common/AudioCodec/Interfaces/IHasAudioCodec.cs b/src/PepperDash.Essentials.Devices.Common/AudioCodec/Interfaces/IHasAudioCodec.cs index b6fa079d..a1a2d64d 100644 --- a/src/PepperDash.Essentials.Devices.Common/AudioCodec/Interfaces/IHasAudioCodec.cs +++ b/src/PepperDash.Essentials.Devices.Common/AudioCodec/Interfaces/IHasAudioCodec.cs @@ -15,9 +15,9 @@ namespace PepperDash.Essentials.Devices.Common.AudioCodec { AudioCodecBase AudioCodec { get; } - ///// - ///// Make this more specific - ///// + /// + /// Make this more specific + /// //List ActiveCalls { get; } } } \ No newline at end of file diff --git a/src/PepperDash.Essentials.Devices.Common/VideoCodec/Interfaces/IHasVideoCodec.cs b/src/PepperDash.Essentials.Devices.Common/VideoCodec/Interfaces/IHasVideoCodec.cs index d8494334..f7b8f9ad 100644 --- a/src/PepperDash.Essentials.Devices.Common/VideoCodec/Interfaces/IHasVideoCodec.cs +++ b/src/PepperDash.Essentials.Devices.Common/VideoCodec/Interfaces/IHasVideoCodec.cs @@ -15,9 +15,9 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec { VideoCodecBase VideoCodec { get; } - ///// - ///// Make this more specific - ///// + /// + /// Make this more specific + /// //List ActiveCalls { get; } ///