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,9 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Tests;
/// </summary>
public sealed class GalaxyDriverAlarmEventArgsExtensionTests
{
/// <summary>
/// Verifies that acknowledge transition with full payload populates extended fields.
/// </summary>
[Fact]
public async Task Acknowledge_transition_with_full_payload_populates_extended_fields()
{
@@ -47,6 +50,9 @@ public sealed class GalaxyDriverAlarmEventArgsExtensionTests
observed[0].AlarmCategory.ShouldBe("Process");
}
/// <summary>
/// Verifies that raise transition without optional fields leaves them null.
/// </summary>
[Fact]
public async Task Raise_transition_without_optional_fields_leaves_them_null()
{
@@ -95,13 +101,26 @@ public sealed class GalaxyDriverAlarmEventArgsExtensionTests
/// <summary>In-memory <see cref="IGalaxyAlarmFeed"/> the test drives directly.</summary>
private sealed class FakeAlarmFeed : IGalaxyAlarmFeed
{
/// <summary>
/// Occurs when an alarm transition is raised.
/// </summary>
public event EventHandler<GalaxyAlarmTransition>? OnAlarmTransition;
/// <summary>
/// Starts the alarm feed.
/// </summary>
public void Start() { }
/// <summary>
/// Emits an alarm transition to subscribers.
/// </summary>
/// <param name="transition">The alarm transition to emit.</param>
public void Emit(GalaxyAlarmTransition transition)
=> OnAlarmTransition?.Invoke(this, transition);
/// <summary>
/// Disposes the alarm feed asynchronously.
/// </summary>
public ValueTask DisposeAsync() => ValueTask.CompletedTask;
}
}