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
@@ -31,11 +31,16 @@ public sealed class AbServerFixture : IAsyncLifetime
// 10.100.0.35 = the shared Docker host (see CLAUDE.md "Docker Workflow"). Migrated
// off this VM's 127.0.0.1 on 2026-04-28 alongside the rest of the Docker-host move.
// Override via AB_SERVER_ENDPOINT to point at a real PLC or a locally-running container.
/// <summary>Gets the host address of the AB server.</summary>
public string Host { get; } = "10.100.0.35";
/// <summary>Gets the port of the AB server.</summary>
public int Port { get; } = AbServerProfile.DefaultPort;
/// <summary>Initializes a new instance of the AbServerFixture class with the default profile.</summary>
public AbServerFixture() : this(KnownProfiles.ControlLogix) { }
/// <summary>Initializes a new instance of the AbServerFixture class with the specified profile.</summary>
/// <param name="profile">The AB server profile to use.</param>
public AbServerFixture(AbServerProfile profile)
{
Profile = profile ?? throw new ArgumentNullException(nameof(profile));
@@ -50,7 +55,9 @@ public sealed class AbServerFixture : IAsyncLifetime
}
}
/// <inheritdoc />
public ValueTask InitializeAsync() => ValueTask.CompletedTask;
/// <inheritdoc />
public ValueTask DisposeAsync() => ValueTask.CompletedTask;
/// <summary>
@@ -92,6 +99,7 @@ public sealed class AbServerFixture : IAsyncLifetime
/// </summary>
public sealed class AbServerFactAttribute : FactAttribute
{
/// <summary>Initializes a new instance of the AbServerFactAttribute class.</summary>
public AbServerFactAttribute()
{
if (!AbServerFixture.IsServerAvailable())
@@ -109,6 +117,7 @@ public sealed class AbServerFactAttribute : FactAttribute
/// </summary>
public sealed class AbServerTheoryAttribute : TheoryAttribute
{
/// <summary>Initializes a new instance of the AbServerTheoryAttribute class.</summary>
public AbServerTheoryAttribute()
{
if (!AbServerFixture.IsServerAvailable())