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,6 +15,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Host.Tests
[Trait("Category", "Unit")]
public sealed class ProgramAlarmWriterTests
{
/// <summary>Verifies that BuildAlarmWriter returns a writer when the environment variable is unset.</summary>
[Fact]
public void BuildAlarmWriter_returns_writer_when_env_unset()
{
@@ -26,6 +27,8 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Host.Tests
writer.ShouldBeOfType<AahClientManagedAlarmEventWriter>();
}
/// <summary>Verifies that BuildAlarmWriter returns a writer when the environment variable is explicitly true.</summary>
/// <param name="value">The truthy environment variable string value to test.</param>
[Theory]
[InlineData("true")]
[InlineData("True")]
@@ -39,6 +42,8 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Host.Tests
writer.ShouldNotBeNull();
}
/// <summary>Verifies that BuildAlarmWriter returns null when the environment variable is false.</summary>
/// <param name="value">The falsy environment variable string value to test.</param>
[Theory]
[InlineData("false")]
[InlineData("False")]
@@ -52,6 +57,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Host.Tests
writer.ShouldBeNull();
}
/// <summary>Verifies that BuildAlarmWriter treats unrecognized values as enabled.</summary>
[Fact]
public void BuildAlarmWriter_treats_unrecognized_value_as_enabled()
{
@@ -72,10 +78,14 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Host.Tests
return new DisposableAction(() => Environment.SetEnvironmentVariable(name, prior));
}
/// <summary>Disposable wrapper for an action that executes on disposal.</summary>
private sealed class DisposableAction : IDisposable
{
private readonly Action _action;
/// <summary>Initializes a new instance that will execute the given action on disposal.</summary>
/// <param name="action">The action to execute when disposed.</param>
public DisposableAction(Action action) { _action = action; }
/// <summary>Executes the stored action.</summary>
public void Dispose() => _action();
}
}