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 ScriptContextTests
{
/// <summary>Verifies that Deadband returns false when the difference exactly equals the tolerance.</summary>
[Fact]
public void Deadband_returns_false_when_difference_equals_tolerance()
{
@@ -21,6 +22,7 @@ public sealed class ScriptContextTests
ScriptContext.Deadband(current: 10.5, previous: 10.0, tolerance: 0.5).ShouldBeFalse();
}
/// <summary>Verifies that Deadband returns true when the difference exceeds the tolerance.</summary>
[Fact]
public void Deadband_returns_true_when_difference_just_exceeds_tolerance()
{
@@ -28,12 +30,14 @@ public sealed class ScriptContextTests
ScriptContext.Deadband(current: 10.6, previous: 10.0, tolerance: 0.5).ShouldBeTrue();
}
/// <summary>Verifies that Deadband returns false when the difference is below the tolerance.</summary>
[Fact]
public void Deadband_returns_false_when_difference_just_below_tolerance()
{
ScriptContext.Deadband(current: 10.4, previous: 10.0, tolerance: 0.5).ShouldBeFalse();
}
/// <summary>Verifies that Deadband returns the same result regardless of the direction of change.</summary>
[Fact]
public void Deadband_is_symmetric_in_direction_of_change()
{
@@ -42,12 +46,14 @@ public sealed class ScriptContextTests
ScriptContext.Deadband(current: 11.0, previous: 10.0, tolerance: 0.5).ShouldBeTrue();
}
/// <summary>Verifies that Deadband returns false when current and previous values are equal.</summary>
[Fact]
public void Deadband_returns_false_when_values_are_equal()
{
ScriptContext.Deadband(current: 10.0, previous: 10.0, tolerance: 0.001).ShouldBeFalse();
}
/// <summary>Verifies that Deadband with zero tolerance trips on any non-zero difference.</summary>
[Fact]
public void Deadband_with_zero_tolerance_returns_true_for_any_difference()
{
@@ -57,6 +63,7 @@ public sealed class ScriptContextTests
ScriptContext.Deadband(current: 10.0, previous: 10.000001, tolerance: 0).ShouldBeTrue();
}
/// <summary>Verifies that Deadband with negative tolerance trips on any non-zero difference.</summary>
[Fact]
public void Deadband_with_negative_tolerance_always_trips_for_unequal_values()
{