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
@@ -22,6 +22,7 @@ public sealed class TwinCATNativeNotificationTests
return (drv, factory);
}
/// <summary>Verifies that native subscribe registers one notification per tag.</summary>
[Fact]
public async Task Native_subscribe_registers_one_notification_per_tag()
{
@@ -37,6 +38,7 @@ public sealed class TwinCATNativeNotificationTests
factory.Clients[0].Notifications.Select(n => n.SymbolPath).ShouldBe(["MAIN.A", "MAIN.B"], ignoreOrder: true);
}
/// <summary>Verifies that native notification fires OnDataChange with pushed value.</summary>
[Fact]
public async Task Native_notification_fires_OnDataChange_with_pushed_value()
{
@@ -57,6 +59,7 @@ public sealed class TwinCATNativeNotificationTests
events.Last().FullReference.ShouldBe("Speed"); // driver-side reference, not ADS symbol
}
/// <summary>Verifies that native unsubscribe disposes all notifications.</summary>
[Fact]
public async Task Native_unsubscribe_disposes_all_notifications()
{
@@ -72,6 +75,7 @@ public sealed class TwinCATNativeNotificationTests
factory.Clients[0].Notifications.ShouldBeEmpty();
}
/// <summary>Verifies that native unsubscribe halts future notifications.</summary>
[Fact]
public async Task Native_unsubscribe_halts_future_notifications()
{
@@ -94,6 +98,7 @@ public sealed class TwinCATNativeNotificationTests
events.Count.ShouldBe(afterUnsub);
}
/// <summary>Verifies that native subscribe failure mid-registration cleans up partial state.</summary>
[Fact]
public async Task Native_subscribe_failure_mid_registration_cleans_up_partial_state()
{
@@ -128,13 +133,18 @@ public sealed class TwinCATNativeNotificationTests
private sealed class FailAfterNAddsFake : FakeTwinCATClient
{
private readonly int _succeedBefore;
/// <summary>Gets the number of times AddNotificationAsync has been called.</summary>
public int AddCallCount { get; private set; }
/// <summary>Initializes a new instance of FailAfterNAddsFake.</summary>
/// <param name="_">Unused parameter for alignment with parent constructor.</param>
/// <param name="succeedBefore">The number of calls to succeed before failing.</param>
public FailAfterNAddsFake(AbTagParamsIrrelevant _, int succeedBefore) : base()
{
_succeedBefore = succeedBefore;
}
/// <inheritdoc />
public override Task<ITwinCATNotificationHandle> AddNotificationAsync(
string symbolPath, TwinCATDataType type, int? bitIndex, TimeSpan cycleTime,
int maxDelayMs, Action<string, object?> onChange, CancellationToken cancellationToken)
@@ -146,6 +156,7 @@ public sealed class TwinCATNativeNotificationTests
}
}
/// <summary>Verifies that native shutdown disposes subscriptions.</summary>
[Fact]
public async Task Native_shutdown_disposes_subscriptions()
{
@@ -160,6 +171,7 @@ public sealed class TwinCATNativeNotificationTests
factory.Clients[0].Notifications.ShouldBeEmpty();
}
/// <summary>Verifies that the poll path still works when UseNativeNotifications is false.</summary>
[Fact]
public async Task Poll_path_still_works_when_UseNativeNotifications_false()
{
@@ -187,6 +199,7 @@ public sealed class TwinCATNativeNotificationTests
await drv.UnsubscribeAsync(handle, CancellationToken.None);
}
/// <summary>Verifies that subscribe handle DiagnosticId indicates native vs poll.</summary>
[Fact]
public async Task Subscribe_handle_DiagnosticId_indicates_native_vs_poll()
{