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
@@ -12,27 +12,55 @@ namespace ZB.MOM.WW.OtOpcUa.Client.CLI.Tests.Fakes;
public sealed class FakeOpcUaClientService : IOpcUaClientService
{
// Track calls
/// <summary>Gets a value indicating whether ConnectAsync was called.</summary>
public bool ConnectCalled { get; private set; }
/// <summary>Gets the connection settings from the most recent ConnectAsync call.</summary>
public ConnectionSettings? LastConnectionSettings { get; private set; }
/// <summary>Gets a value indicating whether DisconnectAsync was called.</summary>
public bool DisconnectCalled { get; private set; }
/// <summary>Gets a value indicating whether Dispose was called.</summary>
public bool DisposeCalled { get; private set; }
/// <summary>Gets the list of node IDs passed to ReadValueAsync calls.</summary>
public List<NodeId> ReadNodeIds { get; } = [];
/// <summary>Gets the list of (NodeId, value) pairs passed to WriteValueAsync calls.</summary>
public List<(NodeId NodeId, object Value)> WriteValues { get; } = [];
/// <summary>Gets the list of parent node IDs passed to BrowseAsync calls.</summary>
public List<NodeId?> BrowseNodeIds { get; } = [];
/// <summary>Gets the list of (NodeId, intervalMs) pairs from SubscribeAsync calls.</summary>
public List<(NodeId NodeId, int IntervalMs)> SubscribeCalls { get; } = [];
/// <summary>Gets the list of node IDs passed to UnsubscribeAsync calls.</summary>
public List<NodeId> UnsubscribeCalls { get; } = [];
/// <summary>Gets the list of (SourceNodeId, intervalMs) pairs from SubscribeAlarmsAsync calls.</summary>
public List<(NodeId? SourceNodeId, int IntervalMs)> SubscribeAlarmsCalls { get; } = [];
/// <summary>Gets a value indicating whether UnsubscribeAlarmsAsync was called.</summary>
public bool UnsubscribeAlarmsCalled { get; private set; }
/// <summary>Gets a value indicating whether RequestConditionRefreshAsync was called.</summary>
public bool RequestConditionRefreshCalled { get; private set; }
/// <summary>Gets the list of (NodeId, start, end, maxValues) tuples from HistoryReadRawAsync calls.</summary>
public List<(NodeId NodeId, DateTime Start, DateTime End, int MaxValues)> HistoryReadRawCalls { get; } = [];
/// <summary>Gets the list of history read aggregate call parameters.</summary>
public List<(NodeId NodeId, DateTime Start, DateTime End, AggregateType Aggregate, double IntervalMs)>
HistoryReadAggregateCalls { get; } =
[];
/// <summary>Gets a value indicating whether GetRedundancyInfoAsync was called.</summary>
public bool GetRedundancyInfoCalled { get; private set; }
// Configurable results
/// <summary>Gets or sets the connection info returned by ConnectAsync.</summary>
public ConnectionInfo ConnectionInfoResult { get; set; } = new(
"opc.tcp://localhost:4840",
"TestServer",
@@ -41,14 +69,17 @@ public sealed class FakeOpcUaClientService : IOpcUaClientService
"session-1",
"TestSession");
/// <summary>Gets or sets the data value returned by ReadValueAsync.</summary>
public DataValue ReadValueResult { get; set; } = new(
new Variant(42),
StatusCodes.Good,
DateTime.UtcNow,
DateTime.UtcNow);
/// <summary>Gets or sets the status code returned by WriteValueAsync.</summary>
public StatusCode WriteStatusCodeResult { get; set; } = StatusCodes.Good;
/// <summary>Gets or sets the browse results returned by BrowseAsync.</summary>
public IReadOnlyList<BrowseResult> BrowseResults { get; set; } = new List<BrowseResult>
{
new("ns=2;s=Node1", "Node1", "Object", true),
@@ -63,19 +94,30 @@ public sealed class FakeOpcUaClientService : IOpcUaClientService
/// </summary>
public Dictionary<string, IReadOnlyList<BrowseResult>> BrowseResultsByParent { get; } = new();
/// <summary>Gets or sets the history read result returned by HistoryReadRawAsync and HistoryReadAggregateAsync.</summary>
public IReadOnlyList<DataValue> HistoryReadResult { get; set; } = new List<DataValue>
{
new(new Variant(10.0), StatusCodes.Good, DateTime.UtcNow.AddHours(-1), DateTime.UtcNow),
new(new Variant(20.0), StatusCodes.Good, DateTime.UtcNow, DateTime.UtcNow)
};
/// <summary>Gets or sets the redundancy info returned by GetRedundancyInfoAsync.</summary>
public RedundancyInfo RedundancyInfoResult { get; set; } = new(
"Warm", 200, ["urn:server1", "urn:server2"], "urn:app:test");
/// <summary>Gets or sets the exception thrown by ConnectAsync.</summary>
public Exception? ConnectException { get; set; }
/// <summary>Gets or sets the exception thrown by ReadValueAsync.</summary>
public Exception? ReadException { get; set; }
/// <summary>Gets or sets the exception thrown by WriteValueAsync.</summary>
public Exception? WriteException { get; set; }
/// <summary>Gets or sets the exception thrown by RequestConditionRefreshAsync.</summary>
public Exception? ConditionRefreshException { get; set; }
/// <summary>Gets or sets the exception thrown by SubscribeAsync.</summary>
public Exception? SubscribeException { get; set; }
/// <inheritdoc />
@@ -218,18 +260,24 @@ public sealed class FakeOpcUaClientService : IOpcUaClientService
}
/// <summary>Raises the DataChanged event for testing subscribe commands.</summary>
/// <param name="nodeId">The node ID string that changed.</param>
/// <param name="value">The new data value.</param>
public void RaiseDataChanged(string nodeId, DataValue value)
{
DataChanged?.Invoke(this, new DataChangedEventArgs(nodeId, value));
}
/// <summary>Raises the AlarmEvent for testing alarm commands.</summary>
/// <param name="args">The alarm event arguments.</param>
public void RaiseAlarmEvent(AlarmEventArgs args)
{
AlarmEvent?.Invoke(this, args);
}
/// <summary>Raises the ConnectionStateChanged event for testing.</summary>
/// <param name="oldState">The previous connection state.</param>
/// <param name="newState">The new connection state.</param>
/// <param name="endpointUrl">The endpoint URL.</param>
public void RaiseConnectionStateChanged(ConnectionState oldState, ConnectionState newState, string endpointUrl)
{
ConnectionStateChanged?.Invoke(this, new ConnectionStateChangedEventArgs(oldState, newState, endpointUrl));