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,9 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Tests.Runtime;
/// </summary>
public sealed class StatusCodeMapTests
{
/// <summary>Verifies that known quality bytes map to the expected OPC UA status codes.</summary>
/// <param name="input">The Galaxy quality byte to map.</param>
/// <param name="expected">The expected OPC UA status code.</param>
[Theory]
[InlineData((byte)192, 0x00000000u)] // Good
[InlineData((byte)216, 0x00D80000u)] // Good_LocalOverride
@@ -35,6 +38,8 @@ public sealed class StatusCodeMapTests
StatusCodeMap.FromQualityByte(input).ShouldBe(expected);
}
/// <summary>Verifies that unknown quality bytes fall back to category bucket status codes.</summary>
/// <param name="input">The unknown Galaxy quality byte to categorize.</param>
[Theory]
[InlineData((byte)200)] // Unknown Good — falls back to category bucket
[InlineData((byte)100)] // Unknown Uncertain
@@ -53,12 +58,14 @@ public sealed class StatusCodeMapTests
// would invert the mapping when the worker sets success=1 for an error code (the numeric
// value is NOT a boolean).
/// <summary>Verifies that null status maps to Good status code.</summary>
[Fact]
public void FromMxStatus_NullStatus_IsGood()
{
StatusCodeMap.FromMxStatus(null).ShouldBe(StatusCodeMap.Good);
}
/// <summary>Verifies that non-zero success with OK category maps to Good.</summary>
[Fact]
public void FromMxStatus_SuccessNonZeroAndCategoryOk_IsGood()
{
@@ -67,6 +74,7 @@ public sealed class StatusCodeMapTests
StatusCodeMap.FromMxStatus(s).ShouldBe(StatusCodeMap.Good);
}
/// <summary>Verifies that non-zero success with non-OK category does not map to Good.</summary>
[Fact]
public void FromMxStatus_SuccessNonZeroButCategoryNotOk_IsNotGood()
{
@@ -76,6 +84,7 @@ public sealed class StatusCodeMapTests
StatusCodeMap.FromMxStatus(s).ShouldNotBe(StatusCodeMap.Good);
}
/// <summary>Verifies that known detail codes map to their specific status codes.</summary>
[Fact]
public void FromMxStatus_SuccessZeroAndCategoryNotOk_DetailKnown_MapsToSpecificCode()
{
@@ -83,6 +92,7 @@ public sealed class StatusCodeMapTests
StatusCodeMap.FromMxStatus(s).ShouldBe(StatusCodeMap.BadNotConnected);
}
/// <summary>Verifies that non-zero DetectedBy maps to communication error when detail is zero.</summary>
[Fact]
public void FromMxStatus_SuccessZero_DetailZero_DetectedByNonZero_IsCommunicationError()
{
@@ -90,6 +100,7 @@ public sealed class StatusCodeMapTests
StatusCodeMap.FromMxStatus(s).ShouldBe(StatusCodeMap.BadCommunicationError);
}
/// <summary>Verifies that all-zero status maps to Bad status code.</summary>
[Fact]
public void FromMxStatus_SuccessZero_AllZero_IsBad()
{
@@ -97,6 +108,7 @@ public sealed class StatusCodeMapTests
StatusCodeMap.FromMxStatus(s).ShouldBe(StatusCodeMap.Bad);
}
/// <summary>Verifies that top two bits of status codes follow OPC UA convention.</summary>
[Fact]
public void TopByteCategoryBits_StayWithinOpcUaConvention()
{
@@ -115,6 +127,9 @@ public sealed class StatusCodeMapTests
// ===== Driver.Galaxy-004 regression: ToQualityCategoryByte lives next to its inverse =====
/// <summary>Verifies that status codes extract to their OPC DA category byte equivalent.</summary>
/// <param name="statusCode">The OPC UA status code to convert.</param>
/// <param name="expected">The expected OPC DA category byte.</param>
[Theory]
[InlineData(0x00000000u, (byte)192)] // Good
[InlineData(0x00D80000u, (byte)192)] // GoodLocalOverride — still Good category
@@ -128,6 +143,7 @@ public sealed class StatusCodeMapTests
StatusCodeMap.ToQualityCategoryByte(statusCode).ShouldBe(expected);
}
/// <summary>Verifies that ToQualityCategoryByte is the right inverse of FromQualityByte for category bytes.</summary>
[Fact]
public void ToQualityCategoryByte_IsRightInverseOfFromQualityByte_ForCategoryBytes()
{