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
@@ -19,6 +19,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests;
[Trait("Category", "Unit")]
public sealed class ModbusEdgeCaseValidationTests
{
/// <summary>Verifies that string tags with zero length are rejected during factory creation.</summary>
[Fact]
public void Factory_rejects_String_tag_with_StringLength_zero_via_structured_form()
{
@@ -36,6 +37,7 @@ public sealed class ModbusEdgeCaseValidationTests
ex.Message.ShouldContain("Greeting");
}
/// <summary>Verifies that omitted string length defaults to zero and is rejected.</summary>
[Fact]
public void Factory_rejects_String_tag_with_StringLength_zero_via_missing_field()
{
@@ -53,6 +55,7 @@ public sealed class ModbusEdgeCaseValidationTests
ex.Message.ShouldContain("StringLength");
}
/// <summary>Verifies that string tags with length one are accepted.</summary>
[Fact]
public void Factory_accepts_String_tag_with_StringLength_one()
{
@@ -67,6 +70,7 @@ public sealed class ModbusEdgeCaseValidationTests
Should.NotThrow(() => ModbusDriverFactoryExtensions.CreateInstance("modbus-1", json));
}
/// <summary>Verifies that non-string tags are unaffected by string length zero.</summary>
[Fact]
public void Factory_accepts_non_String_tag_with_StringLength_zero()
{
@@ -82,6 +86,9 @@ public sealed class ModbusEdgeCaseValidationTests
Should.NotThrow(() => ModbusDriverFactoryExtensions.CreateInstance("modbus-1", json));
}
/// <summary>Verifies that sub-second time spans are rounded up to at least one second.</summary>
/// <param name="ms">The input duration in milliseconds.</param>
/// <param name="expected">The expected clamped value in whole seconds.</param>
[Theory]
[InlineData(0, 1)] // zero clamps up to 1
[InlineData(500, 1)] // 500 ms rounds up to 1
@@ -95,6 +102,7 @@ public sealed class ModbusEdgeCaseValidationTests
ModbusTcpTransport.ClampToWholeSeconds(TimeSpan.FromMilliseconds(ms)).ShouldBe(expected);
}
/// <summary>Verifies that negative time spans are treated as one second.</summary>
[Fact]
public void ClampToWholeSeconds_treats_negative_TimeSpan_as_one_second()
{