pepperdash/Essentials
1
0
Fork 0
mirror of https://github.com/PepperDash/Essentials.git synced 2026-01-11 19:44:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix duplicate and malformed XML documentation tags

Browse Source 
Co-authored-by: andrew-welker <1765622+andrew-welker@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2025-07-22 17:40:17 +00:00
parent b283ed34b4
commit 80da4ad98f
12 changed files with 55 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/PepperDash.Core/Comm/GenericSshClient.cs
View File

@@ -36,7 +36,7 @@ namespace PepperDash.Core
/// </summary>
public event EventHandler<GenericSocketStatusChageEventArgs> ConnectionChange;
///// <summary>
/// <summary>
/////
///// </summary>
//public event GenericSocketStatusChangeEventDelegate SocketStatusChange;
@@ -79,7 +79,7 @@ namespace PepperDash.Core
}
/// <summary>
///
/// Socket status change event
/// </summary>
public SocketStatus ClientStatus
{

14
src/PepperDash.Core/Device.cs
View File

@@ -24,14 +24,14 @@ namespace PepperDash.Core
/// </summary>
public bool Enabled { get; protected set; }
///// <summary>
///// 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.
///// </summary>
/// <summary>
/// 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.
/// </summary>
//public DeviceConfig Config { get; private set; }
///// <summary>
///// Helper method to check if Config exists
///// </summary>
/// <summary>
/// Helper method to check if Config exists
/// </summary>
//public bool HasConfig { get { return Config != null; } }
List<Action> _PreActivationActions;

6
src/PepperDash.Core/Logging/DebugContext.cs
View File

@@ -19,9 +19,9 @@ namespace PepperDash.Core
/// </summary>
public string Key { get; private set; }
///// <summary>
///// The name of the file containing the current debug settings.
///// </summary>
/// <summary>
/// The name of the file containing the current debug settings.
/// </summary>
//string FileName = string.Format(@"\nvram\debug\app{0}Debug.json", InitialParametersClass.ApplicationNumber);
DebugContextSaveData SaveData;

6
src/PepperDash.Essentials.Core/Feedbacks/FeedbackBase.cs
View File

@@ -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);

20
src/PepperDash.Essentials.Core/JoinMaps/JoinMapBase.cs
View File

@@ -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;

8
src/PepperDash.Essentials.Core/Routing/RouteDescriptor.cs
View File

@@ -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>
{

5
src/PepperDash.Essentials.Core/Routing/RouteDescriptorCollection.cs
View File

@@ -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>
{

11
src/PepperDash.Essentials.Core/Routing/RouteSwitchDescriptor.cs
View File

@@ -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; }

6
src/PepperDash.Essentials.Core/SmartObjects/SubpageReferencList/SubpageReferenceList.cs
View File

@@ -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; }

6
src/PepperDash.Essentials.Core/VideoStatus/VideoStatusOutputs.cs
View File

@@ -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;

6
src/PepperDash.Essentials.Devices.Common/AudioCodec/Interfaces/IHasAudioCodec.cs
View File

@@ -15,9 +15,9 @@ namespace PepperDash.Essentials.Devices.Common.AudioCodec
{
AudioCodecBase AudioCodec { get; }
///// <summary>
///// Make this more specific
///// </summary>
/// <summary>
/// Make this more specific
/// </summary>
//List<PepperDash.Essentials.Devices.Common.Codec.CodecActiveCallItem> ActiveCalls { get; }
}
}

6
src/PepperDash.Essentials.Devices.Common/VideoCodec/Interfaces/IHasVideoCodec.cs
View File

@@ -15,9 +15,9 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec
{
VideoCodecBase VideoCodec { get; }
///// <summary>
///// Make this more specific
///// </summary>
/// <summary>
/// Make this more specific
/// </summary>
//List<PepperDash.Essentials.Devices.Common.Codec.CodecActiveCallItem> ActiveCalls { get; }
/// <summary>