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
@@ -13,6 +13,7 @@ namespace ZB.MOM.WW.OtOpcUa.Core.Scripting.Tests;
[Trait("Category", "Unit")]
public sealed class TimedScriptEvaluatorTests
{
/// <summary>Verifies that fast scripts complete under timeout and return value.</summary>
[Fact]
public async Task Fast_script_completes_under_timeout_and_returns_value()
{
@@ -26,6 +27,7 @@ public sealed class TimedScriptEvaluatorTests
result.ShouldBe(42.0);
}
/// <summary>Verifies that scripts longer than timeout throw ScriptTimeoutException.</summary>
[Fact]
public async Task Script_longer_than_timeout_throws_ScriptTimeoutException()
{
@@ -47,6 +49,7 @@ public sealed class TimedScriptEvaluatorTests
ex.Message.ShouldContain("50.0");
}
/// <summary>Verifies that caller cancellation takes precedence over timeout.</summary>
[Fact]
public async Task Caller_cancellation_takes_precedence_over_timeout()
{
@@ -67,6 +70,7 @@ public sealed class TimedScriptEvaluatorTests
await timed.RunAsync(new FakeScriptContext(), cts.Token));
}
/// <summary>Verifies that default timeout is 250ms per plan.</summary>
[Fact]
public void Default_timeout_is_250ms_per_plan()
{
@@ -74,6 +78,7 @@ public sealed class TimedScriptEvaluatorTests
.ShouldBe(TimeSpan.FromMilliseconds(250));
}
/// <summary>Verifies that zero or negative timeout is rejected at construction.</summary>
[Fact]
public void Zero_or_negative_timeout_is_rejected_at_construction()
{
@@ -84,6 +89,7 @@ public sealed class TimedScriptEvaluatorTests
new TimedScriptEvaluator<FakeScriptContext, int>(inner, TimeSpan.FromMilliseconds(-1)));
}
/// <summary>Verifies that null inner evaluator is rejected.</summary>
[Fact]
public void Null_inner_is_rejected()
{
@@ -91,6 +97,7 @@ public sealed class TimedScriptEvaluatorTests
new TimedScriptEvaluator<FakeScriptContext, int>(null!));
}
/// <summary>Verifies that null context is rejected.</summary>
[Fact]
public void Null_context_is_rejected()
{
@@ -100,6 +107,7 @@ public sealed class TimedScriptEvaluatorTests
await timed.RunAsync(null!, TestContext.Current.CancellationToken));
}
/// <summary>Verifies that script exceptions propagate unwrapped.</summary>
[Fact]
public async Task Script_exception_propagates_unwrapped()
{
@@ -115,6 +123,7 @@ public sealed class TimedScriptEvaluatorTests
ex.Message.ShouldBe("script boom");
}
/// <summary>Verifies that ScriptTimeoutException message points at diagnostic path.</summary>
[Fact]
public async Task ScriptTimeoutException_message_points_at_diagnostic_path()
{
@@ -133,6 +142,7 @@ public sealed class TimedScriptEvaluatorTests
ex.Message.ShouldContain("widening the timeout");
}
/// <summary>Verifies that caller cancellation wins even when timeout fires first.</summary>
[Fact]
public async Task Caller_cancellation_wins_even_when_timeout_fires_first()
{