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
@@ -15,7 +15,15 @@ public sealed class ModbusProtocolOptionsTests
private sealed class CapturingTransport : IModbusTransport
{
public readonly List<byte[]> Sent = new();
/// <summary>Asynchronously connects the transport.</summary>
/// <param name="ct">The cancellation token.</param>
/// <returns>A completed task.</returns>
public Task ConnectAsync(CancellationToken ct) => Task.CompletedTask;
/// <summary>Asynchronously sends a Modbus PDU and returns a response.</summary>
/// <param name="unitId">The Modbus unit ID.</param>
/// <param name="pdu">The protocol data unit to send.</param>
/// <param name="ct">The cancellation token.</param>
/// <returns>A task that returns the response bytes.</returns>
public Task<byte[]> SendAsync(byte unitId, byte[] pdu, CancellationToken ct)
{
Sent.Add(pdu);
@@ -45,9 +53,12 @@ public sealed class ModbusProtocolOptionsTests
return Task.FromResult(new byte[] { pdu[0], 0, 0 });
}
}
/// <summary>Asynchronously disposes the transport.</summary>
/// <returns>A completed task.</returns>
public ValueTask DisposeAsync() => ValueTask.CompletedTask;
}
/// <summary>Verifies that defaults match historical behavior.</summary>
[Fact]
public void Defaults_Match_Historical_Behaviour()
{
@@ -58,6 +69,7 @@ public sealed class ModbusProtocolOptionsTests
opts.DisableFC23.ShouldBeFalse();
}
/// <summary>Verifies that single coil write uses FC05 by default.</summary>
[Fact]
public async Task Single_Coil_Write_Uses_FC05_By_Default()
{
@@ -71,6 +83,7 @@ public sealed class ModbusProtocolOptionsTests
fake.Sent.Last()[0].ShouldBe((byte)0x05); // FC05 Write Single Coil
}
/// <summary>Verifies that single coil write uses FC15 when forced.</summary>
[Fact]
public async Task Single_Coil_Write_Uses_FC15_When_Forced()
{
@@ -85,6 +98,7 @@ public sealed class ModbusProtocolOptionsTests
fake.Sent.Last()[0].ShouldBe((byte)0x0F); // FC15 Write Multiple Coils
}
/// <summary>Verifies that single register write uses FC06 by default.</summary>
[Fact]
public async Task Single_Register_Write_Uses_FC06_By_Default()
{
@@ -98,6 +112,7 @@ public sealed class ModbusProtocolOptionsTests
fake.Sent.Last()[0].ShouldBe((byte)0x06); // FC06 Write Single Register
}
/// <summary>Verifies that single register write uses FC16 when forced.</summary>
[Fact]
public async Task Single_Register_Write_Uses_FC16_When_Forced()
{
@@ -112,6 +127,7 @@ public sealed class ModbusProtocolOptionsTests
fake.Sent.Last()[0].ShouldBe((byte)0x10); // FC16 Write Multiple Registers
}
/// <summary>Verifies that coil array read automatically chunks at MaxCoilsPerRead.</summary>
[Fact]
public async Task Coil_Array_Read_Auto_Chunks_At_MaxCoilsPerRead()
{