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
@@ -9,6 +9,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.AbCip.Tests;
[Trait("Category", "Unit")]
public sealed class AbCipHostProbeTests
{
/// <summary>Verifies that GetHostStatuses returns one entry per configured device.</summary>
[Fact]
public async Task GetHostStatuses_returns_one_entry_per_device()
{
@@ -29,6 +30,7 @@ public sealed class AbCipHostProbeTests
statuses.ShouldAllBe(s => s.State == HostState.Unknown);
}
/// <summary>Verifies that a successful probe read transitions the host state to Running.</summary>
[Fact]
public async Task Probe_with_successful_read_transitions_to_Running()
{
@@ -55,6 +57,7 @@ public sealed class AbCipHostProbeTests
await drv.ShutdownAsync(CancellationToken.None);
}
/// <summary>Verifies that a failed probe read transitions the host state to Stopped.</summary>
[Fact]
public async Task Probe_with_read_failure_transitions_to_Stopped()
{
@@ -83,6 +86,7 @@ public sealed class AbCipHostProbeTests
await drv.ShutdownAsync(CancellationToken.None);
}
/// <summary>Verifies that the probe is disabled when the Enabled option is false.</summary>
[Fact]
public async Task Probe_disabled_when_Enabled_is_false()
{
@@ -103,6 +107,7 @@ public sealed class AbCipHostProbeTests
await drv.ShutdownAsync(CancellationToken.None);
}
/// <summary>Verifies that the probe is skipped when ProbeTagPath is null.</summary>
[Fact]
public async Task Probe_skipped_when_ProbeTagPath_is_null()
{
@@ -119,6 +124,7 @@ public sealed class AbCipHostProbeTests
await drv.ShutdownAsync(CancellationToken.None);
}
/// <summary>Verifies that the probe loops across multiple devices independently.</summary>
[Fact]
public async Task Probe_loops_across_multiple_devices_independently()
{
@@ -155,6 +161,7 @@ public sealed class AbCipHostProbeTests
// ---- IPerCallHostResolver ----
/// <summary>Verifies that ResolveHost returns the declared device for a known tag.</summary>
[Fact]
public async Task ResolveHost_returns_declared_device_for_known_tag()
{
@@ -178,6 +185,7 @@ public sealed class AbCipHostProbeTests
drv.ResolveHost("B").ShouldBe("ab://10.0.0.6/1,0");
}
/// <summary>Verifies that ResolveHost falls back to the first device for an unknown tag reference.</summary>
[Fact]
public async Task ResolveHost_falls_back_to_first_device_for_unknown_reference()
{
@@ -191,6 +199,7 @@ public sealed class AbCipHostProbeTests
drv.ResolveHost("does-not-exist").ShouldBe("ab://10.0.0.5/1,0");
}
/// <summary>Verifies that ResolveHost falls back to the driver instance ID when no devices are configured.</summary>
[Fact]
public async Task ResolveHost_falls_back_to_DriverInstanceId_when_no_devices()
{
@@ -200,6 +209,7 @@ public sealed class AbCipHostProbeTests
drv.ResolveHost("anything").ShouldBe("drv-1");
}
/// <summary>Verifies that ResolveHost for a UDT member walks to the synthesized definition.</summary>
[Fact]
public async Task ResolveHost_for_UDT_member_walks_to_synthesised_definition()
{