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
@@ -27,9 +27,16 @@ public sealed class BuildOptionsTests
[Command("test-build-options")]
private sealed class TestCommand : AbLegacyCommandBase
{
/// <summary>Builds driver options from the command's configuration and the provided tags.</summary>
/// <param name="tags">The tag definitions to include in the options.</param>
/// <returns>Configured driver options.</returns>
public AbLegacyDriverOptions Build(IReadOnlyList<AbLegacyTagDefinition> tags)
=> BuildOptions(tags);
/// <summary>Not used; this test command is for BuildOptions inspection only.</summary>
/// <param name="console">Not used.</param>
/// <returns>Not used.</returns>
/// <exception cref="NotSupportedException">Always thrown; this method should not be called.</exception>
public override System.Threading.Tasks.ValueTask ExecuteAsync(IConsole console)
=> throw new NotSupportedException("TestCommand is for BuildOptions inspection only.");
}
@@ -50,6 +57,7 @@ public sealed class BuildOptionsTests
Writable: true),
];
/// <summary>Verifies that probe is disabled for CLI one-shot runs.</summary>
[Fact]
public void BuildOptions_disables_probe_for_cli_oneshot_runs()
{
@@ -67,6 +75,7 @@ public sealed class BuildOptionsTests
"CLI commands are one-shot; the background probe loop is unwanted overhead.");
}
/// <summary>Verifies that device is populated from gateway and plc-type options.</summary>
[Fact]
public void BuildOptions_populates_single_device_from_gateway_and_plc_type()
{
@@ -85,6 +94,7 @@ public sealed class BuildOptionsTests
options.Devices[0].DeviceName.ShouldBe("cli-MicroLogix");
}
/// <summary>Verifies that tag list is forwarded verbatim to the options.</summary>
[Fact]
public void BuildOptions_forwards_tag_list_verbatim()
{
@@ -100,6 +110,7 @@ public sealed class BuildOptionsTests
options.Tags.ShouldBe(SampleTags);
}
/// <summary>Verifies that timeout-ms option is propagated to the driver options.</summary>
[Fact]
public void BuildOptions_propagates_timeout_ms()
{
@@ -115,6 +126,7 @@ public sealed class BuildOptionsTests
options.Timeout.ShouldBe(TimeSpan.FromMilliseconds(7500));
}
/// <summary>Verifies that empty tag list yields an empty tags collection in options.</summary>
[Fact]
public void BuildOptions_with_empty_tag_list_yields_empty_tags_collection()
{