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
@@ -20,9 +20,13 @@ public sealed class ModbusCoalescingAutoRecoveryTests
/// </summary>
private sealed class ProtectedHoleTransport : IModbusTransport
{
/// <summary>Gets or sets the register address at which reads should fail with an exception.</summary>
public ushort ProtectedAddress { get; set; } = ushort.MaxValue;
/// <summary>Gets the list of all read requests made to the transport.</summary>
public readonly List<(byte Fc, ushort Address, ushort Quantity)> Reads = new();
/// <inheritdoc />
public Task ConnectAsync(CancellationToken ct) => Task.CompletedTask;
/// <inheritdoc />
public Task<byte[]> SendAsync(byte unitId, byte[] pdu, CancellationToken ct)
{
var addr = (ushort)((pdu[1] << 8) | pdu[2]);
@@ -45,9 +49,11 @@ public sealed class ModbusCoalescingAutoRecoveryTests
default: return Task.FromResult(new byte[] { pdu[0], 0, 0 });
}
}
/// <inheritdoc />
public ValueTask DisposeAsync() => ValueTask.CompletedTask;
}
/// <summary>Verifies that the first failure falls back to per-tag reads in the same scan.</summary>
[Fact]
public async Task First_Failure_Falls_Back_To_PerTag_Same_Scan()
{
@@ -75,6 +81,7 @@ public sealed class ModbusCoalescingAutoRecoveryTests
await drv.ShutdownAsync(CancellationToken.None);
}
/// <summary>Verifies that the second scan skips coalesced reads of prohibited ranges.</summary>
[Fact]
public async Task Second_Scan_Skips_Coalesced_Read_Of_Prohibited_Range()
{
@@ -104,6 +111,7 @@ public sealed class ModbusCoalescingAutoRecoveryTests
await drv.ShutdownAsync(CancellationToken.None);
}
/// <summary>Verifies that reprobe clears prohibition when the range becomes healthy.</summary>
[Fact]
public async Task Reprobe_Clears_Prohibition_When_Range_Becomes_Healthy()
{
@@ -133,6 +141,7 @@ public sealed class ModbusCoalescingAutoRecoveryTests
await drv.ShutdownAsync(CancellationToken.None);
}
/// <summary>Verifies that reprobe leaves prohibition in place when the range is still bad.</summary>
[Fact]
public async Task Reprobe_Leaves_Prohibition_When_Range_Is_Still_Bad()
{
@@ -156,6 +165,7 @@ public sealed class ModbusCoalescingAutoRecoveryTests
await drv.ShutdownAsync(CancellationToken.None);
}
/// <summary>Verifies that GetAutoProhibitedRanges surfaces an operator-visible snapshot.</summary>
[Fact]
public async Task GetAutoProhibitedRanges_Surfaces_Operator_Visible_Snapshot()
{
@@ -188,6 +198,7 @@ public sealed class ModbusCoalescingAutoRecoveryTests
await drv.ShutdownAsync(CancellationToken.None);
}
/// <summary>Verifies that tags outside prohibited ranges still coalesce.</summary>
[Fact]
public async Task Tags_Outside_Prohibited_Range_Still_Coalesce()
{