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,12 +14,14 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Tests.Runtime;
/// </summary>
public sealed class MxValueDecoderTests
{
/// <summary>Verifies that decoding null returns null.</summary>
[Fact]
public void Decode_Null_ReturnsNull()
{
MxValueDecoder.Decode(null).ShouldBeNull();
}
/// <summary>Verifies that decoding IsNull flag returns null.</summary>
[Fact]
public void Decode_IsNullFlag_ReturnsNull()
{
@@ -27,24 +29,31 @@ public sealed class MxValueDecoderTests
MxValueDecoder.Decode(v).ShouldBeNull();
}
/// <summary>Verifies that bool values decode correctly.</summary>
[Fact]
public void Decode_Bool() => MxValueDecoder.Decode(new MxValue { BoolValue = true }).ShouldBe(true);
/// <summary>Verifies that Int32 values decode correctly.</summary>
[Fact]
public void Decode_Int32() => MxValueDecoder.Decode(new MxValue { Int32Value = -42 }).ShouldBe(-42);
/// <summary>Verifies that Int64 values decode correctly.</summary>
[Fact]
public void Decode_Int64() => MxValueDecoder.Decode(new MxValue { Int64Value = 123456789012L }).ShouldBe(123456789012L);
/// <summary>Verifies that float values decode correctly.</summary>
[Fact]
public void Decode_Float() => MxValueDecoder.Decode(new MxValue { FloatValue = 3.14f }).ShouldBe(3.14f);
/// <summary>Verifies that double values decode correctly.</summary>
[Fact]
public void Decode_Double() => MxValueDecoder.Decode(new MxValue { DoubleValue = 2.71828 }).ShouldBe(2.71828);
/// <summary>Verifies that string values decode correctly.</summary>
[Fact]
public void Decode_String() => MxValueDecoder.Decode(new MxValue { StringValue = "hello" }).ShouldBe("hello");
/// <summary>Verifies that timestamp values decode to UTC datetime.</summary>
[Fact]
public void Decode_Timestamp_ReturnsUtcDateTime()
{
@@ -53,6 +62,7 @@ public sealed class MxValueDecoderTests
MxValueDecoder.Decode(v).ShouldBe(when);
}
/// <summary>Verifies that bool arrays decode correctly.</summary>
[Fact]
public void Decode_BoolArray()
{
@@ -69,6 +79,7 @@ public sealed class MxValueDecoderTests
decoded.ShouldBe(new[] { true, false, true });
}
/// <summary>Verifies that double arrays decode correctly.</summary>
[Fact]
public void Decode_DoubleArray()
{
@@ -82,6 +93,7 @@ public sealed class MxValueDecoderTests
decoded.ShouldBe(new[] { 1.0, 2.0, 3.5 });
}
/// <summary>Verifies that string arrays decode correctly.</summary>
[Fact]
public void Decode_StringArray()
{
@@ -95,6 +107,7 @@ public sealed class MxValueDecoderTests
decoded.ShouldBe(new[] { "a", "b" });
}
/// <summary>Verifies that raw byte values decode correctly.</summary>
[Fact]
public void Decode_RawValue_ReturnsBytes()
{