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
@@ -19,6 +19,7 @@ public sealed class TwinCATHighFindingsRegressionTests
// ---- Driver.TwinCAT-001 — Reinitialize applies the new config generation ----
/// <summary>Verifies ReinitializeAsync applies new device configuration at runtime.</summary>
[Fact]
public async Task ReinitializeAsync_applies_changed_device_config()
{
@@ -47,6 +48,7 @@ public sealed class TwinCATHighFindingsRegressionTests
drv.GetDeviceState("ads://10.0.0.1.1.1:852")!.Options.DeviceName.ShouldBe("Machine2");
}
/// <summary>Verifies InitializeAsync applies supplied JSON config over constructor options.</summary>
[Fact]
public async Task InitializeAsync_applies_supplied_config_over_constructor_options()
{
@@ -66,6 +68,7 @@ public sealed class TwinCATHighFindingsRegressionTests
// ---- Driver.TwinCAT-002 — 64-bit + unsigned types map without truncation ----
/// <summary>Verifies TwinCAT data types map to driver types without truncation of width or signedness.</summary>
[Fact]
public void DataType_mapping_preserves_width_and_signedness()
{
@@ -79,6 +82,7 @@ public sealed class TwinCATHighFindingsRegressionTests
TwinCATDataType.SInt.ToDriverDataType().ShouldBe(DriverDataType.Int16);
}
/// <summary>Verifies 64-bit LInt reads preserve values larger than int.MaxValue.</summary>
[Fact]
public async Task LInt_read_round_trips_value_above_int_MaxValue()
{
@@ -102,6 +106,7 @@ public sealed class TwinCATHighFindingsRegressionTests
// ---- Driver.TwinCAT-007 — concurrent EnsureConnectedAsync creates exactly one client ----
/// <summary>Verifies concurrent reads on one device create and share exactly one client.</summary>
[Fact]
public async Task Concurrent_reads_on_one_device_create_a_single_client()
{
@@ -124,6 +129,7 @@ public sealed class TwinCATHighFindingsRegressionTests
factory.Clients[0].ConnectCount.ShouldBe(1);
}
/// <summary>Verifies concurrent reads and writes on one device share exactly one client.</summary>
[Fact]
public async Task Concurrent_reads_and_writes_share_one_client()
{
@@ -151,6 +157,7 @@ public sealed class TwinCATHighFindingsRegressionTests
// ---- Driver.TwinCAT-013 — symbol-version-changed routes to IRediscoverable ----
/// <summary>Verifies TwinCATDriver implements the IRediscoverable interface.</summary>
[Fact]
public void TwinCATDriver_implements_IRediscoverable()
{
@@ -158,6 +165,7 @@ public sealed class TwinCATHighFindingsRegressionTests
drv.ShouldBeAssignableTo<IRediscoverable>();
}
/// <summary>Verifies symbol version change events raise the OnRediscoveryNeeded event.</summary>
[Fact]
public async Task Symbol_version_changed_raises_OnRediscoveryNeeded()
{
@@ -184,6 +192,7 @@ public sealed class TwinCATHighFindingsRegressionTests
raised!.Reason.ShouldContain("0x0711");
}
/// <summary>Verifies status mapper recognizes the symbol version changed error code.</summary>
[Fact]
public void StatusMapper_recognises_symbol_version_changed_code()
{