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 @@ public sealed class S7DriverCodeReviewFixTests2
{
// ── Driver.S7-003 — Read/WriteAsync must throw ArgumentNullException, not NRE ─────────
/// <summary>Verifies that ReadAsync throws ArgumentNullException for null references.</summary>
[Fact]
public async Task ReadAsync_with_null_fullReferences_throws_ArgumentNullException()
{
@@ -26,6 +27,7 @@ public sealed class S7DriverCodeReviewFixTests2
await drv.ReadAsync(null!, TestContext.Current.CancellationToken));
}
/// <summary>Verifies that WriteAsync throws ArgumentNullException for null writes.</summary>
[Fact]
public async Task WriteAsync_with_null_writes_throws_ArgumentNullException()
{
@@ -36,6 +38,7 @@ public sealed class S7DriverCodeReviewFixTests2
// ── Driver.S7-009 — Poll loop must update health on sustained failure ────────────────
/// <summary>Verifies that the poll loop degrades health when the driver is uninitialized.</summary>
[Fact]
public async Task PollLoop_against_uninitialized_driver_degrades_health()
{
@@ -64,6 +67,7 @@ public sealed class S7DriverCodeReviewFixTests2
await drv.DisposeAsync();
}
/// <summary>Verifies that the poll loop applies capped backoff after consecutive failures.</summary>
[Fact]
public async Task PollLoop_applies_capped_backoff_after_consecutive_failures()
{
@@ -103,6 +107,7 @@ public sealed class S7DriverCodeReviewFixTests2
// ── Driver.S7-010 — Dispose() must not deadlock via sync-over-async ──────────────────
/// <summary>Verifies that Dispose completes synchronously without sync-over-async.</summary>
[Fact]
public void Dispose_completes_synchronously_without_sync_over_async_round_trip()
{
@@ -120,6 +125,7 @@ public sealed class S7DriverCodeReviewFixTests2
"Dispose() must teardown directly — see Driver.S7-010");
}
/// <summary>Verifies that Dispose is idempotent.</summary>
[Fact]
public void Dispose_is_idempotent()
{
@@ -132,6 +138,8 @@ public sealed class S7DriverCodeReviewFixTests2
// ── Driver.S7-013 — Reject not-yet-implemented S7DataType values at init ─────────────
/// <summary>Verifies that Initialize rejects not-yet-implemented data types with NotSupportedException.</summary>
/// <param name="dt">The S7 data type that is not yet implemented.</param>
[Theory]
[InlineData(S7DataType.Int64)]
[InlineData(S7DataType.UInt64)]
@@ -162,6 +170,9 @@ public sealed class S7DriverCodeReviewFixTests2
health.State.ShouldBe(DriverState.Faulted);
}
/// <summary>Verifies that Initialize accepts implemented data types.</summary>
/// <param name="dt">The S7 data type to test.</param>
/// <param name="addr">The S7 address string corresponding to the data type.</param>
[Theory]
[InlineData(S7DataType.Bool, "DB1.DBX0.0")]
[InlineData(S7DataType.Byte, "DB1.DBB0")]