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 FocasReadWriteTests
// ---- Read ----
/// <summary>Verifies that an unknown reference maps to BadNodeIdUnknown.</summary>
[Fact]
public async Task Unknown_reference_maps_to_BadNodeIdUnknown()
{
@@ -32,6 +33,7 @@ public sealed class FocasReadWriteTests
snapshots.Single().StatusCode.ShouldBe(FocasStatusMapper.BadNodeIdUnknown);
}
/// <summary>Verifies that a successful PMC read returns a Good status value.</summary>
[Fact]
public async Task Successful_PMC_read_returns_Good_value()
{
@@ -45,6 +47,7 @@ public sealed class FocasReadWriteTests
snapshots.Single().Value.ShouldBe((sbyte)5);
}
/// <summary>Verifies that parameter reads route through the FocasAddress Parameter kind.</summary>
[Fact]
public async Task Parameter_read_routes_through_FocasAddress_Parameter_kind()
{
@@ -58,6 +61,7 @@ public sealed class FocasReadWriteTests
snapshots.Single().Value.ShouldBe(1500);
}
/// <summary>Verifies that macro reads route through the FocasAddress Macro kind.</summary>
[Fact]
public async Task Macro_read_routes_through_FocasAddress_Macro_kind()
{
@@ -70,6 +74,7 @@ public sealed class FocasReadWriteTests
snapshots.Single().Value.ShouldBe(3.14159);
}
/// <summary>Verifies that repeated reads reuse the connection.</summary>
[Fact]
public async Task Repeat_read_reuses_connection()
{
@@ -85,6 +90,7 @@ public sealed class FocasReadWriteTests
factory.Clients[0].ConnectCount.ShouldBe(1);
}
/// <summary>Verifies that FOCAS error statuses map correctly via the status mapper.</summary>
[Fact]
public async Task FOCAS_error_status_maps_via_status_mapper()
{
@@ -102,6 +108,7 @@ public sealed class FocasReadWriteTests
snapshots.Single().StatusCode.ShouldBe(FocasStatusMapper.BadNodeIdUnknown);
}
/// <summary>Verifies that a read exception surfaces BadCommunicationError.</summary>
[Fact]
public async Task Read_exception_surfaces_BadCommunicationError()
{
@@ -115,6 +122,7 @@ public sealed class FocasReadWriteTests
drv.GetHealth().State.ShouldBe(DriverState.Degraded);
}
/// <summary>Verifies that a connection failure disposes the client and surfaces BadCommunicationError.</summary>
[Fact]
public async Task Connect_failure_disposes_client_and_surfaces_BadCommunicationError()
{
@@ -128,6 +136,7 @@ public sealed class FocasReadWriteTests
factory.Clients[0].DisposeCount.ShouldBe(1);
}
/// <summary>Verifies that batched reads preserve order across different address areas.</summary>
[Fact]
public async Task Batched_reads_preserve_order_across_areas()
{
@@ -154,6 +163,7 @@ public sealed class FocasReadWriteTests
// ---- Write ----
/// <summary>Verifies that a non-writable tag write is rejected with BadNotWritable.</summary>
[Fact]
public async Task Non_writable_tag_rejected_with_BadNotWritable()
{
@@ -166,6 +176,7 @@ public sealed class FocasReadWriteTests
results.Single().StatusCode.ShouldBe(FocasStatusMapper.BadNotWritable);
}
/// <summary>Verifies that a successful write logs the address, type, and value.</summary>
[Fact]
public async Task Successful_write_logs_address_type_value()
{
@@ -183,6 +194,7 @@ public sealed class FocasReadWriteTests
write.value.ShouldBe((short)1800);
}
/// <summary>Verifies that write status codes map correctly via the FocasStatusMapper.</summary>
[Fact]
public async Task Write_status_code_maps_via_FocasStatusMapper()
{
@@ -201,6 +213,7 @@ public sealed class FocasReadWriteTests
results.Single().StatusCode.ShouldBe(FocasStatusMapper.BadNotWritable);
}
/// <summary>Verifies that batched writes preserve order across different outcomes.</summary>
[Fact]
public async Task Batch_write_preserves_order_across_outcomes()
{
@@ -229,6 +242,7 @@ public sealed class FocasReadWriteTests
results[2].StatusCode.ShouldBe(FocasStatusMapper.BadNodeIdUnknown);
}
/// <summary>Verifies that cancellation signals are propagated.</summary>
[Fact]
public async Task Cancellation_propagates()
{
@@ -245,6 +259,7 @@ public sealed class FocasReadWriteTests
() => drv.ReadAsync(["X"], CancellationToken.None));
}
/// <summary>Verifies that ShutdownAsync disposes the client.</summary>
[Fact]
public async Task ShutdownAsync_disposes_client()
{