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
@@ -21,6 +21,7 @@ public sealed class AbCipDriverReadTests
return (drv, factory);
}
/// <summary>Verifies that an unknown reference maps to BadNodeIdUnknown status.</summary>
[Fact]
public async Task Unknown_reference_maps_to_BadNodeIdUnknown()
{
@@ -33,6 +34,7 @@ public sealed class AbCipDriverReadTests
snapshots.Single().Value.ShouldBeNull();
}
/// <summary>Verifies that a tag on an unknown device maps to BadNodeIdUnknown status.</summary>
[Fact]
public async Task Tag_on_unknown_device_maps_to_BadNodeIdUnknown()
{
@@ -49,6 +51,7 @@ public sealed class AbCipDriverReadTests
snapshots.Single().StatusCode.ShouldBe(AbCipStatusMapper.BadNodeIdUnknown);
}
/// <summary>Verifies that a successful DInt read returns Good status with the correct value.</summary>
[Fact]
public async Task Successful_DInt_read_returns_Good_with_value()
{
@@ -67,6 +70,7 @@ public sealed class AbCipDriverReadTests
factory.Tags["Motor1.Speed"].ReadCount.ShouldBe(1);
}
/// <summary>Verifies that repeated reads reuse the runtime without reinitializing.</summary>
[Fact]
public async Task Repeat_read_reuses_runtime_without_reinitialise()
{
@@ -83,6 +87,7 @@ public sealed class AbCipDriverReadTests
factory.Tags["Motor1.Speed"].ReadCount.ShouldBe(3);
}
/// <summary>Verifies that non-zero libplctag status is mapped via AbCipStatusMapper.</summary>
[Fact]
public async Task NonZero_libplctag_status_maps_via_AbCipStatusMapper()
{
@@ -97,6 +102,7 @@ public sealed class AbCipDriverReadTests
snapshots.Single().Value.ShouldBeNull();
}
/// <summary>Verifies that an exception during read surfaces BadCommunicationError status.</summary>
[Fact]
public async Task Exception_during_read_surfaces_BadCommunicationError()
{
@@ -112,6 +118,7 @@ public sealed class AbCipDriverReadTests
drv.GetHealth().State.ShouldBe(DriverState.Degraded);
}
/// <summary>Verifies that batched reads preserve order and per-tag status.</summary>
[Fact]
public async Task Batched_reads_preserve_order_and_per_tag_status()
{
@@ -136,6 +143,7 @@ public sealed class AbCipDriverReadTests
snapshots.ShouldAllBe(s => s.StatusCode == AbCipStatusMapper.Good);
}
/// <summary>Verifies that a successful read marks health as Healthy.</summary>
[Fact]
public async Task Successful_read_marks_health_Healthy()
{
@@ -149,6 +157,7 @@ public sealed class AbCipDriverReadTests
drv.GetHealth().LastSuccessfulRead.ShouldNotBeNull();
}
/// <summary>Verifies that tag creation parameters are built correctly from device and profile.</summary>
[Fact]
public async Task TagCreateParams_are_built_from_device_and_profile()
{
@@ -166,6 +175,7 @@ public sealed class AbCipDriverReadTests
p.TagName.ShouldBe("Program:P.Counter");
}
/// <summary>Verifies that cancellation propagates from read operations.</summary>
[Fact]
public async Task Cancellation_propagates_from_read()
{
@@ -183,6 +193,7 @@ public sealed class AbCipDriverReadTests
() => drv.ReadAsync(["Slow"], cts.Token));
}
/// <summary>Verifies that ShutdownAsync disposes each tag runtime.</summary>
[Fact]
public async Task ShutdownAsync_disposes_each_tag_runtime()
{
@@ -199,6 +210,7 @@ public sealed class AbCipDriverReadTests
factory.Tags["B"].Disposed.ShouldBeTrue();
}
/// <summary>Verifies that initialization failure disposes the tag and surfaces communication error.</summary>
[Fact]
public async Task Initialize_failure_disposes_tag_and_surfaces_communication_error()
{