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,10 +22,17 @@ public sealed class AbLegacyRuntimeConcurrencyTests
private sealed class OverlapDetectingFake : FakeAbLegacyTag
{
private int _inFlight;
/// <summary>Gets the maximum number of concurrent operations detected.</summary>
public int MaxConcurrent { get; private set; }
/// <summary>Initializes a new instance of the OverlapDetectingFake class.</summary>
/// <param name="p">The tag creation parameters.</param>
public OverlapDetectingFake(AbLegacyTagCreateParams p) : base(p) { }
/// <summary>Reads the tag asynchronously while tracking concurrent operations.</summary>
/// <param name="ct">The cancellation token.</param>
/// <returns>A task representing the read operation.</returns>
public override async Task ReadAsync(CancellationToken ct)
{
EnterOp();
@@ -38,6 +45,9 @@ public sealed class AbLegacyRuntimeConcurrencyTests
finally { LeaveOp(); }
}
/// <summary>Writes to the tag asynchronously while tracking concurrent operations.</summary>
/// <param name="ct">The cancellation token.</param>
/// <returns>A task representing the write operation.</returns>
public override async Task WriteAsync(CancellationToken ct)
{
EnterOp();
@@ -58,6 +68,7 @@ public sealed class AbLegacyRuntimeConcurrencyTests
private void LeaveOp() => Interlocked.Decrement(ref _inFlight);
}
/// <summary>Verifies that concurrent reads of the same tag are serialised against the shared runtime.</summary>
[Fact]
public async Task Concurrent_reads_of_same_tag_are_serialised_against_the_shared_runtime()
{
@@ -90,6 +101,7 @@ public sealed class AbLegacyRuntimeConcurrencyTests
reads.ShouldAllBe(r => r.Result.Single().Value!.Equals(7));
}
/// <summary>Verifies that concurrent read and write operations on the same tag do not overlap.</summary>
[Fact]
public async Task Concurrent_read_and_write_of_same_tag_do_not_overlap()
{