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 AbCipDriverTests
{
/// <summary>Verifies AbCipDriver reports correct driver type and instance ID.</summary>
[Fact]
public void DriverType_is_AbCip()
{
@@ -17,6 +18,7 @@ public sealed class AbCipDriverTests
drv.DriverInstanceId.ShouldBe("drv-1");
}
/// <summary>Verifies InitializeAsync with no devices succeeds and marks driver healthy.</summary>
[Fact]
public async Task InitializeAsync_with_empty_devices_succeeds_and_marks_healthy()
{
@@ -25,6 +27,7 @@ public sealed class AbCipDriverTests
drv.GetHealth().State.ShouldBe(DriverState.Healthy);
}
/// <summary>Verifies InitializeAsync registers devices with their respective PLC family profiles.</summary>
[Fact]
public async Task InitializeAsync_registers_each_device_with_its_family_profile()
{
@@ -44,6 +47,7 @@ public sealed class AbCipDriverTests
drv.GetDeviceState("ab://10.0.0.6/")!.Profile.ShouldBe(AbCipPlcFamilyProfile.Micro800);
}
/// <summary>Verifies InitializeAsync rejects malformed host addresses and faults the driver.</summary>
[Fact]
public async Task InitializeAsync_with_malformed_host_address_faults()
{
@@ -57,6 +61,7 @@ public sealed class AbCipDriverTests
drv.GetHealth().State.ShouldBe(DriverState.Faulted);
}
/// <summary>Verifies ShutdownAsync clears devices and marks driver state unknown.</summary>
[Fact]
public async Task ShutdownAsync_clears_devices_and_marks_unknown()
{
@@ -73,6 +78,7 @@ public sealed class AbCipDriverTests
drv.GetHealth().State.ShouldBe(DriverState.Unknown);
}
/// <summary>Verifies ReinitializeAsync stops and restarts all devices.</summary>
[Fact]
public async Task ReinitializeAsync_cycles_devices()
{
@@ -88,6 +94,7 @@ public sealed class AbCipDriverTests
drv.GetHealth().State.ShouldBe(DriverState.Healthy);
}
/// <summary>Verifies PLC family profiles expose expected default configuration values.</summary>
[Fact]
public void Family_profiles_expose_expected_defaults()
{
@@ -103,6 +110,7 @@ public sealed class AbCipDriverTests
AbCipPlcFamilyProfile.GuardLogix.LibplctagPlcAttribute.ShouldBe("controllogix");
}
/// <summary>Verifies AB CIP atomic data types map correctly to driver data types.</summary>
[Fact]
public void AbCipDataType_maps_atomics_to_driver_types()
{