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
@@ -22,6 +22,10 @@ public static class S7_1500Profile
/// <summary>Value the smoke test writes then reads back.</summary>
public const short SmokeHoldingValue = 4321;
/// <summary>Builds Modbus driver options for the S7-1500 profile.</summary>
/// <param name="host">The host address of the Modbus device.</param>
/// <param name="port">The port number of the Modbus device.</param>
/// <returns>The configured Modbus driver options.</returns>
public static ModbusDriverOptions BuildOptions(string host, int port) => new()
{
Host = host,
@@ -24,6 +24,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.IntegrationTests.S7;
[Trait("Device", "S7")]
public sealed class S7_1500SmokeTests(ModbusSimulatorFixture sim)
{
/// <summary>Verifies that an S7-1500 roundtrip write then read of a holding register succeeds.</summary>
[Fact]
public async Task S7_1500_roundtrip_write_then_read_of_holding_register()
{
@@ -16,6 +16,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.IntegrationTests.S7;
[Trait("Device", "S7")]
public sealed class S7_ByteOrderTests(ModbusSimulatorFixture sim)
{
/// <summary>Verifies that S7 Float32 with ABCD byte order correctly decodes 1.5f from HR100.</summary>
[Fact]
public async Task S7_Float32_ABCD_decodes_1_5f_from_HR100()
{
@@ -61,6 +62,7 @@ public sealed class S7_ByteOrderTests(ModbusSimulatorFixture sim)
results[1].Value.ShouldNotBe(1.5f, "applying CDAB swap to S7 ABCD bytes must produce a different value — confirms the flag is not a no-op and S7 profile default must be BigEndian");
}
/// <summary>Verifies that S7 Int32 with ABCD byte order correctly decodes 0x12345678 from HR300.</summary>
[Fact]
public async Task S7_Int32_ABCD_decodes_0x12345678_from_HR300()
{
@@ -95,6 +97,7 @@ public sealed class S7_ByteOrderTests(ModbusSimulatorFixture sim)
"S7 Int32 stored as HR[300]=0x1234, HR[301]=0x5678 with ABCD order decodes to 0x12345678 — DL260 would store the reverse order");
}
/// <summary>Verifies that S7 DB1 fingerprint marker reads 0xABCD from HR0.</summary>
[Fact]
public async Task S7_DB1_fingerprint_marker_at_HR0_reads_0xABCD()
{