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,11 +17,18 @@ public sealed class PerCallHostResolverDispatchTests
private sealed class StaticResolver : IPerCallHostResolver
{
private readonly Dictionary<string, string> _map;
/// <summary>Initializes a new instance of StaticResolver with a predefined mapping.</summary>
/// <param name="map">The mapping of full references to host names.</param>
public StaticResolver(Dictionary<string, string> map) => _map = map;
/// <summary>Resolves a host name from the static mapping.</summary>
/// <param name="fullReference">The full reference to resolve.</param>
public string ResolveHost(string fullReference) =>
_map.TryGetValue(fullReference, out var host) ? host : string.Empty;
}
/// <summary>Verifies that a dead PLC does not open the breaker for healthy PLCs when using a per-call resolver.</summary>
[Fact]
public async Task DeadPlc_DoesNotOpenBreaker_For_HealthyPlc_With_Resolver()
{
@@ -59,6 +66,7 @@ public sealed class PerCallHostResolverDispatchTests
aliveAttempts.ShouldBe(1, "decision #144 — per-PLC isolation keeps healthy PLCs serving");
}
/// <summary>Verifies that empty string from resolver is treated as single-host fallback.</summary>
[Fact]
public void Resolver_EmptyString_Treated_As_Single_Host_Fallback()
{
@@ -71,6 +79,7 @@ public sealed class PerCallHostResolverDispatchTests
resolver.ResolveHost("not-in-map").ShouldBe("", "unknown refs return empty so dispatch falls back to single-host");
}
/// <summary>Verifies that without a resolver, the same host shares one resilience pipeline.</summary>
[Fact]
public async Task WithoutResolver_SameHost_Shares_One_Pipeline()
{
@@ -88,6 +97,7 @@ public sealed class PerCallHostResolverDispatchTests
builder.CachedPipelineCount.ShouldBe(1, "single-host drivers share one pipeline");
}
/// <summary>Verifies that with a resolver, different hosts get separate resilience pipelines.</summary>
[Fact]
public async Task WithResolver_TwoHosts_Get_Two_Pipelines()
{