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.AbLegacy.Tests;
[Trait("Category", "Unit")]
public sealed class AbLegacyDriverTests
{
/// <summary>Verifies that driver type is AbLegacy.</summary>
[Fact]
public void DriverType_is_AbLegacy()
{
@@ -17,6 +18,7 @@ public sealed class AbLegacyDriverTests
drv.DriverInstanceId.ShouldBe("drv-1");
}
/// <summary>Verifies that InitializeAsync with devices assigns family profiles.</summary>
[Fact]
public async Task InitializeAsync_with_devices_assigns_family_profiles()
{
@@ -38,6 +40,7 @@ public sealed class AbLegacyDriverTests
drv.GetDeviceState("ab://10.0.0.7/1,0")!.Profile.ShouldBe(AbLegacyPlcFamilyProfile.Plc5);
}
/// <summary>Verifies that InitializeAsync with malformed host address faults.</summary>
[Fact]
public async Task InitializeAsync_with_malformed_host_address_faults()
{
@@ -51,6 +54,7 @@ public sealed class AbLegacyDriverTests
drv.GetHealth().State.ShouldBe(DriverState.Faulted);
}
/// <summary>Verifies that ShutdownAsync clears devices.</summary>
[Fact]
public async Task ShutdownAsync_clears_devices()
{
@@ -65,6 +69,7 @@ public sealed class AbLegacyDriverTests
drv.GetHealth().State.ShouldBe(DriverState.Unknown);
}
/// <summary>Verifies that family profiles expose expected defaults.</summary>
[Fact]
public void Family_profiles_expose_expected_defaults()
{
@@ -82,6 +87,9 @@ public sealed class AbLegacyDriverTests
AbLegacyPlcFamilyProfile.LogixPccc.SupportsLongFile.ShouldBeTrue();
}
/// <summary>Verifies that ForFamily dispatches correctly.</summary>
/// <param name="family">The PLC family to dispatch for.</param>
/// <param name="expectedAttribute">The expected libplctag PLC attribute.</param>
[Theory]
[InlineData(AbLegacyPlcFamily.Slc500, "slc500")]
[InlineData(AbLegacyPlcFamily.MicroLogix, "micrologix")]
@@ -92,6 +100,7 @@ public sealed class AbLegacyDriverTests
AbLegacyPlcFamilyProfile.ForFamily(family).LibplctagPlcAttribute.ShouldBe(expectedAttribute);
}
/// <summary>Verifies that data type mapping covers atomic PCCC types.</summary>
[Fact]
public void DataType_mapping_covers_atomic_pccc_types()
{
@@ -105,6 +114,7 @@ public sealed class AbLegacyDriverTests
// ---- Driver.AbLegacy-012: profile fields consumed ----
/// <summary>Verifies that EffectiveCipPath falls back to profile default when host path is empty.</summary>
[Fact]
public async Task EffectiveCipPath_falls_back_to_profile_default_when_host_path_is_empty()
{
@@ -124,6 +134,7 @@ public sealed class AbLegacyDriverTests
factory.Tags["N7:0"].CreationParams.CipPath.ShouldBe("1,0");
}
/// <summary>Verifies that EffectiveCipPath preserves explicit host path.</summary>
[Fact]
public async Task EffectiveCipPath_preserves_explicit_host_path()
{
@@ -142,6 +153,7 @@ public sealed class AbLegacyDriverTests
factory.Tags["N7:0"].CreationParams.CipPath.ShouldBe("1,2");
}
/// <summary>Verifies that long tag on MicroLogix device is rejected at initialization.</summary>
[Fact]
public async Task Long_tag_on_MicroLogix_device_rejected_at_init()
{
@@ -157,6 +169,7 @@ public sealed class AbLegacyDriverTests
ex.Message.ShouldContain("L-files");
}
/// <summary>Verifies that long tag on SLC 500 device is accepted.</summary>
[Fact]
public async Task Long_tag_on_Slc500_device_accepted()
{
@@ -172,6 +185,7 @@ public sealed class AbLegacyDriverTests
drv.GetHealth().State.ShouldBe(DriverState.Healthy);
}
/// <summary>Verifies that string tag on PLC-5 device is rejected at initialization.</summary>
[Fact]
public async Task String_tag_on_Plc5_device_rejected_at_init()
{