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
@@ -12,6 +12,7 @@ namespace ZB.MOM.WW.OtOpcUa.Runtime.Tests.ScriptedAlarms;
public sealed class ScriptedAlarmStatePersistenceTests : RuntimeActorTestBase
{
/// <summary>Verifies that alarm state transitions write to the state store with the correct lastAckUser value.</summary>
[Fact]
public async Task Transition_writes_to_state_store_with_lastAckUser()
{
@@ -37,6 +38,7 @@ public sealed class ScriptedAlarmStatePersistenceTests : RuntimeActorTestBase
}, duration: TimeSpan.FromSeconds(2));
}
/// <summary>Verifies that actor restart restores persisted state so pending acknowledgment is not dropped.</summary>
[Fact]
public async Task PreStart_restores_persisted_state_so_restart_does_not_drop_pending_ack()
{
@@ -61,6 +63,7 @@ public sealed class ScriptedAlarmStatePersistenceTests : RuntimeActorTestBase
}, duration: TimeSpan.FromSeconds(3));
}
/// <summary>Verifies that alarm boots to inactive state when no persisted state exists.</summary>
[Fact]
public async Task PreStart_with_no_persisted_state_boots_inactive()
{
@@ -76,6 +79,7 @@ public sealed class ScriptedAlarmStatePersistenceTests : RuntimeActorTestBase
parent.ExpectNoMsg(TimeSpan.FromMilliseconds(300));
}
/// <summary>Verifies that EF-based alarm actor state store correctly persists and restores state through the config database.</summary>
[Fact]
public async Task EfAlarmActorStateStore_round_trip_persists_via_ConfigDb()
{
@@ -113,6 +117,7 @@ public sealed class ScriptedAlarmStatePersistenceTests : RuntimeActorTestBase
}
}
/// <summary>Verifies that loading an alarm state for a missing ID returns null.</summary>
[Fact]
public async Task EfAlarmActorStateStore_load_for_missing_id_returns_null()
{
@@ -128,11 +133,20 @@ public sealed class ScriptedAlarmStatePersistenceTests : RuntimeActorTestBase
private readonly ConcurrentDictionary<string, AlarmActorStateSnapshot> _byId = new(StringComparer.Ordinal);
private readonly ConcurrentQueue<AlarmActorStateSnapshot> _saves = new();
/// <summary>Gets all saved alarm state snapshots in order.</summary>
public List<AlarmActorStateSnapshot> Snapshots => _saves.ToList();
/// <summary>Loads the alarm state snapshot for the specified alarm ID.</summary>
/// <param name="alarmId">The alarm ID.</param>
/// <param name="ct">The cancellation token.</param>
/// <returns>The alarm state snapshot if found, null otherwise.</returns>
public Task<AlarmActorStateSnapshot?> LoadAsync(string alarmId, CancellationToken ct)
=> Task.FromResult(_byId.TryGetValue(alarmId, out var v) ? v : null);
/// <summary>Saves the alarm state snapshot.</summary>
/// <param name="snapshot">The alarm state snapshot to save.</param>
/// <param name="ct">The cancellation token.</param>
/// <returns>A completed task.</returns>
public Task SaveAsync(AlarmActorStateSnapshot snapshot, CancellationToken ct)
{
_byId[snapshot.AlarmId] = snapshot;