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
@@ -12,6 +12,9 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.TwinCAT.Cli.Tests;
[Trait("Category", "Unit")]
public sealed class WriteCommandParseValueTests
{
/// <summary>Verifies that ParseValue Bool accepts common aliases.</summary>
/// <param name="raw">The raw input string to parse.</param>
/// <param name="expected">The expected boolean result.</param>
[Theory]
[InlineData("true", true)]
[InlineData("0", false)]
@@ -22,6 +25,7 @@ public sealed class WriteCommandParseValueTests
WriteCommand.ParseValue(raw, TwinCATDataType.Bool).ShouldBe(expected);
}
/// <summary>Verifies that ParseValue Bool rejects garbage.</summary>
[Fact]
public void ParseValue_Bool_rejects_garbage()
{
@@ -29,72 +33,84 @@ public sealed class WriteCommandParseValueTests
() => WriteCommand.ParseValue("maybe", TwinCATDataType.Bool));
}
/// <summary>Verifies that ParseValue SInt parses signed byte.</summary>
[Fact]
public void ParseValue_SInt_signed_byte()
{
WriteCommand.ParseValue("-128", TwinCATDataType.SInt).ShouldBe((sbyte)-128);
}
/// <summary>Verifies that ParseValue USInt parses unsigned byte.</summary>
[Fact]
public void ParseValue_USInt_unsigned_byte()
{
WriteCommand.ParseValue("255", TwinCATDataType.USInt).ShouldBe((byte)255);
}
/// <summary>Verifies that ParseValue Int parses signed 16-bit value.</summary>
[Fact]
public void ParseValue_Int_signed_16bit()
{
WriteCommand.ParseValue("-32768", TwinCATDataType.Int).ShouldBe((short)-32768);
}
/// <summary>Verifies that ParseValue UInt parses unsigned 16-bit value.</summary>
[Fact]
public void ParseValue_UInt_unsigned_16bit()
{
WriteCommand.ParseValue("65535", TwinCATDataType.UInt).ShouldBe((ushort)65535);
}
/// <summary>Verifies that ParseValue DInt parses int32 bounds.</summary>
[Fact]
public void ParseValue_DInt_int32_bounds()
{
WriteCommand.ParseValue("-2147483648", TwinCATDataType.DInt).ShouldBe(int.MinValue);
}
/// <summary>Verifies that ParseValue UDInt parses uint32 maximum.</summary>
[Fact]
public void ParseValue_UDInt_uint32_max()
{
WriteCommand.ParseValue("4294967295", TwinCATDataType.UDInt).ShouldBe(uint.MaxValue);
}
/// <summary>Verifies that ParseValue LInt parses int64 minimum.</summary>
[Fact]
public void ParseValue_LInt_int64_min()
{
WriteCommand.ParseValue("-9223372036854775808", TwinCATDataType.LInt).ShouldBe(long.MinValue);
}
/// <summary>Verifies that ParseValue ULInt parses uint64 maximum.</summary>
[Fact]
public void ParseValue_ULInt_uint64_max()
{
WriteCommand.ParseValue("18446744073709551615", TwinCATDataType.ULInt).ShouldBe(ulong.MaxValue);
}
/// <summary>Verifies that ParseValue Real uses invariant culture.</summary>
[Fact]
public void ParseValue_Real_invariant_culture()
{
WriteCommand.ParseValue("3.14", TwinCATDataType.Real).ShouldBe(3.14f);
}
/// <summary>Verifies that ParseValue LReal has higher precision.</summary>
[Fact]
public void ParseValue_LReal_higher_precision()
{
WriteCommand.ParseValue("2.718281828", TwinCATDataType.LReal).ShouldBeOfType<double>();
}
/// <summary>Verifies that ParseValue String passes through input unchanged.</summary>
[Fact]
public void ParseValue_String_passthrough()
{
WriteCommand.ParseValue("hallo beckhoff", TwinCATDataType.String).ShouldBe("hallo beckhoff");
}
/// <summary>Verifies that ParseValue WString passes through input unchanged.</summary>
[Fact]
public void ParseValue_WString_passthrough()
{
@@ -103,6 +119,8 @@ public sealed class WriteCommandParseValueTests
WriteCommand.ParseValue("überstall", TwinCATDataType.WString).ShouldBe("überstall");
}
/// <summary>Verifies that ParseValue IEC date/time variants land on uint32.</summary>
/// <param name="type">The IEC 61131-3 data type to parse.</param>
[Theory]
[InlineData(TwinCATDataType.Time)]
[InlineData(TwinCATDataType.Date)]
@@ -115,6 +133,7 @@ public sealed class WriteCommandParseValueTests
WriteCommand.ParseValue("1234567", type).ShouldBeOfType<uint>();
}
/// <summary>Verifies that ParseValue Structure is refused.</summary>
[Fact]
public void ParseValue_Structure_refused()
{
@@ -122,6 +141,7 @@ public sealed class WriteCommandParseValueTests
() => WriteCommand.ParseValue("42", TwinCATDataType.Structure));
}
/// <summary>Verifies that ParseValue non-numeric for numeric types throws.</summary>
[Fact]
public void ParseValue_non_numeric_for_numeric_types_throws()
{
@@ -129,6 +149,10 @@ public sealed class WriteCommandParseValueTests
() => WriteCommand.ParseValue("xyz", TwinCATDataType.DInt));
}
/// <summary>Verifies that SynthesiseTagName preserves symbolic path verbatim.</summary>
/// <param name="symbol">The symbolic path to synthesise.</param>
/// <param name="type">The TwinCAT data type.</param>
/// <param name="expected">The expected synthesised tag name.</param>
[Theory]
[InlineData("MAIN.bStart", TwinCATDataType.Bool, "MAIN.bStart:Bool")]
[InlineData("GVL.Counter", TwinCATDataType.DInt, "GVL.Counter:DInt")]