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
@@ -8,6 +8,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.TwinCAT.Tests;
[Trait("Category", "Unit")]
public sealed class TwinCATDriverTests
{
/// <summary>Verifies that the driver type is correctly identified as TwinCAT.</summary>
[Fact]
public void DriverType_is_TwinCAT()
{
@@ -16,6 +17,7 @@ public sealed class TwinCATDriverTests
drv.DriverInstanceId.ShouldBe("drv-1");
}
/// <summary>Verifies that device addresses are parsed during initialization.</summary>
[Fact]
public async Task InitializeAsync_parses_device_addresses()
{
@@ -35,6 +37,7 @@ public sealed class TwinCATDriverTests
drv.GetDeviceState("ads://10.0.0.1.1.1:852")!.Options.DeviceName.ShouldBe("Machine2");
}
/// <summary>Verifies that malformed device addresses cause initialization to fault.</summary>
[Fact]
public async Task InitializeAsync_malformed_address_faults()
{
@@ -48,6 +51,7 @@ public sealed class TwinCATDriverTests
drv.GetHealth().State.ShouldBe(DriverState.Faulted);
}
/// <summary>Verifies that shutdown clears all devices.</summary>
[Fact]
public async Task ShutdownAsync_clears_devices()
{
@@ -63,6 +67,7 @@ public sealed class TwinCATDriverTests
drv.GetHealth().State.ShouldBe(DriverState.Unknown);
}
/// <summary>Verifies that reinitialization cycles devices.</summary>
[Fact]
public async Task ReinitializeAsync_cycles_devices()
{
@@ -78,6 +83,7 @@ public sealed class TwinCATDriverTests
drv.GetHealth().State.ShouldBe(DriverState.Healthy);
}
/// <summary>Verifies that data type mapping covers atomic IEC types.</summary>
[Fact]
public void DataType_mapping_covers_atomic_iec_types()
{
@@ -91,6 +97,9 @@ public sealed class TwinCATDriverTests
TwinCATDataType.Time.ToDriverDataType().ShouldBe(DriverDataType.UInt32);
}
/// <summary>Verifies that status mapper covers known ADS error codes.</summary>
/// <param name="adsError">The raw ADS error code to map.</param>
/// <param name="expected">The expected OPC UA status code after mapping.</param>
[Theory]
[InlineData(0u, TwinCATStatusMapper.Good)]
// Device-layer codes — confirmed from Beckhoff.TwinCAT.Ads 7.0.172 AdsErrorCode enum