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
@@ -18,6 +18,9 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.IntegrationTests;
public sealed class AddressingGrammarTests
{
private readonly ModbusSimulatorFixture _sim;
/// <summary>Initializes a new instance of the AddressingGrammarTests class.</summary>
/// <param name="sim">The Modbus simulator fixture.</param>
public AddressingGrammarTests(ModbusSimulatorFixture sim) => _sim = sim;
private async Task<ModbusDriver> NewDriverAsync(params ModbusTagDefinition[] tags)
@@ -32,6 +35,7 @@ public sealed class AddressingGrammarTests
return drv;
}
/// <summary>Verifies that 5-digit and 6-digit Modicon formats map to the same wire offset.</summary>
[Fact]
public async Task Modicon_5_And_6_Digit_Both_Map_To_Same_Wire_Offset()
{
@@ -49,6 +53,7 @@ public sealed class AddressingGrammarTests
await drv.ShutdownAsync(CancellationToken.None);
}
/// <summary>Verifies that Float32 values roundtrip correctly with CDAB byte order.</summary>
[Fact]
public async Task Float32_With_CDAB_Roundtrips_Through_Wire()
{
@@ -70,6 +75,7 @@ public sealed class AddressingGrammarTests
await drv.ShutdownAsync(CancellationToken.None);
}
/// <summary>Verifies that Int16 array reads surface as typed arrays.</summary>
[Fact]
public async Task Int16_Array_Reads_Surface_As_Typed_Array()
{
@@ -86,6 +92,7 @@ public sealed class AddressingGrammarTests
await drv.ShutdownAsync(CancellationToken.None);
}
/// <summary>Verifies that block read coalescing reduces PDU count end-to-end.</summary>
[Fact]
public async Task Block_Read_Coalescing_Reduces_PDU_Count_End_To_End()
{