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
@@ -14,6 +14,7 @@ namespace ZB.MOM.WW.OtOpcUa.Runtime.Tests.ScriptedAlarms;
public sealed class ScriptedAlarmActorTests : RuntimeActorTestBase
{
/// <summary>Verifies that full state cycle publishes StateChanged messages to parent at each transition.</summary>
[Fact]
public void Full_state_cycle_publishes_StateChanged_to_parent_at_each_transition()
{
@@ -33,6 +34,7 @@ public sealed class ScriptedAlarmActorTests : RuntimeActorTestBase
t3.State.ShouldBe(ScriptedAlarmActorState.Inactive);
}
/// <summary>Verifies that duplicate ConditionMet messages in Active state are ignored.</summary>
[Fact]
public void Duplicate_ConditionMet_in_Active_is_ignored()
{
@@ -46,6 +48,7 @@ public sealed class ScriptedAlarmActorTests : RuntimeActorTestBase
parent.ExpectNoMsg(TimeSpan.FromMilliseconds(200));
}
/// <summary>Verifies that active transition publishes AlarmTransitionEvent to the alerts topic.</summary>
[Fact]
public void Engine_active_transition_publishes_AlarmTransitionEvent_to_alerts_topic()
{
@@ -82,6 +85,7 @@ public sealed class ScriptedAlarmActorTests : RuntimeActorTestBase
}, duration: TimeSpan.FromSeconds(1));
}
/// <summary>Verifies that clear transition publishes Cleared event.</summary>
[Fact]
public void Engine_clear_transition_publishes_Cleared_event()
{
@@ -107,6 +111,7 @@ public sealed class ScriptedAlarmActorTests : RuntimeActorTestBase
}, duration: TimeSpan.FromSeconds(1));
}
/// <summary>Verifies that manual acknowledge emits Acknowledged transition with the user.</summary>
[Fact]
public void Manual_acknowledge_emits_Acknowledged_transition_with_user()
{
@@ -132,10 +137,16 @@ public sealed class ScriptedAlarmActorTests : RuntimeActorTestBase
}, duration: TimeSpan.FromSeconds(1));
}
/// <summary>A threshold-based alarm evaluator for testing.</summary>
private sealed class ThresholdEvaluator : IScriptedAlarmEvaluator
{
private readonly double _threshold;
/// <summary>Initializes a new instance of the ThresholdEvaluator class.</summary>
/// <param name="threshold">The threshold value to compare against.</param>
public ThresholdEvaluator(double threshold) { _threshold = threshold; }
/// <inheritdoc />
public ScriptedAlarmEvalResult Evaluate(string id, string predicate, IReadOnlyDictionary<string, object?> deps)
{
if (!deps.TryGetValue("temp", out var raw) || raw is null)
@@ -144,10 +155,18 @@ public sealed class ScriptedAlarmActorTests : RuntimeActorTestBase
}
}
/// <summary>A test publisher that captures published messages.</summary>
private sealed class CapturingPublisher
{
/// <summary>Gets the topics that messages were published to.</summary>
public ConcurrentBag<string> Topics { get; } = new();
/// <summary>Gets the payloads that were published.</summary>
public ConcurrentBag<object> Payloads { get; } = new();
/// <summary>Publishes a message to the specified topic.</summary>
/// <param name="topic">The topic name.</param>
/// <param name="payload">The message payload.</param>
public void Publish(string topic, object payload)
{
Topics.Add(topic);