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
@@ -6,96 +6,112 @@ namespace ZB.MOM.WW.OtOpcUa.Client.Shared.Tests.Helpers;
public class ValueConverterTests
{
/// <summary>Verifies that a boolean string "True" is converted to true.</summary>
[Fact]
public void ConvertValue_Bool_True()
{
ValueConverter.ConvertValue("True", true).ShouldBe(true);
}
/// <summary>Verifies that a boolean string "False" is converted to false.</summary>
[Fact]
public void ConvertValue_Bool_False()
{
ValueConverter.ConvertValue("False", false).ShouldBe(false);
}
/// <summary>Verifies that a byte value is converted correctly.</summary>
[Fact]
public void ConvertValue_Byte()
{
ValueConverter.ConvertValue("255", (byte)0).ShouldBe((byte)255);
}
/// <summary>Verifies that a short value is converted correctly.</summary>
[Fact]
public void ConvertValue_Short()
{
ValueConverter.ConvertValue("-100", (short)0).ShouldBe((short)-100);
}
/// <summary>Verifies that an unsigned short value is converted correctly.</summary>
[Fact]
public void ConvertValue_UShort()
{
ValueConverter.ConvertValue("65535", (ushort)0).ShouldBe((ushort)65535);
}
/// <summary>Verifies that an integer value is converted correctly.</summary>
[Fact]
public void ConvertValue_Int()
{
ValueConverter.ConvertValue("42", 0).ShouldBe(42);
}
/// <summary>Verifies that an unsigned integer value is converted correctly.</summary>
[Fact]
public void ConvertValue_UInt()
{
ValueConverter.ConvertValue("42", 0u).ShouldBe(42u);
}
/// <summary>Verifies that a long value is converted correctly.</summary>
[Fact]
public void ConvertValue_Long()
{
ValueConverter.ConvertValue("9999999999", 0L).ShouldBe(9999999999L);
}
/// <summary>Verifies that an unsigned long value is converted correctly.</summary>
[Fact]
public void ConvertValue_ULong()
{
ValueConverter.ConvertValue("18446744073709551615", 0UL).ShouldBe(ulong.MaxValue);
}
/// <summary>Verifies that a float value is converted correctly.</summary>
[Fact]
public void ConvertValue_Float()
{
ValueConverter.ConvertValue("3.14", 0f).ShouldBe(3.14f);
}
/// <summary>Verifies that a double value is converted correctly.</summary>
[Fact]
public void ConvertValue_Double()
{
ValueConverter.ConvertValue("3.14159", 0.0).ShouldBe(3.14159);
}
/// <summary>Verifies that a string value is converted correctly when the current value is a string.</summary>
[Fact]
public void ConvertValue_String_WhenCurrentIsString()
{
ValueConverter.ConvertValue("hello", "").ShouldBe("hello");
}
/// <summary>Verifies that a string value is converted correctly when the current value is null.</summary>
[Fact]
public void ConvertValue_String_WhenCurrentIsNull()
{
ValueConverter.ConvertValue("hello", null).ShouldBe("hello");
}
/// <summary>Verifies that a string value is converted correctly when the current value is an unknown type.</summary>
[Fact]
public void ConvertValue_String_WhenCurrentIsUnknownType()
{
ValueConverter.ConvertValue("hello", new object()).ShouldBe("hello");
}
/// <summary>Verifies that converting an invalid boolean value throws a FormatException.</summary>
[Fact]
public void ConvertValue_InvalidBool_Throws()
{
Should.Throw<FormatException>(() => ValueConverter.ConvertValue("notabool", true));
}
/// <summary>Verifies that converting an invalid integer value throws a FormatException with a descriptive message.</summary>
[Fact]
public void ConvertValue_InvalidInt_ThrowsWithDescription()
{
@@ -104,6 +120,7 @@ public class ValueConverterTests
ex.Message.ShouldContain("notanint");
}
/// <summary>Verifies that an overflow during conversion throws a FormatException.</summary>
[Fact]
public void ConvertValue_Overflow_ThrowsFormatException()
{
@@ -114,6 +131,9 @@ public class ValueConverterTests
// --- Client.Shared-008: Boolean aliases ---
/// <summary>Verifies that boolean values accept numeric and word aliases.</summary>
/// <param name="input">The input string value.</param>
/// <param name="expected">The expected boolean value.</param>
[Theory]
[InlineData("1", true)]
[InlineData("0", false)]
@@ -130,6 +150,7 @@ public class ValueConverterTests
ValueConverter.ConvertValue(input, true).ShouldBe(expected);
}
/// <summary>Verifies that converting an invalid boolean value throws a descriptive FormatException.</summary>
[Fact]
public void ConvertValue_InvalidBool_ThrowsDescriptiveFormatException()
{