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
@@ -13,6 +13,9 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.Cli.Tests;
[Trait("Category", "Unit")]
public sealed class WriteCommandParseValueTests
{
/// <summary>Verifies that boolean parsing accepts multiple aliases for true and false.</summary>
/// <param name="raw">The raw string value to parse.</param>
/// <param name="expected">The expected boolean result.</param>
[Theory]
[InlineData("true", true)]
[InlineData("false", false)]
@@ -27,6 +30,7 @@ public sealed class WriteCommandParseValueTests
WriteCommand.ParseValue(raw, ModbusDataType.Bool).ShouldBe(expected);
}
/// <summary>Verifies that boolean parsing rejects unrecognized string values.</summary>
[Fact]
public void ParseValue_Bool_rejects_unknown_strings()
{
@@ -34,6 +38,7 @@ public sealed class WriteCommandParseValueTests
() => WriteCommand.ParseValue("maybe", ModbusDataType.Bool));
}
/// <summary>Verifies that Int16 parsing handles positive and negative values correctly.</summary>
[Fact]
public void ParseValue_Int16_parses_positive_and_negative()
{
@@ -41,6 +46,7 @@ public sealed class WriteCommandParseValueTests
WriteCommand.ParseValue("32767", ModbusDataType.Int16).ShouldBe((short)32767);
}
/// <summary>Verifies that both UInt16 and Bcd16 parsing return ushort type values.</summary>
[Fact]
public void ParseValue_UInt16_and_Bcd16_both_yield_ushort()
{
@@ -48,12 +54,14 @@ public sealed class WriteCommandParseValueTests
WriteCommand.ParseValue("65535", ModbusDataType.Bcd16).ShouldBeOfType<ushort>();
}
/// <summary>Verifies that Float32 parsing uses invariant culture with period as decimal separator.</summary>
[Fact]
public void ParseValue_Float32_uses_invariant_culture_period_as_decimal_separator()
{
WriteCommand.ParseValue("3.14", ModbusDataType.Float32).ShouldBe(3.14f);
}
/// <summary>Verifies that Float64 parsing maintains precision for larger decimal values.</summary>
[Fact]
public void ParseValue_Float64_handles_larger_precision()
{
@@ -62,12 +70,14 @@ public sealed class WriteCommandParseValueTests
((double)result).ShouldBe(2.718281828d, 0.0000001d);
}
/// <summary>Verifies that String parsing returns the raw input without modification.</summary>
[Fact]
public void ParseValue_String_returns_raw_string_unmodified()
{
WriteCommand.ParseValue("hello world", ModbusDataType.String).ShouldBe("hello world");
}
/// <summary>Verifies that BitInRegister parsing accepts boolean aliases.</summary>
[Fact]
public void ParseValue_BitInRegister_accepts_bool_aliases()
{
@@ -75,12 +85,14 @@ public sealed class WriteCommandParseValueTests
WriteCommand.ParseValue("0", ModbusDataType.BitInRegister).ShouldBe(false);
}
/// <summary>Verifies that Int32 parsing handles negative maximum values correctly.</summary>
[Fact]
public void ParseValue_Int32_parses_negative_max()
{
WriteCommand.ParseValue("-2147483648", ModbusDataType.Int32).ShouldBe(int.MinValue);
}
/// <summary>Verifies that parsing rejects non-numeric strings for numeric data types.</summary>
[Fact]
public void ParseValue_rejects_non_numeric_for_numeric_types()
{