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
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:
@@ -44,6 +44,7 @@ public sealed class GenericDriverNodeManagerTests
|
||||
builder.Alarms["Heater.OverTemp"].Received.Count.ShouldBe(0);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that non-alarm variables do not register sinks in the alarm tracker.</summary>
|
||||
[Fact]
|
||||
public async Task Non_alarm_variables_do_not_register_sinks()
|
||||
{
|
||||
@@ -57,6 +58,7 @@ public sealed class GenericDriverNodeManagerTests
|
||||
nm.TrackedAlarmSources.ShouldNotContain("Tank.Level"); // the plain one
|
||||
}
|
||||
|
||||
/// <summary>Verifies that alarm events with unknown source node IDs are silently dropped.</summary>
|
||||
[Fact]
|
||||
public async Task Unknown_source_node_id_is_dropped_silently()
|
||||
{
|
||||
@@ -71,6 +73,7 @@ public sealed class GenericDriverNodeManagerTests
|
||||
builder.Alarms.Values.All(s => s.Received.Count == 0).ShouldBeTrue();
|
||||
}
|
||||
|
||||
/// <summary>Verifies that disposing the node manager unsubscribes from alarm events.</summary>
|
||||
[Fact]
|
||||
public async Task Dispose_unsubscribes_from_OnAlarmEvent()
|
||||
{
|
||||
@@ -117,6 +120,7 @@ public sealed class GenericDriverNodeManagerTests
|
||||
"the original alarm forwarder must be unsubscribed on the second build");
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a second call to BuildAddressSpaceAsync clears the old sink registry.</summary>
|
||||
[Fact]
|
||||
public async Task Second_BuildAddressSpaceAsync_Clears_Old_Sink_Registry()
|
||||
{
|
||||
@@ -132,6 +136,7 @@ public sealed class GenericDriverNodeManagerTests
|
||||
countAfterSecond.ShouldBe(2, "second build must re-register exactly the same sources, not accumulate");
|
||||
}
|
||||
|
||||
/// <summary>Verifies that calling BuildAddressSpaceAsync after disposal throws ObjectDisposedException.</summary>
|
||||
[Fact]
|
||||
public async Task BuildAddressSpaceAsync_After_Dispose_Throws_ObjectDisposedException()
|
||||
{
|
||||
@@ -164,16 +169,33 @@ public sealed class GenericDriverNodeManagerTests
|
||||
/// <summary>Driver whose DiscoverAsync throws — exercises the exception-isolation boundary.</summary>
|
||||
private sealed class ThrowingDiscoveryDriver : IDriver, ITagDiscovery
|
||||
{
|
||||
/// <summary>Gets the driver instance identifier.</summary>
|
||||
public string DriverInstanceId => "throwing";
|
||||
/// <summary>Gets the driver type name.</summary>
|
||||
public string DriverType => "Throwing";
|
||||
|
||||
/// <summary>Initializes the driver with configuration.</summary>
|
||||
/// <param name="_">Configuration JSON (unused in test double).</param>
|
||||
/// <param name="__">Cancellation token (unused in test double).</param>
|
||||
public Task InitializeAsync(string _, CancellationToken __) => Task.CompletedTask;
|
||||
/// <summary>Reinitializes the driver with new configuration.</summary>
|
||||
/// <param name="_">Configuration JSON (unused in test double).</param>
|
||||
/// <param name="__">Cancellation token (unused in test double).</param>
|
||||
public Task ReinitializeAsync(string _, CancellationToken __) => Task.CompletedTask;
|
||||
/// <summary>Shuts down the driver.</summary>
|
||||
/// <param name="_">Cancellation token (unused in test double).</param>
|
||||
public Task ShutdownAsync(CancellationToken _) => Task.CompletedTask;
|
||||
/// <summary>Gets the current health status of the driver.</summary>
|
||||
public DriverHealth GetHealth() => new(DriverState.Healthy, null, null);
|
||||
/// <summary>Gets the memory footprint of the driver.</summary>
|
||||
public long GetMemoryFootprint() => 0;
|
||||
/// <summary>Flushes optional caches in the driver.</summary>
|
||||
/// <param name="_">Cancellation token (unused in test double).</param>
|
||||
public Task FlushOptionalCachesAsync(CancellationToken _) => Task.CompletedTask;
|
||||
|
||||
/// <summary>Discovers the address space by throwing an exception.</summary>
|
||||
/// <param name="builder">The builder used to construct the address space.</param>
|
||||
/// <param name="ct">Cancellation token.</param>
|
||||
public Task DiscoverAsync(IAddressSpaceBuilder builder, CancellationToken ct)
|
||||
=> throw new InvalidOperationException("discovery boom");
|
||||
}
|
||||
@@ -182,17 +204,35 @@ public sealed class GenericDriverNodeManagerTests
|
||||
|
||||
private sealed class FakeDriver : IDriver, ITagDiscovery, IAlarmSource
|
||||
{
|
||||
/// <summary>Gets the driver instance identifier.</summary>
|
||||
public string DriverInstanceId => "fake";
|
||||
/// <summary>Gets the driver type name.</summary>
|
||||
public string DriverType => "Fake";
|
||||
/// <summary>Occurs when an alarm event is raised.</summary>
|
||||
public event EventHandler<AlarmEventArgs>? OnAlarmEvent;
|
||||
|
||||
/// <summary>Initializes the driver with configuration.</summary>
|
||||
/// <param name="driverConfigJson">Configuration JSON.</param>
|
||||
/// <param name="ct">Cancellation token.</param>
|
||||
public Task InitializeAsync(string driverConfigJson, CancellationToken ct) => Task.CompletedTask;
|
||||
/// <summary>Reinitializes the driver with new configuration.</summary>
|
||||
/// <param name="driverConfigJson">Configuration JSON.</param>
|
||||
/// <param name="ct">Cancellation token.</param>
|
||||
public Task ReinitializeAsync(string driverConfigJson, CancellationToken ct) => Task.CompletedTask;
|
||||
/// <summary>Shuts down the driver.</summary>
|
||||
/// <param name="ct">Cancellation token.</param>
|
||||
public Task ShutdownAsync(CancellationToken ct) => Task.CompletedTask;
|
||||
/// <summary>Gets the current health status of the driver.</summary>
|
||||
public DriverHealth GetHealth() => new(DriverState.Healthy, DateTime.UtcNow, null);
|
||||
/// <summary>Gets the memory footprint of the driver.</summary>
|
||||
public long GetMemoryFootprint() => 0;
|
||||
/// <summary>Flushes optional caches in the driver.</summary>
|
||||
/// <param name="ct">Cancellation token.</param>
|
||||
public Task FlushOptionalCachesAsync(CancellationToken ct) => Task.CompletedTask;
|
||||
|
||||
/// <summary>Discovers the address space and registers alarm conditions.</summary>
|
||||
/// <param name="builder">The builder used to construct the address space.</param>
|
||||
/// <param name="ct">Cancellation token.</param>
|
||||
public Task DiscoverAsync(IAddressSpaceBuilder builder, CancellationToken ct)
|
||||
{
|
||||
var folder = builder.Folder("Tank", "Tank");
|
||||
@@ -209,33 +249,63 @@ public sealed class GenericDriverNodeManagerTests
|
||||
return Task.CompletedTask;
|
||||
}
|
||||
|
||||
/// <summary>Raises an alarm event with the given arguments.</summary>
|
||||
/// <param name="args">The alarm event arguments.</param>
|
||||
public void RaiseAlarm(AlarmEventArgs args) => OnAlarmEvent?.Invoke(this, args);
|
||||
|
||||
/// <summary>Subscribes to alarm events.</summary>
|
||||
/// <param name="_">Tag references to subscribe to (unused in test double).</param>
|
||||
/// <param name="__">Cancellation token (unused in test double).</param>
|
||||
public Task<IAlarmSubscriptionHandle> SubscribeAlarmsAsync(IReadOnlyList<string> _, CancellationToken __)
|
||||
=> Task.FromResult<IAlarmSubscriptionHandle>(new FakeHandle("sub"));
|
||||
/// <summary>Unsubscribes from alarm events.</summary>
|
||||
/// <param name="_">The subscription handle (unused in test double).</param>
|
||||
/// <param name="__">Cancellation token (unused in test double).</param>
|
||||
public Task UnsubscribeAlarmsAsync(IAlarmSubscriptionHandle _, CancellationToken __) => Task.CompletedTask;
|
||||
/// <summary>Acknowledges alarm notifications.</summary>
|
||||
/// <param name="_">Alarm acknowledgement requests (unused in test double).</param>
|
||||
/// <param name="__">Cancellation token (unused in test double).</param>
|
||||
public Task AcknowledgeAsync(IReadOnlyList<AlarmAcknowledgeRequest> _, CancellationToken __) => Task.CompletedTask;
|
||||
}
|
||||
|
||||
/// <summary>Test double for IAlarmSubscriptionHandle.</summary>
|
||||
private sealed class FakeHandle(string diagnosticId) : IAlarmSubscriptionHandle
|
||||
{
|
||||
/// <summary>Gets the diagnostic identifier for this subscription.</summary>
|
||||
public string DiagnosticId { get; } = diagnosticId;
|
||||
}
|
||||
|
||||
/// <summary>Test double for IAddressSpaceBuilder that records alarm sinks.</summary>
|
||||
private sealed class RecordingBuilder : IAddressSpaceBuilder
|
||||
{
|
||||
/// <summary>Gets the map of alarm sources to their sinks.</summary>
|
||||
public Dictionary<string, RecordingSink> Alarms { get; } = new(StringComparer.OrdinalIgnoreCase);
|
||||
|
||||
/// <summary>Creates a folder in the address space.</summary>
|
||||
/// <param name="_">The contained name (unused in test double).</param>
|
||||
/// <param name="__">The display name (unused in test double).</param>
|
||||
public IAddressSpaceBuilder Folder(string _, string __) => this;
|
||||
|
||||
/// <summary>Creates a variable in the address space.</summary>
|
||||
/// <param name="_">The contained name (unused in test double).</param>
|
||||
/// <param name="__">The display name (unused in test double).</param>
|
||||
/// <param name="info">The driver attribute information.</param>
|
||||
public IVariableHandle Variable(string _, string __, DriverAttributeInfo info)
|
||||
=> new Handle(info.FullName, Alarms);
|
||||
|
||||
/// <summary>Adds a property to the current variable.</summary>
|
||||
/// <param name="_">The property name (unused in test double).</param>
|
||||
/// <param name="__">The data type (unused in test double).</param>
|
||||
/// <param name="___">The initial value (unused in test double).</param>
|
||||
public void AddProperty(string _, DriverDataType __, object? ___) { }
|
||||
|
||||
/// <summary>Test double for IVariableHandle.</summary>
|
||||
public sealed class Handle(string fullRef, Dictionary<string, RecordingSink> alarms) : IVariableHandle
|
||||
{
|
||||
/// <summary>Gets the full reference name for this variable.</summary>
|
||||
public string FullReference { get; } = fullRef;
|
||||
/// <summary>Marks this variable as an alarm condition and registers its sink.</summary>
|
||||
/// <param name="_">The alarm condition info (unused in test double).</param>
|
||||
public IAlarmConditionSink MarkAsAlarmCondition(AlarmConditionInfo _)
|
||||
{
|
||||
var sink = new RecordingSink();
|
||||
@@ -244,9 +314,13 @@ public sealed class GenericDriverNodeManagerTests
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Test double for IAlarmConditionSink that records transitions.</summary>
|
||||
public sealed class RecordingSink : IAlarmConditionSink
|
||||
{
|
||||
/// <summary>Gets the list of alarm transitions received by this sink.</summary>
|
||||
public List<AlarmEventArgs> Received { get; } = new();
|
||||
/// <summary>Records an alarm transition.</summary>
|
||||
/// <param name="args">The alarm event arguments.</param>
|
||||
public void OnTransition(AlarmEventArgs args) => Received.Add(args);
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user