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
@@ -14,6 +14,7 @@ public sealed class FocasFactoryConfigTests
{
// ---- Driver.FOCAS-001: FixedTree / AlarmProjection / HandleRecycle config sections ----
/// <summary>Verifies that the FixedTree configuration section is mapped to driver options.</summary>
[Fact]
public void CreateInstance_maps_FixedTree_section_onto_options()
{
@@ -37,6 +38,7 @@ public sealed class FocasFactoryConfigTests
drv.Options.FixedTree.TimerPollInterval.ShouldBe(TimeSpan.FromSeconds(30));
}
/// <summary>Verifies that the AlarmProjection configuration section is mapped to driver options.</summary>
[Fact]
public void CreateInstance_maps_AlarmProjection_section_onto_options()
{
@@ -53,6 +55,7 @@ public sealed class FocasFactoryConfigTests
drv.Options.AlarmProjection.PollInterval.ShouldBe(TimeSpan.FromSeconds(2));
}
/// <summary>Verifies that the HandleRecycle configuration section is mapped to driver options.</summary>
[Fact]
public void CreateInstance_maps_HandleRecycle_section_onto_options()
{
@@ -69,6 +72,7 @@ public sealed class FocasFactoryConfigTests
drv.Options.HandleRecycle.Interval.ShouldBe(TimeSpan.FromHours(1));
}
/// <summary>Verifies that all three optional configuration sections are mapped together.</summary>
[Fact]
public void CreateInstance_round_trips_all_three_opt_in_sections_together()
{
@@ -88,6 +92,7 @@ public sealed class FocasFactoryConfigTests
drv.Options.HandleRecycle.Enabled.ShouldBeTrue();
}
/// <summary>Verifies that default disabled values are maintained when sections are absent.</summary>
[Fact]
public void CreateInstance_keeps_disabled_defaults_when_sections_absent()
{
@@ -98,6 +103,7 @@ public sealed class FocasFactoryConfigTests
drv.Options.HandleRecycle.Enabled.ShouldBeFalse();
}
/// <summary>Verifies that per-field defaults are maintained when only Enabled is supplied.</summary>
[Fact]
public void CreateInstance_keeps_per_field_defaults_when_only_Enabled_supplied()
{
@@ -112,6 +118,7 @@ public sealed class FocasFactoryConfigTests
// ---- Driver.FOCAS-002: fixed-tree bootstrap must not declare a false ProgramInfo capability ----
/// <summary>Verifies that ProgramInfo is marked unsupported when probe throws.</summary>
[Fact]
public async Task FixedTree_bootstrap_marks_ProgramInfo_unsupported_when_probe_throws()
{
@@ -138,6 +145,7 @@ public sealed class FocasFactoryConfigTests
await drv.ShutdownAsync(CancellationToken.None);
}
/// <summary>Verifies that ProgramInfo is marked supported when probe succeeds.</summary>
[Fact]
public async Task FixedTree_bootstrap_marks_ProgramInfo_supported_when_probe_succeeds()
{
@@ -175,6 +183,10 @@ public sealed class FocasFactoryConfigTests
/// </summary>
private sealed class ProgramInfoFailingFocasClient : FakeFocasClient
{
/// <summary>Gets program info by throwing to simulate unsupported operations.</summary>
/// <param name="ct">Cancellation token.</param>
/// <returns>Never returns; always throws.</returns>
/// <inheritdoc />
public override Task<FocasProgramInfo> GetProgramInfoAsync(CancellationToken ct) =>
throw new InvalidOperationException(
"cnc_exeprgname2 failed EW_6 and cnc_rdopmode failed EW_6.");