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
@@ -8,6 +8,8 @@ namespace ZB.MOM.WW.OtOpcUa.Core.Tests.Resilience;
[Trait("Category", "Unit")]
public sealed class DriverResilienceOptionsTests
{
/// <summary>Verifies that tier defaults cover every capability.</summary>
/// <param name="tier">The driver tier to test.</param>
[Theory]
[InlineData(DriverTier.A)]
[InlineData(DriverTier.B)]
@@ -20,6 +22,8 @@ public sealed class DriverResilienceOptionsTests
defaults.ShouldContainKey(capability);
}
/// <summary>Verifies that write never retries by default.</summary>
/// <param name="tier">The driver tier to test.</param>
[Theory]
[InlineData(DriverTier.A)]
[InlineData(DriverTier.B)]
@@ -30,6 +34,8 @@ public sealed class DriverResilienceOptionsTests
defaults[DriverCapability.Write].RetryCount.ShouldBe(0);
}
/// <summary>Verifies that alarm acknowledge never retries by default.</summary>
/// <param name="tier">The driver tier to test.</param>
[Theory]
[InlineData(DriverTier.A)]
[InlineData(DriverTier.B)]
@@ -40,6 +46,9 @@ public sealed class DriverResilienceOptionsTests
defaults[DriverCapability.AlarmAcknowledge].RetryCount.ShouldBe(0);
}
/// <summary>Verifies that idempotent capabilities retry by default.</summary>
/// <param name="tier">The driver tier to test.</param>
/// <param name="capability">The driver capability to test.</param>
[Theory]
[InlineData(DriverTier.A, DriverCapability.Read)]
[InlineData(DriverTier.A, DriverCapability.HistoryRead)]
@@ -52,6 +61,7 @@ public sealed class DriverResilienceOptionsTests
defaults[capability].RetryCount.ShouldBeGreaterThan(0);
}
/// <summary>Verifies that TierC disables circuit breaker deferring to supervisor.</summary>
[Fact]
public void TierC_DisablesCircuitBreaker_DeferringToSupervisor()
{
@@ -61,6 +71,8 @@ public sealed class DriverResilienceOptionsTests
policy.BreakerFailureThreshold.ShouldBe(0, "Tier C breaker is handled by the Proxy supervisor (decision #68)");
}
/// <summary>Verifies that TierA and TierB enable circuit breaker.</summary>
/// <param name="tier">The driver tier to test.</param>
[Theory]
[InlineData(DriverTier.A)]
[InlineData(DriverTier.B)]
@@ -72,6 +84,7 @@ public sealed class DriverResilienceOptionsTests
policy.BreakerFailureThreshold.ShouldBeGreaterThan(0);
}
/// <summary>Verifies that resolve uses tier defaults when no override is set.</summary>
[Fact]
public void Resolve_Uses_TierDefaults_When_NoOverride()
{
@@ -82,6 +95,7 @@ public sealed class DriverResilienceOptionsTests
resolved.ShouldBe(DriverResilienceOptions.GetTierDefaults(DriverTier.A)[DriverCapability.Read]);
}
/// <summary>Verifies that resolve uses override when configured.</summary>
[Fact]
public void Resolve_Uses_Override_When_Configured()
{
@@ -106,6 +120,7 @@ public sealed class DriverResilienceOptionsTests
/// enum-only addition that forgets to update <c>GetTierDefaults</c> would otherwise blow up
/// on the hot path with <see cref="KeyNotFoundException"/>.
/// </summary>
/// <param name="tier">The driver tier to test.</param>
[Theory]
[InlineData(DriverTier.A)]
[InlineData(DriverTier.B)]