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
@@ -15,9 +15,27 @@ namespace ZB.MOM.WW.OtOpcUa.Core.ScriptedAlarms;
/// </remarks>
public interface IAlarmStateStore
{
/// <summary>Loads the alarm state for a specific alarm identifier.</summary>
/// <param name="alarmId">The alarm identifier.</param>
/// <param name="ct">Cancellation token.</param>
/// <returns>The alarm state if found; otherwise null.</returns>
Task<AlarmConditionState?> LoadAsync(string alarmId, CancellationToken ct);
/// <summary>Loads all alarm states from the store.</summary>
/// <param name="ct">Cancellation token.</param>
/// <returns>A collection of all alarm states.</returns>
Task<IReadOnlyList<AlarmConditionState>> LoadAllAsync(CancellationToken ct);
/// <summary>Saves an alarm state to the store.</summary>
/// <param name="state">The alarm state to save.</param>
/// <param name="ct">Cancellation token.</param>
/// <returns>A task representing the save operation.</returns>
Task SaveAsync(AlarmConditionState state, CancellationToken ct);
/// <summary>Removes an alarm state from the store.</summary>
/// <param name="alarmId">The alarm identifier to remove.</param>
/// <param name="ct">Cancellation token.</param>
/// <returns>A task representing the remove operation.</returns>
Task RemoveAsync(string alarmId, CancellationToken ct);
}
@@ -27,18 +45,22 @@ public sealed class InMemoryAlarmStateStore : IAlarmStateStore
private readonly ConcurrentDictionary<string, AlarmConditionState> _map
= new(StringComparer.Ordinal);
/// <inheritdoc />
public Task<AlarmConditionState?> LoadAsync(string alarmId, CancellationToken ct)
=> Task.FromResult(_map.TryGetValue(alarmId, out var v) ? v : null);
/// <inheritdoc />
public Task<IReadOnlyList<AlarmConditionState>> LoadAllAsync(CancellationToken ct)
=> Task.FromResult<IReadOnlyList<AlarmConditionState>>(_map.Values.ToArray());
/// <inheritdoc />
public Task SaveAsync(AlarmConditionState state, CancellationToken ct)
{
_map[state.AlarmId] = state;
return Task.CompletedTask;
}
/// <inheritdoc />
public Task RemoveAsync(string alarmId, CancellationToken ct)
{
_map.TryRemove(alarmId, out _);