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
@@ -7,6 +7,10 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.TwinCAT.Tests;
[Trait("Category", "Unit")]
public sealed class TwinCATAmsAddressTests
{
/// <summary>Verifies that TryParse accepts valid AMS addresses in various formats.</summary>
/// <param name="input">The raw AMS address string to parse.</param>
/// <param name="netId">The expected AMS Net ID after parsing.</param>
/// <param name="port">The expected AMS port after parsing.</param>
[Theory]
[InlineData("ads://5.23.91.23.1.1:851", "5.23.91.23.1.1", 851)]
[InlineData("ads://5.23.91.23.1.1:852", "5.23.91.23.1.1", 852)]
@@ -22,6 +26,8 @@ public sealed class TwinCATAmsAddressTests
parsed.Port.ShouldBe(port);
}
/// <summary>Verifies that TryParse rejects invalid AMS address forms.</summary>
/// <param name="input">The invalid AMS address string that should be rejected.</param>
[Theory]
[InlineData(null)]
[InlineData("")]
@@ -41,6 +47,10 @@ public sealed class TwinCATAmsAddressTests
TwinCATAmsAddress.TryParse(input).ShouldBeNull();
}
/// <summary>Verifies that ToString produces canonical AMS address strings.</summary>
/// <param name="netId">The AMS Net ID to use.</param>
/// <param name="port">The AMS port to use.</param>
/// <param name="expected">The expected canonical string representation.</param>
[Theory]
[InlineData("5.23.91.23.1.1", 851, "ads://5.23.91.23.1.1")] // default port stripped
[InlineData("5.23.91.23.1.1", 852, "ads://5.23.91.23.1.1:852")]
@@ -49,6 +59,7 @@ public sealed class TwinCATAmsAddressTests
new TwinCATAmsAddress(netId, port).ToString().ShouldBe(expected);
}
/// <summary>Verifies that parsing and stringifying an AMS address is stable.</summary>
[Fact]
public void RoundTrip_is_stable()
{