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:
+12
@@ -17,6 +17,7 @@ public sealed class AbLegacyDisposeAndResolveHostTests
|
||||
{
|
||||
// ---- Driver.AbLegacy-011 ----
|
||||
|
||||
/// <summary>Verifies that Dispose performs teardown without blocking on async operations.</summary>
|
||||
[Fact]
|
||||
public async Task Dispose_runs_teardown_without_blocking_on_async_wait()
|
||||
{
|
||||
@@ -45,6 +46,7 @@ public sealed class AbLegacyDisposeAndResolveHostTests
|
||||
drv.GetHealth().State.ShouldBe(DriverState.Unknown);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that Dispose can be called multiple times without throwing.</summary>
|
||||
[Fact]
|
||||
public async Task Dispose_is_idempotent()
|
||||
{
|
||||
@@ -58,6 +60,7 @@ public sealed class AbLegacyDisposeAndResolveHostTests
|
||||
Should.NotThrow(() => drv.Dispose());
|
||||
}
|
||||
|
||||
/// <summary>Verifies that Dispose does not deadlock under a single-threaded synchronization context.</summary>
|
||||
[Fact]
|
||||
public async Task Dispose_under_single_threaded_sync_context_does_not_deadlock()
|
||||
{
|
||||
@@ -100,9 +103,14 @@ public sealed class AbLegacyDisposeAndResolveHostTests
|
||||
{
|
||||
private readonly System.Collections.Concurrent.BlockingCollection<(SendOrPostCallback, object?)> _queue = new();
|
||||
|
||||
/// <inheritdoc />
|
||||
public override void Post(SendOrPostCallback d, object? state) => _queue.Add((d, state));
|
||||
|
||||
/// <inheritdoc />
|
||||
public override void Send(SendOrPostCallback d, object? state) => d(state);
|
||||
|
||||
/// <summary>Runs the event loop until the stop signal is set.</summary>
|
||||
/// <param name="stop">The event to signal loop completion.</param>
|
||||
public void RunUntil(ManualResetEventSlim stop)
|
||||
{
|
||||
while (!stop.IsSet)
|
||||
@@ -114,11 +122,13 @@ public sealed class AbLegacyDisposeAndResolveHostTests
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Disposes the internal queue.</summary>
|
||||
public void Dispose() => _queue.Dispose();
|
||||
}
|
||||
|
||||
// ---- Driver.AbLegacy-013 ----
|
||||
|
||||
/// <summary>Verifies that ResolveHost returns the configured device for a known tag reference.</summary>
|
||||
[Fact]
|
||||
public void ResolveHost_known_reference_returns_tag_device()
|
||||
{
|
||||
@@ -130,6 +140,7 @@ public sealed class AbLegacyDisposeAndResolveHostTests
|
||||
drv.ResolveHost("X").ShouldBe("ab://10.0.0.5/1,0");
|
||||
}
|
||||
|
||||
/// <summary>Verifies that ResolveHost returns the first configured device when reference is unknown.</summary>
|
||||
[Fact]
|
||||
public void ResolveHost_unknown_reference_with_devices_returns_first_device()
|
||||
{
|
||||
@@ -146,6 +157,7 @@ public sealed class AbLegacyDisposeAndResolveHostTests
|
||||
drv.ResolveHost("unknown").ShouldBe("ab://10.0.0.5/1,0");
|
||||
}
|
||||
|
||||
/// <summary>Verifies that ResolveHost returns the driver instance ID when no devices are configured.</summary>
|
||||
[Fact]
|
||||
public void ResolveHost_unknown_reference_no_devices_returns_driver_instance_id()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user