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
@@ -11,6 +11,7 @@ namespace ZB.MOM.WW.OtOpcUa.Core.Tests.Observability;
[Trait("Category", "Integration")]
public sealed class CapabilityInvokerEnrichmentTests
{
/// <summary>Verifies that InvokerExecute logs inside call site with structured properties.</summary>
[Fact]
public async Task InvokerExecute_LogsInsideCallSite_CarryStructuredProperties()
{
@@ -43,6 +44,7 @@ public sealed class CapabilityInvokerEnrichmentTests
evt.Properties.ShouldContainKey("CorrelationId");
}
/// <summary>Verifies that InvokerExecute does not leak context outside the call site.</summary>
[Fact]
public async Task InvokerExecute_DoesNotLeak_ContextOutsideCallSite()
{
@@ -66,7 +68,10 @@ public sealed class CapabilityInvokerEnrichmentTests
private sealed class InMemorySink : ILogEventSink
{
/// <summary>Gets the list of captured log events.</summary>
public List<LogEvent> Events { get; } = [];
/// <summary>Emits a log event by adding it to the captured events list.</summary>
/// <param name="logEvent">The log event to emit.</param>
public void Emit(LogEvent logEvent) => Events.Add(logEvent);
}
}
@@ -8,12 +8,14 @@ namespace ZB.MOM.WW.OtOpcUa.Core.Tests.Observability;
[Trait("Category", "Unit")]
public sealed class DriverHealthReportTests
{
/// <summary>Verifies that an empty fleet is healthy.</summary>
[Fact]
public void EmptyFleet_IsHealthy()
{
DriverHealthReport.Aggregate([]).ShouldBe(ReadinessVerdict.Healthy);
}
/// <summary>Verifies that a fleet with all healthy drivers is healthy.</summary>
[Fact]
public void AllHealthy_Fleet_IsHealthy()
{
@@ -24,6 +26,7 @@ public sealed class DriverHealthReportTests
verdict.ShouldBe(ReadinessVerdict.Healthy);
}
/// <summary>Verifies that any faulted driver trumps other states.</summary>
[Fact]
public void AnyFaulted_TrumpsEverything()
{
@@ -36,6 +39,8 @@ public sealed class DriverHealthReportTests
verdict.ShouldBe(ReadinessVerdict.Faulted);
}
/// <summary>Verifies that any not-ready driver without faults results in NotReady verdict.</summary>
/// <param name="initializingState">The driver state representing a not-ready condition.</param>
[Theory]
[InlineData(DriverState.Unknown)]
[InlineData(DriverState.Initializing)]
@@ -48,6 +53,7 @@ public sealed class DriverHealthReportTests
verdict.ShouldBe(ReadinessVerdict.NotReady);
}
/// <summary>Verifies that any degraded driver without faults or not-ready results in Degraded verdict.</summary>
[Fact]
public void Any_Degraded_WithoutFaultedOrNotReady_IsDegraded()
{
@@ -58,6 +64,9 @@ public sealed class DriverHealthReportTests
verdict.ShouldBe(ReadinessVerdict.Degraded);
}
/// <summary>Verifies that HTTP status codes match the readiness verdict state matrix.</summary>
/// <param name="verdict">The readiness verdict to test.</param>
/// <param name="expected">The expected HTTP status code.</param>
[Theory]
[InlineData(ReadinessVerdict.Healthy, 200)]
[InlineData(ReadinessVerdict.Degraded, 200)]
@@ -11,6 +11,7 @@ namespace ZB.MOM.WW.OtOpcUa.Core.Tests.Observability;
[Trait("Category", "Unit")]
public sealed class LogContextEnricherTests
{
/// <summary>Verifies that the scope attaches all four log context properties.</summary>
[Fact]
public void Scope_Attaches_AllFour_Properties()
{
@@ -32,6 +33,7 @@ public sealed class LogContextEnricherTests
evt.Properties["CorrelationId"].ToString().ShouldBe("\"abc123\"");
}
/// <summary>Verifies that scope disposal pops the log context properties.</summary>
[Fact]
public void Scope_Dispose_Pops_Properties()
{
@@ -52,6 +54,7 @@ public sealed class LogContextEnricherTests
captured.Events[1].Properties.ContainsKey("DriverInstanceId").ShouldBeFalse();
}
/// <summary>Verifies that NewCorrelationId returns a 12-character hexadecimal string.</summary>
[Fact]
public void NewCorrelationId_Returns_12_Hex_Chars()
{
@@ -60,6 +63,8 @@ public sealed class LogContextEnricherTests
id.ShouldMatch("^[0-9a-f]{12}$");
}
/// <summary>Verifies that Push throws when DriverInstanceId is missing or empty.</summary>
/// <param name="id">The driver instance ID value to test, or null.</param>
[Theory]
[InlineData(null)]
[InlineData("")]
@@ -72,7 +77,10 @@ public sealed class LogContextEnricherTests
private sealed class InMemorySink : ILogEventSink
{
/// <summary>Gets the list of captured log events.</summary>
public List<LogEvent> Events { get; } = [];
/// <summary>Emits a log event to the sink.</summary>
/// <param name="logEvent">The log event to emit.</param>
public void Emit(LogEvent logEvent) => Events.Add(logEvent);
}
}