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,6 +27,9 @@ public static class S7_1500Profile
public const string WriteScratchTag = "WriteScratch";
/// <summary>Builds the S7 driver options for the S7-1500 integration tests.</summary>
/// <param name="host">The hostname or IP address of the S7 PLC.</param>
/// <param name="port">The port number for the S7 PLC connection.</param>
public static S7DriverOptions BuildOptions(string host, int port) => new()
{
Host = host,
@@ -17,6 +17,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.S7.IntegrationTests.S7_1500;
[Trait("Device", "S7_1500")]
public sealed class S7_1500SmokeTests(Snap7ServerFixture sim)
{
/// <summary>Verifies that the driver reads a seeded u16 value through real S7comm.</summary>
[Fact]
public async Task Driver_reads_seeded_u16_through_real_S7comm()
{
@@ -34,6 +35,7 @@ public sealed class S7_1500SmokeTests(Snap7ServerFixture sim)
Convert.ToInt32(snapshots[0].Value).ShouldBe(S7_1500Profile.ProbeSeedValue);
}
/// <summary>Verifies that the driver reads a typed batch of seeded values.</summary>
[Fact]
public async Task Driver_reads_seeded_typed_batch()
{
@@ -57,6 +59,7 @@ public sealed class S7_1500SmokeTests(Snap7ServerFixture sim)
Convert.ToBoolean(snapshots[3].Value).ShouldBeTrue();
}
/// <summary>Verifies that the driver can write and then read back a value on a scratch register.</summary>
[Fact]
public async Task Driver_write_then_read_round_trip_on_scratch_word()
{