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,6 +14,9 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.FOCAS.Cli.Tests;
[Trait("Category", "Unit")]
public sealed class WriteCommandParseValueTests
{
/// <summary>Verifies that ParseValue accepts common boolean aliases for Bit type.</summary>
/// <param name="raw">The raw string input to parse.</param>
/// <param name="expected">The expected boolean result.</param>
[Theory]
[InlineData("true", true)]
[InlineData("0", false)]
@@ -24,6 +27,7 @@ public sealed class WriteCommandParseValueTests
WriteCommand.ParseValue(raw, FocasDataType.Bit).ShouldBe(expected);
}
/// <summary>Verifies that ParseValue rejects garbage Bit input as CommandException.</summary>
[Fact]
public void ParseValue_Bit_rejects_garbage_as_CommandException()
{
@@ -31,6 +35,7 @@ public sealed class WriteCommandParseValueTests
() => WriteCommand.ParseValue("maybe", FocasDataType.Bit));
}
/// <summary>Verifies that ParseValue accepts signed byte range.</summary>
[Fact]
public void ParseValue_Byte_signed_range()
{
@@ -39,6 +44,7 @@ public sealed class WriteCommandParseValueTests
WriteCommand.ParseValue("127", FocasDataType.Byte).ShouldBe((sbyte)127);
}
/// <summary>Verifies that ParseValue accepts signed 16-bit range.</summary>
[Fact]
public void ParseValue_Int16_signed_range()
{
@@ -46,24 +52,28 @@ public sealed class WriteCommandParseValueTests
WriteCommand.ParseValue("32767", FocasDataType.Int16).ShouldBe(short.MaxValue);
}
/// <summary>Verifies that ParseValue parses negative Int32 values.</summary>
[Fact]
public void ParseValue_Int32_parses_negative()
{
WriteCommand.ParseValue("-2147483648", FocasDataType.Int32).ShouldBe(int.MinValue);
}
/// <summary>Verifies that ParseValue parses Float32 in invariant culture.</summary>
[Fact]
public void ParseValue_Float32_invariant_culture()
{
WriteCommand.ParseValue("3.14", FocasDataType.Float32).ShouldBe(3.14f);
}
/// <summary>Verifies that ParseValue preserves Float64 higher precision.</summary>
[Fact]
public void ParseValue_Float64_higher_precision()
{
WriteCommand.ParseValue("2.718281828", FocasDataType.Float64).ShouldBeOfType<double>();
}
/// <summary>Verifies that ParseValue passes through string values unchanged.</summary>
[Fact]
public void ParseValue_String_passthrough()
{
@@ -74,6 +84,9 @@ public sealed class WriteCommandParseValueTests
// one-line CliFx error), NOT a raw FormatException stack trace. Previously the raw
// BCL parser exceptions leaked, contradicting how the Bit path already handled bad
// boolean input.
/// <summary>Verifies that ParseValue throws CommandException for non-numeric input to numeric types.</summary>
/// <param name="raw">The non-numeric raw input string.</param>
/// <param name="type">The FOCAS data type to attempt parsing into.</param>
[Theory]
[InlineData("xyz", FocasDataType.Byte)]
[InlineData("xyz", FocasDataType.Int16)]
@@ -88,6 +101,9 @@ public sealed class WriteCommandParseValueTests
}
// OverflowException from out-of-range input must also surface as CommandException.
/// <summary>Verifies that ParseValue throws CommandException for overflow in numeric types.</summary>
/// <param name="raw">The out-of-range raw input string.</param>
/// <param name="type">The FOCAS data type whose range is exceeded.</param>
[Theory]
[InlineData("128", FocasDataType.Byte)] // sbyte max + 1
[InlineData("-129", FocasDataType.Byte)] // sbyte min - 1
@@ -100,6 +116,7 @@ public sealed class WriteCommandParseValueTests
() => WriteCommand.ParseValue(raw, type));
}
/// <summary>Verifies that ParseValue CommandException message names the type and value.</summary>
[Fact]
public void ParseValue_CommandException_message_names_the_type_and_value()
{
@@ -109,6 +126,10 @@ public sealed class WriteCommandParseValueTests
ex.Message.ShouldContain("Int16");
}
/// <summary>Verifies that SynthesiseTagName preserves FOCAS address verbatim.</summary>
/// <param name="address">The FOCAS address string.</param>
/// <param name="type">The FOCAS data type appended to the tag name.</param>
/// <param name="expected">The expected synthesised tag name.</param>
[Theory]
[InlineData("R100", FocasDataType.Int16, "R100:Int16")]
[InlineData("X0.0", FocasDataType.Bit, "X0.0:Bit")]