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
@@ -12,6 +12,7 @@ public sealed class DriverResiliencePipelineBuilderTests
{
private static readonly DriverResilienceOptions TierAOptions = new() { Tier = DriverTier.A };
/// <summary>Verifies that read operations retry transient failures.</summary>
[Fact]
public async Task Read_Retries_Transient_Failures()
{
@@ -29,6 +30,7 @@ public sealed class DriverResiliencePipelineBuilderTests
attempts.ShouldBe(3);
}
/// <summary>Verifies that write operations do not retry on failure.</summary>
[Fact]
public async Task Write_DoesNotRetry_OnFailure()
{
@@ -50,6 +52,7 @@ public sealed class DriverResiliencePipelineBuilderTests
ex.Message.ShouldBe("boom");
}
/// <summary>Verifies that alarm acknowledge operations do not retry on failure.</summary>
[Fact]
public async Task AlarmAcknowledge_DoesNotRetry_OnFailure()
{
@@ -70,6 +73,7 @@ public sealed class DriverResiliencePipelineBuilderTests
attempts.ShouldBe(1);
}
/// <summary>Verifies that pipelines are isolated per host.</summary>
[Fact]
public void Pipeline_IsIsolated_PerHost()
{
@@ -83,6 +87,7 @@ public sealed class DriverResiliencePipelineBuilderTests
builder.CachedPipelineCount.ShouldBe(2);
}
/// <summary>Verifies that pipelines are reused for the same driver, host, and capability triple.</summary>
[Fact]
public void Pipeline_IsReused_ForSameTriple()
{
@@ -96,6 +101,7 @@ public sealed class DriverResiliencePipelineBuilderTests
builder.CachedPipelineCount.ShouldBe(1);
}
/// <summary>Verifies that pipelines are isolated per capability.</summary>
[Fact]
public void Pipeline_IsIsolated_PerCapability()
{
@@ -108,6 +114,7 @@ public sealed class DriverResiliencePipelineBuilderTests
read.ShouldNotBeSameAs(write);
}
/// <summary>Verifies that a dead host does not open the breaker for a sibling host.</summary>
[Fact]
public async Task DeadHost_DoesNotOpenBreaker_ForSiblingHost()
{
@@ -138,6 +145,7 @@ public sealed class DriverResiliencePipelineBuilderTests
liveAttempts.ShouldBe(1, "healthy sibling host must not be affected by dead peer");
}
/// <summary>Verifies that the circuit breaker opens after the failure threshold on tier A.</summary>
[Fact]
public async Task CircuitBreaker_Opens_AfterFailureThreshold_OnTierA()
{
@@ -162,6 +170,7 @@ public sealed class DriverResiliencePipelineBuilderTests
}));
}
/// <summary>Verifies that timeout cancels slow operations.</summary>
[Fact]
public async Task Timeout_Cancels_SlowOperation()
{
@@ -183,6 +192,7 @@ public sealed class DriverResiliencePipelineBuilderTests
}));
}
/// <summary>Verifies that invalidate removes only the matching instance.</summary>
[Fact]
public void Invalidate_Removes_OnlyMatchingInstance()
{
@@ -200,6 +210,7 @@ public sealed class DriverResiliencePipelineBuilderTests
builder.CachedPipelineCount.ShouldBe(2);
}
/// <summary>Verifies that cancellation is not retried.</summary>
[Fact]
public async Task Cancellation_IsNot_Retried()
{
@@ -220,6 +231,7 @@ public sealed class DriverResiliencePipelineBuilderTests
attempts.ShouldBeLessThanOrEqualTo(1);
}
/// <summary>Verifies that the tracker records failure on every retry.</summary>
[Fact]
public async Task Tracker_RecordsFailure_OnEveryRetry()
{
@@ -240,6 +252,7 @@ public sealed class DriverResiliencePipelineBuilderTests
snap!.ConsecutiveFailures.ShouldBe(retryCount);
}
/// <summary>Verifies that the tracker stamps the breaker open when it trips.</summary>
[Fact]
public async Task Tracker_StampsBreakerOpen_WhenBreakerTrips()
{
@@ -263,6 +276,7 @@ public sealed class DriverResiliencePipelineBuilderTests
snap!.LastBreakerOpenUtc.ShouldNotBeNull();
}
/// <summary>Verifies that the tracker isolates counters per host.</summary>
[Fact]
public async Task Tracker_IsolatesCounters_PerHost()
{