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,7 @@ namespace ZB.MOM.WW.OtOpcUa.Core.Tests.Resilience;
[Trait("Category", "Unit")]
public sealed class DriverResilienceOptionsParserTests
{
/// <summary>Verifies that null JSON returns pure tier defaults.</summary>
[Fact]
public void NullJson_ReturnsPureTierDefaults()
{
@@ -19,6 +20,7 @@ public sealed class DriverResilienceOptionsParserTests
DriverResilienceOptions.GetTierDefaults(DriverTier.A)[DriverCapability.Read]);
}
/// <summary>Verifies that whitespace JSON returns defaults.</summary>
[Fact]
public void WhitespaceJson_ReturnsDefaults()
{
@@ -26,6 +28,7 @@ public sealed class DriverResilienceOptionsParserTests
diag.ShouldBeNull();
}
/// <summary>Verifies that malformed JSON falls back with diagnostic.</summary>
[Fact]
public void MalformedJson_FallsBack_WithDiagnostic()
{
@@ -38,6 +41,7 @@ public sealed class DriverResilienceOptionsParserTests
DriverResilienceOptions.GetTierDefaults(DriverTier.A)[DriverCapability.Read]);
}
/// <summary>Verifies that empty object returns defaults.</summary>
[Fact]
public void EmptyObject_ReturnsDefaults()
{
@@ -48,6 +52,7 @@ public sealed class DriverResilienceOptionsParserTests
DriverResilienceOptions.GetTierDefaults(DriverTier.A)[DriverCapability.Write]);
}
/// <summary>Verifies that Read override is merged into tier defaults.</summary>
[Fact]
public void ReadOverride_MergedIntoTierDefaults()
{
@@ -72,6 +77,7 @@ public sealed class DriverResilienceOptionsParserTests
DriverResilienceOptions.GetTierDefaults(DriverTier.A)[DriverCapability.Write]);
}
/// <summary>Verifies that partial policy fills missing fields from tier default.</summary>
[Fact]
public void PartialPolicy_FillsMissingFieldsFromTierDefault()
{
@@ -92,6 +98,7 @@ public sealed class DriverResilienceOptionsParserTests
read.BreakerFailureThreshold.ShouldBe(tierDefault.BreakerFailureThreshold);
}
/// <summary>Verifies that bulkhead overrides are honored.</summary>
[Fact]
public void BulkheadOverrides_AreHonored()
{
@@ -105,6 +112,7 @@ public sealed class DriverResilienceOptionsParserTests
options.BulkheadMaxQueue.ShouldBe(500);
}
/// <summary>Verifies that unknown capability surfaces in diagnostic but does not fail.</summary>
[Fact]
public void UnknownCapability_Surfaces_InDiagnostic_ButDoesNotFail()
{
@@ -125,6 +133,7 @@ public sealed class DriverResilienceOptionsParserTests
DriverResilienceOptions.GetTierDefaults(DriverTier.A)[DriverCapability.Read]);
}
/// <summary>Verifies that property names are case insensitive.</summary>
[Fact]
public void PropertyNames_AreCaseInsensitive()
{
@@ -137,6 +146,7 @@ public sealed class DriverResilienceOptionsParserTests
options.BulkheadMaxConcurrent.ShouldBe(42);
}
/// <summary>Verifies that capability name is case insensitive.</summary>
[Fact]
public void CapabilityName_IsCaseInsensitive()
{
@@ -150,6 +160,8 @@ public sealed class DriverResilienceOptionsParserTests
options.Resolve(DriverCapability.Read).RetryCount.ShouldBe(99);
}
/// <summary>Verifies that every tier with empty JSON round-trips its defaults.</summary>
/// <param name="tier">The driver tier to test.</param>
[Theory]
[InlineData(DriverTier.A)]
[InlineData(DriverTier.B)]
@@ -164,6 +176,7 @@ public sealed class DriverResilienceOptionsParserTests
options.Resolve(cap).ShouldBe(DriverResilienceOptions.GetTierDefaults(tier)[cap]);
}
/// <summary>Verifies that RecycleIntervalSeconds on Tier C with positive value parses and surfaces.</summary>
[Fact]
public void RecycleIntervalSeconds_TierC_PositiveValue_ParsesAndSurfaces()
{
@@ -174,6 +187,7 @@ public sealed class DriverResilienceOptionsParserTests
options.RecycleIntervalSeconds.ShouldBe(3600);
}
/// <summary>Verifies that RecycleIntervalSeconds when null defaults to null.</summary>
[Fact]
public void RecycleIntervalSeconds_Null_DefaultsToNull()
{
@@ -181,6 +195,8 @@ public sealed class DriverResilienceOptionsParserTests
options.RecycleIntervalSeconds.ShouldBeNull();
}
/// <summary>Verifies that RecycleIntervalSeconds on Tier A or B is rejected with diagnostic.</summary>
/// <param name="tier">The driver tier to test.</param>
[Theory]
[InlineData(DriverTier.A)]
[InlineData(DriverTier.B)]
@@ -196,6 +212,7 @@ public sealed class DriverResilienceOptionsParserTests
diag.ShouldContain("Tier C only");
}
/// <summary>Verifies that RecycleIntervalSeconds with non-positive value is rejected with diagnostic.</summary>
[Fact]
public void RecycleIntervalSeconds_NonPositive_Rejected_With_Diagnostic()
{