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
@@ -9,6 +9,7 @@ public sealed class DriverResilienceStatusTrackerTests
{
private static readonly DateTime Now = new(2026, 4, 19, 12, 0, 0, DateTimeKind.Utc);
/// <summary>Verifies that TryGet returns null before any write operations.</summary>
[Fact]
public void TryGet_Returns_Null_Before_AnyWrite()
{
@@ -17,6 +18,7 @@ public sealed class DriverResilienceStatusTrackerTests
tracker.TryGet("drv", "host").ShouldBeNull();
}
/// <summary>Verifies that RecordFailure accumulates consecutive failures.</summary>
[Fact]
public void RecordFailure_Accumulates_ConsecutiveFailures()
{
@@ -29,6 +31,7 @@ public sealed class DriverResilienceStatusTrackerTests
tracker.TryGet("drv", "host")!.ConsecutiveFailures.ShouldBe(3);
}
/// <summary>Verifies that RecordSuccess resets consecutive failures to zero.</summary>
[Fact]
public void RecordSuccess_Resets_ConsecutiveFailures()
{
@@ -41,6 +44,7 @@ public sealed class DriverResilienceStatusTrackerTests
tracker.TryGet("drv", "host")!.ConsecutiveFailures.ShouldBe(0);
}
/// <summary>Verifies that RecordBreakerOpen populates the LastBreakerOpenUtc timestamp.</summary>
[Fact]
public void RecordBreakerOpen_Populates_LastBreakerOpenUtc()
{
@@ -51,6 +55,7 @@ public sealed class DriverResilienceStatusTrackerTests
tracker.TryGet("drv", "host")!.LastBreakerOpenUtc.ShouldBe(Now);
}
/// <summary>Verifies that RecordRecycle populates the LastRecycleUtc timestamp.</summary>
[Fact]
public void RecordRecycle_Populates_LastRecycleUtc()
{
@@ -61,6 +66,7 @@ public sealed class DriverResilienceStatusTrackerTests
tracker.TryGet("drv", "host")!.LastRecycleUtc.ShouldBe(Now);
}
/// <summary>Verifies that RecordFootprint captures baseline and current memory usage.</summary>
[Fact]
public void RecordFootprint_CapturesBaselineAndCurrent()
{
@@ -73,6 +79,7 @@ public sealed class DriverResilienceStatusTrackerTests
snap.CurrentFootprintBytes.ShouldBe(150_000_000);
}
/// <summary>Verifies that different hosts are tracked independently.</summary>
[Fact]
public void DifferentHosts_AreIndependent()
{
@@ -86,6 +93,7 @@ public sealed class DriverResilienceStatusTrackerTests
tracker.TryGet("drv", "host-b")!.ConsecutiveFailures.ShouldBe(1);
}
/// <summary>Verifies that Snapshot returns all tracked driver-host pairs.</summary>
[Fact]
public void Snapshot_ReturnsAll_TrackedPairs()
{
@@ -99,6 +107,7 @@ public sealed class DriverResilienceStatusTrackerTests
snapshot.Count.ShouldBe(3);
}
/// <summary>Verifies that concurrent writes do not lose failure records.</summary>
[Fact]
public void ConcurrentWrites_DoNotLose_Failures()
{