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
@@ -16,6 +16,8 @@ public sealed class S7DriverCodeReviewFixTests
{
// ---- Driver.S7-001 — Timer/Counter tags must be rejected at init ----
/// <summary>Verifies that initialize rejects timer or counter tags with NotSupportedException.</summary>
/// <param name="address">The S7 Timer or Counter address to test.</param>
[Theory]
[InlineData("T0")]
[InlineData("T15")]
@@ -45,6 +47,7 @@ public sealed class S7DriverCodeReviewFixTests
health.LastError.ShouldNotBeNull();
}
/// <summary>Verifies that initialize accepts DB and MIQ addresses without triggering the unsupported guard.</summary>
[Fact]
public async Task Initialize_accepts_DB_and_MIQ_addresses_without_the_unsupported_guard_tripping()
{
@@ -71,6 +74,7 @@ public sealed class S7DriverCodeReviewFixTests
// ---- Driver.S7-011 — driverConfigJson must be applied on Initialize ----
/// <summary>Verifies that initialize applies the supplied driverConfigJson over constructor options.</summary>
[Fact]
public async Task Initialize_applies_the_supplied_driverConfigJson_over_the_constructor_options()
{
@@ -96,6 +100,7 @@ public sealed class S7DriverCodeReviewFixTests
"InitializeAsync must apply the driverConfigJson timeout, not the constructor's");
}
/// <summary>Verifies that initialize rejects a timer tag supplied only through driverConfigJson.</summary>
[Fact]
public async Task Initialize_rejects_a_timer_tag_supplied_only_through_driverConfigJson()
{
@@ -114,6 +119,7 @@ public sealed class S7DriverCodeReviewFixTests
ex.Message.ShouldContain("T5");
}
/// <summary>Verifies that reinitialize applies a changed driverConfigJson.</summary>
[Fact]
public async Task Reinitialize_applies_a_changed_driverConfigJson()
{
@@ -135,6 +141,7 @@ public sealed class S7DriverCodeReviewFixTests
// ---- Driver.S7-006 — Shutdown drains probe/poll loops before disposing the gate ----
/// <summary>Verifies that shutdown completes cleanly with active subscriptions and no disposal race.</summary>
[Fact]
public async Task Shutdown_completes_cleanly_with_active_subscriptions_and_no_disposal_race()
{
@@ -159,6 +166,7 @@ public sealed class S7DriverCodeReviewFixTests
await Should.NotThrowAsync(async () => await drv.DisposeAsync());
}
/// <summary>Verifies that dispose after subscribe does not throw ObjectDisposedException.</summary>
[Fact]
public async Task Dispose_after_subscribe_does_not_throw_ObjectDisposedException()
{