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.Host.IntegrationTests;
/// </summary>
public sealed class RoslynScriptedAlarmEvaluatorTests
{
/// <summary>Verifies evaluation of predicate returning true reports Active.</summary>
[Fact]
public void Evaluate_predicate_returning_true_reports_Active()
{
@@ -27,6 +28,7 @@ public sealed class RoslynScriptedAlarmEvaluatorTests
result.Active.ShouldBeTrue();
}
/// <summary>Verifies evaluation of predicate returning false reports Inactive.</summary>
[Fact]
public void Evaluate_predicate_returning_false_reports_Inactive()
{
@@ -41,6 +43,7 @@ public sealed class RoslynScriptedAlarmEvaluatorTests
result.Active.ShouldBeFalse();
}
/// <summary>Verifies compiled predicates are cached across calls.</summary>
[Fact]
public void Evaluate_caches_compiled_predicate_across_calls()
{
@@ -54,6 +57,7 @@ public sealed class RoslynScriptedAlarmEvaluatorTests
second.Active.ShouldBeFalse();
}
/// <summary>Verifies compile errors return Failure.</summary>
[Fact]
public void Evaluate_compile_error_returns_Failure()
{
@@ -65,6 +69,7 @@ public sealed class RoslynScriptedAlarmEvaluatorTests
result.Reason!.ShouldContain("compile");
}
/// <summary>Verifies predicate writing virtual tag returns Failure.</summary>
[Fact]
public void Evaluate_predicate_writing_virtual_tag_returns_Failure()
{
@@ -80,6 +85,7 @@ public sealed class RoslynScriptedAlarmEvaluatorTests
result.Reason!.ShouldContain("threw");
}
/// <summary>Verifies empty predicate returns Failure.</summary>
[Fact]
public void Evaluate_empty_predicate_returns_Failure()
{
@@ -88,6 +94,7 @@ public sealed class RoslynScriptedAlarmEvaluatorTests
sut.Evaluate("alarm-empty", "", new Dictionary<string, object?>()).Success.ShouldBeFalse();
}
/// <summary>Verifies evaluation after dispose returns Failure.</summary>
[Fact]
public void Evaluate_after_dispose_returns_Failure()
{