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
@@ -13,12 +13,17 @@ public sealed class ModbusCapTests
/// </summary>
private sealed class RecordingTransport : IModbusTransport
{
/// <summary>Gets the simulated holding register storage.</summary>
public readonly ushort[] HoldingRegisters = new ushort[1024];
/// <summary>Gets the list of all FC03 read requests made to the transport.</summary>
public readonly List<(ushort Address, ushort Quantity)> Fc03Requests = new();
/// <summary>Gets the list of all FC16 write requests made to the transport.</summary>
public readonly List<(ushort Address, ushort Quantity)> Fc16Requests = new();
/// <inheritdoc />
public Task ConnectAsync(CancellationToken ct) => Task.CompletedTask;
/// <inheritdoc />
public Task<byte[]> SendAsync(byte unitId, byte[] pdu, CancellationToken ct)
{
var fc = pdu[0];
@@ -50,9 +55,11 @@ public sealed class ModbusCapTests
return Task.FromException<byte[]>(new ModbusException(fc, 0x01, $"fc={fc} unsupported"));
}
/// <inheritdoc />
public ValueTask DisposeAsync() => ValueTask.CompletedTask;
}
/// <summary>Verifies that a read within the cap issues a single FC03 request.</summary>
[Fact]
public async Task Read_within_cap_issues_single_FC03_request()
{
@@ -69,6 +76,7 @@ public sealed class ModbusCapTests
transport.Fc03Requests[0].Quantity.ShouldBe((ushort)20);
}
/// <summary>Verifies that a read above cap splits into two FC03 requests.</summary>
[Fact]
public async Task Read_above_cap_splits_into_two_FC03_requests()
{
@@ -103,6 +111,7 @@ public sealed class ModbusCapTests
s[0].ShouldBe('A'); // register[100] high byte
}
/// <summary>Verifies that read cap honors Mitsubishi lower cap of 64 registers.</summary>
[Fact]
public async Task Read_cap_honors_Mitsubishi_lower_cap_of_64()
{
@@ -121,6 +130,7 @@ public sealed class ModbusCapTests
transport.Fc03Requests[1].Quantity.ShouldBe((ushort)36);
}
/// <summary>Verifies that write exceeding cap throws instead of splitting.</summary>
[Fact]
public async Task Write_exceeding_cap_throws_instead_of_splitting()
{
@@ -144,6 +154,7 @@ public sealed class ModbusCapTests
transport.Fc16Requests.Count.ShouldBe(0);
}
/// <summary>Verifies that write within cap proceeds normally.</summary>
[Fact]
public async Task Write_within_cap_proceeds_normally()
{