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
@@ -60,6 +60,10 @@ public sealed class ExceptionInjectionTests(ModbusSimulatorFixture sim)
return await driver.ReadAsync([tagName], TestContext.Current.CancellationToken);
}
/// <summary>Verifies that Modbus FC03 reads at injected exception addresses surface the expected OPC UA status codes.</summary>
/// <param name="address">The Modbus register address to read.</param>
/// <param name="expectedStatus">The expected OPC UA status code.</param>
/// <param name="scenario">Scenario description for assertion messages.</param>
[Theory]
[InlineData(1000, StatusBadNotSupported, "exc 0x01 (Illegal Function) -> BadNotSupported")]
[InlineData(1001, StatusBadOutOfRange, "exc 0x02 (Illegal Data Address) -> BadOutOfRange")]
@@ -77,6 +81,7 @@ public sealed class ExceptionInjectionTests(ModbusSimulatorFixture sim)
results[0].StatusCode.ShouldBe(expectedStatus, scenario);
}
/// <summary>Verifies that reads at non-injected addresses return Good status.</summary>
[Fact]
public async Task FC03_read_at_non_injected_address_returns_Good()
{
@@ -89,6 +94,10 @@ public sealed class ExceptionInjectionTests(ModbusSimulatorFixture sim)
results[0].Value.ShouldBe((ushort)5);
}
/// <summary>Verifies that Modbus FC06 writes at injected exception addresses surface the expected OPC UA status codes.</summary>
/// <param name="address">The Modbus register address to write.</param>
/// <param name="expectedStatus">The expected OPC UA status code.</param>
/// <param name="scenario">Scenario description for assertion messages.</param>
[Theory]
[InlineData(2000, StatusBadDeviceFailure, "exc 0x04 on FC06 -> BadDeviceFailure (CPU in PROGRAM mode)")]
[InlineData(2001, StatusBadDeviceFailure, "exc 0x06 on FC06 -> BadDeviceFailure (Server Busy)")]