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
@@ -18,11 +18,20 @@ public sealed class AbCipCommandBaseTests
[CliFx.Attributes.Command("test")]
private sealed class TestableCommand : AbCipCommandBase
{
/// <summary>
/// Invokes the protected <see cref="AbCipCommandBase.BuildOptions"/> method.
/// </summary>
/// <param name="tags">The tags to pass to BuildOptions.</param>
/// <returns>The configured driver options.</returns>
public AbCipDriverOptions InvokeBuildOptions(IReadOnlyList<AbCipTagDefinition> tags)
=> BuildOptions(tags);
/// <summary>
/// Gets the protected <see cref="AbCipCommandBase.DriverInstanceId"/> property.
/// </summary>
public string InvokeDriverInstanceId => DriverInstanceId;
/// <inheritdoc />
public override ValueTask ExecuteAsync(CliFx.Infrastructure.IConsole console)
=> ValueTask.CompletedTask;
}
@@ -34,6 +43,9 @@ public sealed class AbCipCommandBaseTests
DataType: AbCipDataType.DInt,
Writable: false);
/// <summary>
/// Verifies that BuildOptions disables probe to prevent racing operator reads.
/// </summary>
[Fact]
public void BuildOptions_disables_probe_so_cli_does_not_race_operator_reads()
{
@@ -49,6 +61,9 @@ public sealed class AbCipCommandBaseTests
options.Probe.Enabled.ShouldBeFalse();
}
/// <summary>
/// Verifies that BuildOptions disables controller browse.
/// </summary>
[Fact]
public void BuildOptions_disables_controller_browse()
{
@@ -64,6 +79,9 @@ public sealed class AbCipCommandBaseTests
options.EnableControllerBrowse.ShouldBeFalse();
}
/// <summary>
/// Verifies that BuildOptions disables alarm projection.
/// </summary>
[Fact]
public void BuildOptions_disables_alarm_projection()
{
@@ -79,6 +97,9 @@ public sealed class AbCipCommandBaseTests
options.EnableAlarmProjection.ShouldBeFalse();
}
/// <summary>
/// Verifies that BuildOptions produces one device with gateway family and derived name.
/// </summary>
[Fact]
public void BuildOptions_produces_one_device_with_gateway_family_and_derived_name()
{
@@ -98,6 +119,9 @@ public sealed class AbCipCommandBaseTests
device.DeviceName.ShouldBe("cli-CompactLogix");
}
/// <summary>
/// Verifies that BuildOptions passes the supplied tag list verbatim.
/// </summary>
[Fact]
public void BuildOptions_passes_supplied_tag_list_verbatim()
{
@@ -116,6 +140,9 @@ public sealed class AbCipCommandBaseTests
options.Tags[1].Name.ShouldBe("t2");
}
/// <summary>
/// Verifies that BuildOptions carries TimeoutMs through to Timeout.
/// </summary>
[Fact]
public void BuildOptions_carries_TimeoutMs_through_to_Timeout()
{
@@ -131,6 +158,9 @@ public sealed class AbCipCommandBaseTests
options.Timeout.ShouldBe(TimeSpan.FromMilliseconds(7500));
}
/// <summary>
/// Verifies that DriverInstanceId embeds gateway for log disambiguation.
/// </summary>
[Fact]
public void DriverInstanceId_embeds_gateway_for_log_disambiguation()
{
@@ -143,6 +173,9 @@ public sealed class AbCipCommandBaseTests
cmd.InvokeDriverInstanceId.ShouldBe("abcip-cli-ab://10.0.0.5/1,0");
}
/// <summary>
/// Verifies that Timeout setter is inert and does not silently swallow assignments.
/// </summary>
[Fact]
public void Timeout_setter_is_inert_and_does_not_silently_swallow_assignments()
{
@@ -156,6 +189,10 @@ public sealed class AbCipCommandBaseTests
});
}
/// <summary>
/// Verifies that Timeout getter throws CommandException when TimeoutMs is non-positive.
/// </summary>
/// <param name="badMs">A non-positive timeout value to test.</param>
[Theory]
[InlineData(0)]
[InlineData(-1)]
@@ -173,6 +210,9 @@ public sealed class AbCipCommandBaseTests
ex.Message.ShouldContain("--timeout-ms");
}
/// <summary>
/// Verifies that RejectStructure throws for Structure DataType.
/// </summary>
[Fact]
public void RejectStructure_throws_for_Structure_DataType()
{
@@ -181,6 +221,10 @@ public sealed class AbCipCommandBaseTests
ex.Message.ShouldContain("Structure");
}
/// <summary>
/// Verifies that RejectStructure passes for atomic data types.
/// </summary>
/// <param name="type">The atomic data type to test.</param>
[Theory]
[InlineData(AbCipDataType.DInt)]
[InlineData(AbCipDataType.Bool)]