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
@@ -23,11 +23,18 @@ public sealed class ModbusCommandBaseTests
[Command("noop-test", Description = "Test-only probe of ModbusCommandBase.BuildOptions.")]
private sealed class ProbeOnly : ModbusCommandBase
{
/// <inheritdoc />
public override ValueTask ExecuteAsync(IConsole console) => default;
/// <summary>Invokes BuildOptions with the given tags.</summary>
/// <param name="tags">The list of tag definitions to build options for.</param>
public ModbusDriverOptions Invoke(IReadOnlyList<ModbusTagDefinition> tags) => BuildOptions(tags);
/// <summary>Invokes ValidateEndpoint.</summary>
public void InvokeValidate() => ValidateEndpoint();
}
/// <summary>Verifies that BuildOptions disables probe for one-shot CLI runs.</summary>
[Fact]
public void BuildOptions_disables_probe_for_one_shot_cli_runs()
{
@@ -39,6 +46,7 @@ public sealed class ModbusCommandBaseTests
options.Probe.Enabled.ShouldBeFalse();
}
/// <summary>Verifies that BuildOptions maps TimeoutMs to Timeout TimeSpan.</summary>
[Fact]
public void BuildOptions_maps_TimeoutMs_to_Timeout_TimeSpan()
{
@@ -49,6 +57,7 @@ public sealed class ModbusCommandBaseTests
options.Timeout.ShouldBe(TimeSpan.FromMilliseconds(7500));
}
/// <summary>Verifies that BuildOptions AutoReconnect defaults to true when flag is unset.</summary>
[Fact]
public void BuildOptions_AutoReconnect_defaults_to_true_when_flag_unset()
{
@@ -59,6 +68,7 @@ public sealed class ModbusCommandBaseTests
options.AutoReconnect.ShouldBeTrue();
}
/// <summary>Verifies that BuildOptions AutoReconnect becomes false when disable reconnect flag is set.</summary>
[Fact]
public void BuildOptions_AutoReconnect_becomes_false_when_disable_reconnect_flag_set()
{
@@ -69,6 +79,7 @@ public sealed class ModbusCommandBaseTests
options.AutoReconnect.ShouldBeFalse();
}
/// <summary>Verifies that BuildOptions flows host, port, and unit through correctly.</summary>
[Fact]
public void BuildOptions_flows_host_port_unit_through()
{
@@ -81,6 +92,7 @@ public sealed class ModbusCommandBaseTests
options.UnitId.ShouldBe((byte)17);
}
/// <summary>Verifies that BuildOptions forwards the tag list verbatim.</summary>
[Fact]
public void BuildOptions_forwards_tag_list_verbatim()
{
@@ -96,6 +108,8 @@ public sealed class ModbusCommandBaseTests
// --- Driver.Modbus.Cli-003: parse-time endpoint validation -------------------------------
/// <summary>Verifies that ValidateEndpoint rejects ports outside the range 1 to 65535.</summary>
/// <param name="port">The port value that should be rejected.</param>
[Theory]
[InlineData(0)]
[InlineData(-1)]
@@ -109,6 +123,8 @@ public sealed class ModbusCommandBaseTests
Should.Throw<CliFx.Exceptions.CommandException>(() => sut.InvokeValidate());
}
/// <summary>Verifies that ValidateEndpoint accepts ports in the valid range.</summary>
/// <param name="port">The port value that should be accepted.</param>
[Theory]
[InlineData(1)]
[InlineData(502)]
@@ -120,6 +136,8 @@ public sealed class ModbusCommandBaseTests
Should.NotThrow(() => sut.InvokeValidate());
}
/// <summary>Verifies that ValidateEndpoint rejects non-positive timeout values.</summary>
/// <param name="timeoutMs">The timeout value in milliseconds that should be rejected.</param>
[Theory]
[InlineData(0)]
[InlineData(-1)]
@@ -131,6 +149,8 @@ public sealed class ModbusCommandBaseTests
Should.Throw<CliFx.Exceptions.CommandException>(() => sut.InvokeValidate());
}
/// <summary>Verifies that ValidateEndpoint rejects unit IDs outside the range 1 to 247.</summary>
/// <param name="unitId">The unit ID value that should be rejected.</param>
[Theory]
[InlineData(0)] // broadcast — disallowed for unicast read/write requests
[InlineData(248)]
@@ -142,6 +162,8 @@ public sealed class ModbusCommandBaseTests
Should.Throw<CliFx.Exceptions.CommandException>(() => sut.InvokeValidate());
}
/// <summary>Verifies that ValidateEndpoint accepts unit IDs in the valid range.</summary>
/// <param name="unitId">The unit ID value that should be accepted.</param>
[Theory]
[InlineData(1)]
[InlineData(247)]
@@ -153,6 +175,7 @@ public sealed class ModbusCommandBaseTests
Should.NotThrow(() => sut.InvokeValidate());
}
/// <summary>Verifies that ValidateEndpoint accepts default options.</summary>
[Fact]
public void ValidateEndpoint_accepts_default_options()
{