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
@@ -12,6 +12,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.OpcUaClient.Tests;
[Trait("Category", "Unit")]
public sealed class OpcUaClientDriverScaffoldTests
{
/// <summary>Verifies that default options target the standard OPC UA port with anonymous auth.</summary>
[Fact]
public void Default_options_target_standard_opcua_port_and_anonymous_auth()
{
@@ -23,6 +24,7 @@ public sealed class OpcUaClientDriverScaffoldTests
opts.AutoAcceptCertificates.ShouldBeFalse("production default must reject untrusted server certs");
}
/// <summary>Verifies that default timeouts match driver specification section 8.</summary>
[Fact]
public void Default_timeouts_match_driver_specs_section_8()
{
@@ -32,6 +34,7 @@ public sealed class OpcUaClientDriverScaffoldTests
opts.ReconnectPeriod.ShouldBe(TimeSpan.FromSeconds(5));
}
/// <summary>Verifies that driver reports type and ID before connecting.</summary>
[Fact]
public void Driver_reports_type_and_id_before_connect()
{
@@ -41,6 +44,7 @@ public sealed class OpcUaClientDriverScaffoldTests
drv.GetHealth().State.ShouldBe(DriverState.Unknown);
}
/// <summary>Verifies that Initialize against unreachable endpoint transitions to Faulted and throws.</summary>
[Fact]
public async Task Initialize_against_unreachable_endpoint_transitions_to_Faulted_and_throws()
{
@@ -67,6 +71,7 @@ public sealed class OpcUaClientDriverScaffoldTests
health.LastError.ShouldNotBeNull();
}
/// <summary>Verifies that Reinitialize against unreachable endpoint re-throws the error.</summary>
[Fact]
public async Task Reinitialize_against_unreachable_endpoint_re_throws()
{