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,11 +22,14 @@ public sealed class ModbusTcpReconnectTests
private sealed class FlakeyModbusServer : IAsyncDisposable
{
private readonly TcpListener _listener;
/// <summary>Gets the TCP port the server is listening on.</summary>
public int Port => ((IPEndPoint)_listener.LocalEndpoint).Port;
/// <summary>Gets or sets the number of transactions to complete before closing the connection.</summary>
public int DropAfterNTransactions { get; set; } = int.MaxValue;
private readonly CancellationTokenSource _stop = new();
private int _txCount;
/// <summary>Initializes a new instance and starts listening on a loopback port.</summary>
public FlakeyModbusServer()
{
_listener = new TcpListener(IPAddress.Loopback, 0);
@@ -103,6 +106,7 @@ public sealed class ModbusTcpReconnectTests
return true;
}
/// <summary>Stops the server and releases resources.</summary>
public async ValueTask DisposeAsync()
{
_stop.Cancel();
@@ -111,6 +115,7 @@ public sealed class ModbusTcpReconnectTests
}
}
/// <summary>Verifies that the transport recovers from a mid-session socket drop with auto-reconnect enabled.</summary>
[Fact]
public async Task Transport_recovers_from_mid_session_drop_and_retries_successfully()
{
@@ -130,6 +135,7 @@ public sealed class ModbusTcpReconnectTests
second[0].ShouldBe((byte)0x03);
}
/// <summary>Verifies that socket drops propagate to the caller when auto-reconnect is disabled.</summary>
[Fact]
public async Task Transport_without_AutoReconnect_propagates_drop_to_caller()
{