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
@@ -23,6 +23,7 @@ public sealed class GalaxyDriverFactoryTests
}
""";
/// <summary>Verifies that minimal config is parsed and defaults are applied.</summary>
[Fact]
public void CreateInstance_ParsesMinimalConfig_AndAppliesDefaults()
{
@@ -40,6 +41,7 @@ public sealed class GalaxyDriverFactoryTests
driver.Options.Reconnect.ReplayOnSessionLost.ShouldBeTrue();
}
/// <summary>Verifies that defaults are overridden from full config.</summary>
[Fact]
public void CreateInstance_OverridesDefaults_FromFullConfig()
{
@@ -77,6 +79,7 @@ public sealed class GalaxyDriverFactoryTests
driver.Options.Reconnect.ReplayOnSessionLost.ShouldBeFalse();
}
/// <summary>Verifies that missing endpoint throws an exception.</summary>
[Fact]
public void CreateInstance_MissingEndpoint_Throws()
{
@@ -85,6 +88,7 @@ public sealed class GalaxyDriverFactoryTests
() => GalaxyDriverFactoryExtensions.CreateInstance("g", bad)).Message.ShouldContain("Gateway.Endpoint");
}
/// <summary>Verifies that missing API key throws an exception.</summary>
[Fact]
public void CreateInstance_MissingApiKey_Throws()
{
@@ -93,6 +97,7 @@ public sealed class GalaxyDriverFactoryTests
() => GalaxyDriverFactoryExtensions.CreateInstance("g", bad)).Message.ShouldContain("ApiKeySecretRef");
}
/// <summary>Verifies that missing client name throws an exception.</summary>
[Fact]
public void CreateInstance_MissingClientName_Throws()
{
@@ -101,6 +106,7 @@ public sealed class GalaxyDriverFactoryTests
() => GalaxyDriverFactoryExtensions.CreateInstance("g", bad)).Message.ShouldContain("MxAccess.ClientName");
}
/// <summary>Verifies that the factory is registered in the driver factory registry.</summary>
[Fact]
public void Register_AddsFactoryToRegistry()
{
@@ -118,6 +124,7 @@ public sealed class GalaxyDriverFactoryTests
driver.DriverType.ShouldBe(GalaxyDriverFactoryExtensions.DriverTypeName);
}
/// <summary>Verifies that driver lifecycle toggles health state on initialize and shutdown.</summary>
[Fact]
public async Task DriverLifecycle_InitializeShutdown_ToggleHealth()
{
@@ -140,6 +147,7 @@ public sealed class GalaxyDriverFactoryTests
await driver.FlushOptionalCachesAsync(CancellationToken.None); // no-op shouldn't throw
}
/// <summary>Verifies that reinitializing with equivalent config refreshes health.</summary>
[Fact]
public async Task ReinitializeAsync_RefreshesHealth_WhenConfigIsEquivalent()
{
@@ -182,13 +190,16 @@ public sealed class GalaxyDriverFactoryTests
/// </summary>
private sealed class NoopSubscriber : IGalaxySubscriber
{
/// <inheritdoc />
public Task<IReadOnlyList<SubscribeResult>> SubscribeBulkAsync(
IReadOnlyList<string> fullReferences, int bufferedUpdateIntervalMs, CancellationToken cancellationToken)
=> Task.FromResult<IReadOnlyList<SubscribeResult>>([]);
/// <inheritdoc />
public Task UnsubscribeBulkAsync(IReadOnlyList<int> itemHandles, CancellationToken cancellationToken)
=> Task.CompletedTask;
/// <inheritdoc />
public async IAsyncEnumerable<MxEvent> StreamEventsAsync(
[System.Runtime.CompilerServices.EnumeratorCancellation] CancellationToken cancellationToken)
{
@@ -197,6 +208,7 @@ public sealed class GalaxyDriverFactoryTests
}
}
/// <summary>Verifies that dispose is idempotent and shutdown after dispose is harmless.</summary>
[Fact]
public void Dispose_IsIdempotent_AndShutdownAfterDisposeIsHarmless()
{
@@ -205,6 +217,7 @@ public sealed class GalaxyDriverFactoryTests
Should.NotThrow(() => driver.Dispose());
}
/// <summary>Verifies that initializing after dispose throws an exception.</summary>
[Fact]
public async Task InitializeAfterDispose_Throws()
{
@@ -214,6 +227,7 @@ public sealed class GalaxyDriverFactoryTests
driver.InitializeAsync(MinimalConfig, CancellationToken.None));
}
/// <summary>Verifies that the driver implements all Phase 4 capabilities.</summary>
[Fact]
public void DriverImplementsAllPhase4Capabilities()
{
@@ -229,6 +243,7 @@ public sealed class GalaxyDriverFactoryTests
driver.ShouldBeAssignableTo<IHostConnectivityProbe>();
}
/// <summary>Verifies that GetHostStatuses returns an empty snapshot after initialization with seam.</summary>
[Fact]
public async Task GetHostStatuses_AfterInitWithSeam_ReturnsEmptySnapshot()
{
@@ -243,6 +258,7 @@ public sealed class GalaxyDriverFactoryTests
driver.GetHostStatuses().ShouldBeEmpty();
}
/// <summary>Verifies that the driver type is GalaxyMxGateway, not the legacy Galaxy type.</summary>
[Fact]
public void DriverType_IsGalaxyMxGateway_NotLegacyGalaxy()
{