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
@@ -8,6 +8,9 @@ namespace ZB.MOM.WW.OtOpcUa.Client.Shared.Tests.Helpers;
public class SecurityModeMapperTests
{
/// <summary>Verifies ToMessageSecurityMode correctly maps SecurityMode values to OPC UA MessageSecurityMode.</summary>
/// <param name="input">The SecurityMode value to map.</param>
/// <param name="expected">The expected MessageSecurityMode result.</param>
[Theory]
[InlineData(SecurityMode.None, MessageSecurityMode.None)]
[InlineData(SecurityMode.Sign, MessageSecurityMode.Sign)]
@@ -17,6 +20,7 @@ public class SecurityModeMapperTests
SecurityModeMapper.ToMessageSecurityMode(input).ShouldBe(expected);
}
/// <summary>Verifies ToMessageSecurityMode throws on invalid SecurityMode values.</summary>
[Fact]
public void ToMessageSecurityMode_InvalidValue_Throws()
{
@@ -24,6 +28,9 @@ public class SecurityModeMapperTests
SecurityModeMapper.ToMessageSecurityMode((SecurityMode)99));
}
/// <summary>Verifies FromString correctly parses security mode strings (case-insensitive).</summary>
/// <param name="input">The security mode string to parse.</param>
/// <param name="expected">The expected SecurityMode result.</param>
[Theory]
[InlineData("none", SecurityMode.None)]
[InlineData("None", SecurityMode.None)]
@@ -38,18 +45,21 @@ public class SecurityModeMapperTests
SecurityModeMapper.FromString(input).ShouldBe(expected);
}
/// <summary>Verifies FromString correctly parses strings with leading and trailing whitespace.</summary>
[Fact]
public void FromString_WithWhitespace_ParsesCorrectly()
{
SecurityModeMapper.FromString(" sign ").ShouldBe(SecurityMode.Sign);
}
/// <summary>Verifies FromString throws on unrecognized security mode strings.</summary>
[Fact]
public void FromString_UnknownValue_Throws()
{
Should.Throw<ArgumentException>(() => SecurityModeMapper.FromString("invalid"));
}
/// <summary>Verifies FromString returns None when passed a null string.</summary>
[Fact]
public void FromString_Null_DefaultsToNone()
{