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
@@ -20,6 +20,7 @@ public sealed class AbCipSubscriptionTests
return (drv, factory);
}
/// <summary>Verifies that the initial poll raises OnDataChange events for every subscribed tag.</summary>
[Fact]
public async Task Initial_poll_raises_OnDataChange_for_every_tag()
{
@@ -45,6 +46,7 @@ public sealed class AbCipSubscriptionTests
await drv.UnsubscribeAsync(handle, CancellationToken.None);
}
/// <summary>Verifies that unchanged values raise OnDataChange only once (on initial poll).</summary>
[Fact]
public async Task Unchanged_value_raises_only_once()
{
@@ -63,6 +65,7 @@ public sealed class AbCipSubscriptionTests
events.Count.ShouldBe(1);
}
/// <summary>Verifies that value changes between polls raise OnDataChange events.</summary>
[Fact]
public async Task Value_change_between_polls_raises_OnDataChange()
{
@@ -85,6 +88,7 @@ public sealed class AbCipSubscriptionTests
events.Last().Snapshot.Value.ShouldBe(200);
}
/// <summary>Verifies that unsubscribe halts polling and no further events are raised.</summary>
[Fact]
public async Task Unsubscribe_halts_polling()
{
@@ -107,6 +111,7 @@ public sealed class AbCipSubscriptionTests
events.Count.ShouldBe(afterUnsub);
}
/// <summary>Verifies that polling intervals below 100ms are floored to the minimum.</summary>
[Fact]
public async Task Interval_below_100ms_is_floored()
{
@@ -127,6 +132,7 @@ public sealed class AbCipSubscriptionTests
events.Count.ShouldBe(1);
}
/// <summary>Verifies that ShutdownAsync cancels all active subscriptions.</summary>
[Fact]
public async Task ShutdownAsync_cancels_active_subscriptions()
{
@@ -147,6 +153,7 @@ public sealed class AbCipSubscriptionTests
events.Count.ShouldBe(afterShutdown);
}
/// <summary>Verifies that subscriptions on UDT members use the synthesized full reference.</summary>
[Fact]
public async Task Subscription_on_UDT_member_uses_synthesised_full_reference()
{