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.TwinCAT.Cli.Tests;
[Trait("Category", "Unit")]
public sealed class TwinCATCommandBaseTests
{
/// <summary>Verifies that the gateway string uses canonical ADS scheme with port.</summary>
[Fact]
public void Gateway_uses_canonical_ads_scheme_with_port()
{
@@ -27,6 +28,7 @@ public sealed class TwinCATCommandBaseTests
cmd.GatewayForTest.ShouldBe("ads://192.168.1.40.1.1:851");
}
/// <summary>Verifies that the gateway string round-trips through TwinCATAmsAddress.TryParse.</summary>
[Fact]
public void Gateway_round_trips_through_TwinCATAmsAddress_TryParse()
{
@@ -45,6 +47,7 @@ public sealed class TwinCATCommandBaseTests
parsed.Port.ShouldBe(852);
}
/// <summary>Verifies that the driver instance ID includes the AMS target.</summary>
[Fact]
public void DriverInstanceId_includes_ams_target()
{
@@ -57,6 +60,7 @@ public sealed class TwinCATCommandBaseTests
cmd.DriverInstanceIdForTest.ShouldBe("twincat-cli-127.0.0.1.1.1:851");
}
/// <summary>Verifies that timeout is a projection of TimeoutMs and initialization is a no-op.</summary>
[Fact]
public void Timeout_is_projection_of_TimeoutMs_and_init_is_noop()
{
@@ -69,6 +73,7 @@ public sealed class TwinCATCommandBaseTests
cmd.Timeout.ShouldBe(TimeSpan.FromMilliseconds(7777));
}
/// <summary>Verifies that BuildOptions wires device tags, timeout, and disables probe.</summary>
[Fact]
public void BuildOptions_wires_device_tags_timeout_and_disables_probe()
{
@@ -102,6 +107,7 @@ public sealed class TwinCATCommandBaseTests
options.UseNativeNotifications.ShouldBeTrue();
}
/// <summary>Verifies that the PollOnly flag flips UseNativeNotifications off.</summary>
[Fact]
public void BuildOptions_PollOnly_flips_UseNativeNotifications_off()
{
@@ -116,6 +122,7 @@ public sealed class TwinCATCommandBaseTests
// ---- Driver.TwinCAT.Cli-001 (range validation) ----
/// <summary>Verifies that validation rejects zero timeout.</summary>
[Fact]
public void Validate_rejects_zero_timeout()
{
@@ -129,6 +136,7 @@ public sealed class TwinCATCommandBaseTests
ex.Message.ShouldContain("--timeout-ms");
}
/// <summary>Verifies that validation rejects negative timeout.</summary>
[Fact]
public void Validate_rejects_negative_timeout()
{
@@ -141,6 +149,8 @@ public sealed class TwinCATCommandBaseTests
Should.Throw<CliFx.Exceptions.CommandException>(() => cmd.ValidateForTest());
}
/// <summary>Verifies that validation rejects out-of-range AMS port values.</summary>
/// <param name="port">The out-of-range AMS port value to test.</param>
[Theory]
[InlineData(0)]
[InlineData(-1)]
@@ -158,6 +168,8 @@ public sealed class TwinCATCommandBaseTests
ex.Message.ShouldContain("--ams-port");
}
/// <summary>Verifies that validation accepts in-range AMS port values.</summary>
/// <param name="port">The valid AMS port value to test.</param>
[Theory]
[InlineData(1)]
[InlineData(801)]
@@ -174,6 +186,7 @@ public sealed class TwinCATCommandBaseTests
Should.NotThrow(() => cmd.ValidateForTest());
}
/// <summary>Verifies that SubscribeCommand validation rejects zero interval.</summary>
[Fact]
public void SubscribeCommand_validate_rejects_zero_interval()
{
@@ -187,6 +200,7 @@ public sealed class TwinCATCommandBaseTests
ex.Message.ShouldContain("--interval-ms");
}
/// <summary>Verifies that SubscribeCommand validation rejects negative interval.</summary>
[Fact]
public void SubscribeCommand_validate_rejects_negative_interval()
{
@@ -201,6 +215,7 @@ public sealed class TwinCATCommandBaseTests
// ---- Driver.TwinCAT.Cli-004 (PollOnly off BrowseCommand surface) ----
/// <summary>Verifies that BrowseCommand does not expose the poll-only flag.</summary>
[Fact]
public void BrowseCommand_does_not_expose_poll_only_flag()
{
@@ -212,6 +227,7 @@ public sealed class TwinCATCommandBaseTests
props.ShouldNotContain(p => p.Name == "PollOnly");
}
/// <summary>Verifies that ProbeCommand still exposes the poll-only flag.</summary>
[Fact]
public void ProbeCommand_still_exposes_poll_only_flag()
{
@@ -224,6 +240,7 @@ public sealed class TwinCATCommandBaseTests
// ---- Driver.TwinCAT.Cli-005 (probe --type short alias) ----
/// <summary>Verifies that ProbeCommand type option carries the short alias 't'.</summary>
[Fact]
public void ProbeCommand_type_option_carries_short_alias_t()
{