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
@@ -41,10 +41,16 @@ public sealed class OpcPlcFixture : IAsyncDisposable
/// <summary>Full <c>opc.tcp://host:port</c> URL the driver session should connect to.</summary>
public string EndpointUrl { get; }
/// <summary>Gets the host name of the OPC UA simulator.</summary>
public string Host { get; }
/// <summary>Gets the port number of the OPC UA simulator.</summary>
public int Port { get; }
/// <summary>Gets a skip reason if the simulator is unreachable; otherwise null.</summary>
public string? SkipReason { get; }
/// <summary>
/// Initializes a new instance of the <see cref="OpcPlcFixture"/> class and probes the simulator.
/// </summary>
public OpcPlcFixture()
{
EndpointUrl = Environment.GetEnvironmentVariable(EndpointEnvVar) ?? DefaultEndpoint;
@@ -91,6 +97,9 @@ public sealed class OpcPlcFixture : IAsyncDisposable
return int.TryParse(body[(colon + 1)..], out var p) ? (host, p) : (host, 4840);
}
/// <summary>
/// Disposes the fixture resources (currently a no-op).
/// </summary>
public ValueTask DisposeAsync() => ValueTask.CompletedTask;
}
@@ -22,6 +22,9 @@ public static class OpcPlcProfile
/// <summary>opc-plc fast uint node — ticks every 100ms. Used for subscription-cadence tests.</summary>
public const string FastUInt1 = "ns=3;s=FastUInt1";
/// <summary>Builds driver options for the OPC PLC endpoint.</summary>
/// <param name="endpointUrl">The endpoint URL of the OPC PLC simulator.</param>
/// <returns>Configured driver options for the OPC PLC.</returns>
public static OpcUaClientDriverOptions BuildOptions(string endpointUrl) => new()
{
EndpointUrl = endpointUrl,
@@ -16,6 +16,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.OpcUaClient.IntegrationTests;
[Trait("Simulator", "opc-plc")]
public sealed class OpcUaClientSmokeTests(OpcPlcFixture sim)
{
/// <summary>Verifies that the client can connect and read a node through the real OPC UA stack.</summary>
[Fact]
public async Task Client_connects_and_reads_StepUp_node_through_real_OPC_UA_stack()
{
@@ -33,6 +34,7 @@ public sealed class OpcUaClientSmokeTests(OpcPlcFixture sim)
snapshots[0].Value.ShouldNotBeNull("StepUp always has a current value");
}
/// <summary>Verifies that the client can read a batch of varied types from the simulator.</summary>
[Fact]
public async Task Client_reads_batch_of_varied_types_from_live_simulator()
{
@@ -57,6 +59,7 @@ public sealed class OpcUaClientSmokeTests(OpcPlcFixture sim)
snapshots[2].Value.ShouldBeOfType<bool>();
}
/// <summary>Verifies that the client can subscribe to data changes from the live server.</summary>
[Fact]
public async Task Client_subscribe_receives_StepUp_data_changes_from_live_server()
{