docs: backfill XML documentation across 756 files
v2-ci / build (push) Failing after 1m43s
v2-ci / unit-tests (tests/Core/ZB.MOM.WW.OtOpcUa.Cluster.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.ControlPlane.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.OpcUaServer.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.Runtime.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.Security.Tests) (push) Has been skipped
v2-ci / integration (tests/Server/ZB.MOM.WW.OtOpcUa.Host.IntegrationTests) (push) Has been skipped
v2-ci / integration (tests/Server/ZB.MOM.WW.OtOpcUa.OpcUaServer.IntegrationTests) (push) Has been skipped

Adds <summary>, <param>, <typeparam>, and <inheritdoc/> tags to public
members surfaced by commentchecker — resolves 5,847 of 5,869 issues
(99.6%) across three /fixdocs passes.
This commit is contained in:
Joseph Doherty
2026-05-28 08:10:17 -04:00
parent f9fc7dd2e1
commit 64e3fbe035
756 changed files with 9876 additions and 96 deletions
@@ -84,28 +84,50 @@ public sealed class FakeOpcUaClientService : IOpcUaClientService
public Exception? HistoryException { get; set; }
// Call tracking
/// <summary>Gets the number of times ConnectAsync has been called.</summary>
public int ConnectCallCount { get; private set; }
/// <summary>Gets the number of times DisconnectAsync has been called.</summary>
public int DisconnectCallCount { get; private set; }
/// <summary>Gets the number of times ReadValueAsync has been called.</summary>
public int ReadCallCount { get; private set; }
/// <summary>Gets the number of times WriteValueAsync has been called.</summary>
public int WriteCallCount { get; private set; }
/// <summary>Gets the number of times BrowseAsync has been called.</summary>
public int BrowseCallCount { get; private set; }
/// <summary>Gets the number of times SubscribeAsync has been called.</summary>
public int SubscribeCallCount { get; private set; }
/// <summary>Gets the number of times UnsubscribeAsync has been called.</summary>
public int UnsubscribeCallCount { get; private set; }
/// <summary>Gets the number of times SubscribeAlarmsAsync has been called.</summary>
public int SubscribeAlarmsCallCount { get; private set; }
/// <summary>Gets the number of times UnsubscribeAlarmsAsync has been called.</summary>
public int UnsubscribeAlarmsCallCount { get; private set; }
/// <summary>Gets the number of times RequestConditionRefreshAsync has been called.</summary>
public int RequestConditionRefreshCallCount { get; private set; }
/// <summary>Gets the number of times HistoryReadRawAsync has been called.</summary>
public int HistoryReadRawCallCount { get; private set; }
/// <summary>Gets the number of times HistoryReadAggregateAsync has been called.</summary>
public int HistoryReadAggregateCallCount { get; private set; }
/// <summary>Gets the number of times GetRedundancyInfoAsync has been called.</summary>
public int GetRedundancyInfoCallCount { get; private set; }
/// <summary>Gets the connection settings from the last ConnectAsync call.</summary>
public ConnectionSettings? LastConnectionSettings { get; private set; }
/// <summary>Gets the node ID from the last ReadValueAsync call.</summary>
public NodeId? LastReadNodeId { get; private set; }
/// <summary>Gets the node ID from the last WriteValueAsync call.</summary>
public NodeId? LastWriteNodeId { get; private set; }
/// <summary>Gets the value from the last WriteValueAsync call.</summary>
public object? LastWriteValue { get; private set; }
/// <summary>Gets the parent node ID from the last BrowseAsync call.</summary>
public NodeId? LastBrowseParentNodeId { get; private set; }
/// <summary>Gets the node ID from the last SubscribeAsync call.</summary>
public NodeId? LastSubscribeNodeId { get; private set; }
/// <summary>Gets the interval in milliseconds from the last SubscribeAsync call.</summary>
public int LastSubscribeIntervalMs { get; private set; }
/// <summary>Gets the node ID from the last UnsubscribeAsync call.</summary>
public NodeId? LastUnsubscribeNodeId { get; private set; }
/// <summary>Gets the aggregate type from the last HistoryReadAggregateAsync call.</summary>
public AggregateType? LastAggregateType { get; private set; }
/// <inheritdoc />
@@ -225,8 +247,11 @@ public sealed class FakeOpcUaClientService : IOpcUaClientService
return Task.CompletedTask;
}
/// <summary>Gets or sets the status code returned by acknowledgment operations in UI tests.</summary>
public StatusCode AcknowledgeResult { get; set; } = StatusCodes.Good;
/// <summary>Gets or sets the exception thrown to simulate alarm acknowledgment failures in the UI.</summary>
public Exception? AcknowledgeException { get; set; }
/// <summary>Gets the number of times AcknowledgeAlarmAsync has been called.</summary>
public int AcknowledgeCallCount { get; private set; }
/// <inheritdoc />
@@ -276,6 +301,7 @@ public sealed class FakeOpcUaClientService : IOpcUaClientService
/// <summary>
/// Raises a simulated data-change notification so UI tests can validate live update handling.
/// </summary>
/// <param name="args">The data change event arguments to raise.</param>
public void RaiseDataChanged(DataChangedEventArgs args)
{
DataChanged?.Invoke(this, args);
@@ -284,6 +310,7 @@ public sealed class FakeOpcUaClientService : IOpcUaClientService
/// <summary>
/// Raises a simulated alarm event so UI tests can validate alarm-list behavior.
/// </summary>
/// <param name="args">The alarm event arguments to raise.</param>
public void RaiseAlarmEvent(AlarmEventArgs args)
{
AlarmEvent?.Invoke(this, args);
@@ -292,6 +319,7 @@ public sealed class FakeOpcUaClientService : IOpcUaClientService
/// <summary>
/// Raises a simulated connection-state transition so UI tests can validate status presentation and failover behavior.
/// </summary>
/// <param name="args">The connection state changed event arguments to raise.</param>
public void RaiseConnectionStateChanged(ConnectionStateChangedEventArgs args)
{
ConnectionStateChanged?.Invoke(this, args);