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
@@ -17,6 +17,7 @@ public sealed class ReconnectSupervisorTests
new(InitialBackoffOverride: TimeSpan.FromMilliseconds(5),
MaxBackoffOverride: TimeSpan.FromMilliseconds(20));
/// <summary>Verifies that the supervisor starts in a healthy state with no errors.</summary>
[Fact]
public void InitialState_IsHealthy()
{
@@ -26,6 +27,7 @@ public sealed class ReconnectSupervisorTests
sup.LastError.ShouldBeNull();
}
/// <summary>Verifies that reporting a transport failure drives the supervisor through reopen and replay cycles back to healthy.</summary>
[Fact]
public async Task ReportTransportFailure_DrivesThroughReopenReplay_BackToHealthy()
{
@@ -54,6 +56,7 @@ public sealed class ReconnectSupervisorTests
sup.IsDegraded.ShouldBeFalse();
}
/// <summary>Verifies that reopen failures trigger retries and the supervisor stays in reopening state between attempts.</summary>
[Fact]
public async Task ReopenFailure_RetriesUntilSuccess_StaysInReopeningBetweenAttempts()
{
@@ -71,6 +74,7 @@ public sealed class ReconnectSupervisorTests
sup.LastError.ShouldBeNull(); // cleared on Healthy transition
}
/// <summary>Verifies that replay failures trigger a retry of the entire reopen-replay cycle.</summary>
[Fact]
public async Task ReplayFailure_RetriesEntireCycle()
{
@@ -90,6 +94,7 @@ public sealed class ReconnectSupervisorTests
sup.CurrentState.ShouldBe(ReconnectSupervisor.State.Healthy);
}
/// <summary>Verifies that repeated failure reports during recovery do not spawn parallel recovery loops.</summary>
[Fact]
public async Task RepeatedFailureReports_DuringRecovery_DoNotSpawnParallelLoops()
{
@@ -116,6 +121,7 @@ public sealed class ReconnectSupervisorTests
attempts.ShouldBe(1);
}
/// <summary>Verifies that the last error reflects the most recent failure cause from recovery attempts.</summary>
[Fact]
public async Task LastError_ReflectsMostRecentFailureCause()
{
@@ -134,6 +140,7 @@ public sealed class ReconnectSupervisorTests
sup.LastError.ShouldContain("reopen broke"); // updates from the loop's failed reopen attempts
}
/// <summary>Verifies that disposing the supervisor cancels a running recovery loop cleanly.</summary>
[Fact]
public async Task Dispose_CancelsRunningRecoveryLoop_Cleanly()
{
@@ -153,6 +160,7 @@ public sealed class ReconnectSupervisorTests
cancelled.ShouldBeTrue();
}
/// <summary>Verifies that reporting a transport failure after dispose throws ObjectDisposedException.</summary>
[Fact]
public void ReportTransportFailure_AfterDispose_Throws()
{
@@ -161,6 +169,7 @@ public sealed class ReconnectSupervisorTests
Should.Throw<ObjectDisposedException>(() => sup.ReportTransportFailure(new IOException("x")));
}
/// <summary>Verifies that waiting for healthy state returns immediately when already healthy.</summary>
[Fact]
public async Task WaitForHealthy_ReturnsImmediately_WhenAlreadyHealthy()
{