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,9 @@ public sealed class FocasLowFindingsTests
{
// ---- Driver.FOCAS-008 — parsed FocasAddress cached at init ----
/// <summary>
/// Verifies that ReadAsync uses cached FocasAddress when tag definition has a malformed address after init.
/// </summary>
[Fact]
public async Task ReadAsync_uses_cached_FocasAddress_when_tag_definition_has_a_malformed_address_after_init()
{
@@ -53,6 +56,9 @@ public sealed class FocasLowFindingsTests
.ShouldBeTrue("ReadAsync must reuse the FocasAddress parsed at init, not re-parse per read");
}
/// <summary>
/// Verifies that WriteAsync also uses cached FocasAddress.
/// </summary>
[Fact]
public async Task WriteAsync_uses_cached_FocasAddress_too()
{
@@ -90,6 +96,9 @@ public sealed class FocasLowFindingsTests
// ---- Driver.FOCAS-009 — Probe.Timeout applies to ProbeAsync ----
/// <summary>
/// Verifies that ProbeLoop cancels a slow ProbeAsync at Probe Timeout.
/// </summary>
[Fact]
public async Task ProbeLoop_cancels_a_slow_ProbeAsync_at_Probe_Timeout()
{
@@ -130,6 +139,11 @@ public sealed class FocasLowFindingsTests
// ---- Driver.FOCAS-010 — operation-mode → text mapping is consolidated ----
/// <summary>
/// Verifies that OpMode ToText yields the same label in both namespaces.
/// </summary>
/// <param name="code">The operation mode code to test.</param>
/// <param name="expected">The expected text representation.</param>
[Theory]
[InlineData(0, "MDI")]
[InlineData(1, "AUTO")]
@@ -149,6 +163,9 @@ public sealed class FocasLowFindingsTests
((FocasOperationMode)(short)code).ToText().ShouldBe(expected);
}
/// <summary>
/// Verifies that OpMode ToText fallback label is consistent.
/// </summary>
[Fact]
public void OpMode_ToText_fallback_label_is_consistent()
{
@@ -162,6 +179,9 @@ public sealed class FocasLowFindingsTests
// ---- Driver.FOCAS-011 — FocasAlarmType constants typed as short ----
/// <summary>
/// Verifies that FocasAlarmType constants are typed as short.
/// </summary>
[Fact]
public void FocasAlarmType_constants_are_typed_short()
{
@@ -184,6 +204,7 @@ public sealed class FocasLowFindingsTests
private sealed class CapturingFakeFocasClient(List<FocasAddress> captured) : FakeFocasClient
{
/// <inheritdoc />
public override Task<(object? value, uint status)> ReadAsync(
FocasAddress address, FocasDataType type, CancellationToken ct)
{
@@ -191,6 +212,7 @@ public sealed class FocasLowFindingsTests
return base.ReadAsync(address, type, ct);
}
/// <inheritdoc />
public override Task<uint> WriteAsync(
FocasAddress address, FocasDataType type, object? value, CancellationToken ct)
{
@@ -201,6 +223,7 @@ public sealed class FocasLowFindingsTests
private sealed class HangingProbeFakeClient(TaskCompletionSource cancelledSignal) : FakeFocasClient
{
/// <inheritdoc />
public override async Task<bool> ProbeAsync(CancellationToken ct)
{
try