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
@@ -12,6 +12,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.S7.Tests;
[Trait("Category", "Unit")]
public sealed class S7DriverScaffoldTests
{
/// <summary>Verifies that default options target S7-1500 slot 0 on port 102.</summary>
[Fact]
public void Default_options_target_S7_1500_slot_0_on_port_102()
{
@@ -22,6 +23,7 @@ public sealed class S7DriverScaffoldTests
opts.Slot.ShouldBe((short)0, "S7-1200/1500 onboard PN ports are slot 0 by convention");
}
/// <summary>Verifies that the default probe interval is reasonable for S7 scan cycles.</summary>
[Fact]
public void Default_probe_interval_is_reasonable_for_S7_scan_cycle()
{
@@ -30,6 +32,7 @@ public sealed class S7DriverScaffoldTests
new S7ProbeOptions().Interval.ShouldBe(TimeSpan.FromSeconds(5));
}
/// <summary>Verifies that tag definition defaults to writable with S7 max string length.</summary>
[Fact]
public void Tag_definition_defaults_to_writable_with_S7_max_string_length()
{
@@ -38,6 +41,7 @@ public sealed class S7DriverScaffoldTests
tag.StringLength.ShouldBe(254, "S7 STRING type max length is 254 chars");
}
/// <summary>Verifies that the driver instance reports type and ID before connect.</summary>
[Fact]
public void Driver_instance_reports_type_and_id_before_connect()
{
@@ -48,6 +52,7 @@ public sealed class S7DriverScaffoldTests
drv.GetHealth().State.ShouldBe(DriverState.Unknown, "health starts Unknown until InitializeAsync runs");
}
/// <summary>Verifies that Initialize against unreachable host transitions to Faulted and throws.</summary>
[Fact]
public async Task Initialize_against_unreachable_host_transitions_to_Faulted_and_throws()
{