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.Modbus.Addressing.Tests;
[Trait("Category", "Unit")]
public sealed class ModbusModiconAddressTests
{
/// <summary>Verifies that valid Modicon addresses parse correctly to region and offset.</summary>
/// <param name="address">The Modicon address string to parse.</param>
/// <param name="expectedRegion">The expected Modbus region.</param>
/// <param name="expectedOffset">The expected PDU offset.</param>
[Theory]
// 5-digit form, one per region. Trailing 4 digits = 1-based register; PDU offset is one less.
[InlineData("00001", ModbusRegion.Coils, (ushort)0)]
@@ -31,6 +35,9 @@ public sealed class ModbusModiconAddressTests
offset.ShouldBe(expectedOffset);
}
/// <summary>Verifies that invalid addresses produce diagnostic error messages.</summary>
/// <param name="address">The invalid address string to test.</param>
/// <param name="fragment">The expected diagnostic fragment in the exception message.</param>
[Theory]
[InlineData("", "null or empty")]
[InlineData(" ", "null or empty")]
@@ -49,6 +56,7 @@ public sealed class ModbusModiconAddressTests
.Message.ShouldContain(fragment, Case.Insensitive);
}
/// <summary>Verifies that TryParse returns false with a diagnostic error on invalid input.</summary>
[Fact]
public void TryParse_Returns_False_With_Diagnostic_On_Invalid()
{
@@ -57,6 +65,7 @@ public sealed class ModbusModiconAddressTests
error.ShouldNotBeNull();
}
/// <summary>Verifies that TryParse returns true with null error on valid input.</summary>
[Fact]
public void TryParse_Returns_True_With_Null_Error_On_Valid()
{
@@ -67,6 +76,7 @@ public sealed class ModbusModiconAddressTests
error.ShouldBeNull();
}
/// <summary>Verifies that TryParse handles null input gracefully.</summary>
[Fact]
public void TryParse_Handles_Null()
{
@@ -74,6 +84,7 @@ public sealed class ModbusModiconAddressTests
error.ShouldNotBeNull();
}
/// <summary>Verifies that TryParse trims leading and trailing whitespace.</summary>
[Fact]
public void TryParse_Trims_Whitespace()
{