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
@@ -7,24 +7,28 @@ namespace ZB.MOM.WW.OtOpcUa.Client.CLI.Tests;
public class NodeIdParserTests
{
/// <summary>Verifies that Parse returns null for null input.</summary>
[Fact]
public void Parse_NullInput_ReturnsNull()
{
NodeIdParser.Parse(null).ShouldBeNull();
}
/// <summary>Verifies that Parse returns null for empty string input.</summary>
[Fact]
public void Parse_EmptyString_ReturnsNull()
{
NodeIdParser.Parse("").ShouldBeNull();
}
/// <summary>Verifies that Parse returns null for whitespace-only input.</summary>
[Fact]
public void Parse_WhitespaceOnly_ReturnsNull()
{
NodeIdParser.Parse(" ").ShouldBeNull();
}
/// <summary>Verifies that Parse correctly parses standard NodeId format (ns=2;s=MyNode).</summary>
[Fact]
public void Parse_StandardStringFormat_ReturnsNodeId()
{
@@ -34,6 +38,7 @@ public class NodeIdParserTests
result.Identifier.ShouldBe("MyNode");
}
/// <summary>Verifies that Parse correctly parses numeric NodeId format (i=85).</summary>
[Fact]
public void Parse_NumericFormat_ReturnsNodeId()
{
@@ -42,6 +47,7 @@ public class NodeIdParserTests
result.IdType.ShouldBe(IdType.Numeric);
}
/// <summary>Verifies that Parse treats bare numeric input as namespace 0 numeric NodeId.</summary>
[Fact]
public void Parse_BareNumeric_ReturnsNamespace0NumericNodeId()
{
@@ -51,6 +57,7 @@ public class NodeIdParserTests
result.Identifier.ShouldBe((uint)85);
}
/// <summary>Verifies that Parse trims whitespace padding from input.</summary>
[Fact]
public void Parse_WithWhitespacePadding_Trims()
{
@@ -59,24 +66,28 @@ public class NodeIdParserTests
result.Identifier.ShouldBe("MyNode");
}
/// <summary>Verifies that Parse throws FormatException for invalid input.</summary>
[Fact]
public void Parse_InvalidFormat_ThrowsFormatException()
{
Should.Throw<FormatException>(() => NodeIdParser.Parse("not-a-node-id"));
}
/// <summary>Verifies that ParseRequired throws ArgumentException for null input.</summary>
[Fact]
public void ParseRequired_NullInput_ThrowsArgumentException()
{
Should.Throw<ArgumentException>(() => NodeIdParser.ParseRequired(null));
}
/// <summary>Verifies that ParseRequired throws ArgumentException for empty input.</summary>
[Fact]
public void ParseRequired_EmptyInput_ThrowsArgumentException()
{
Should.Throw<ArgumentException>(() => NodeIdParser.ParseRequired(""));
}
/// <summary>Verifies that ParseRequired returns a NodeId for valid input.</summary>
[Fact]
public void ParseRequired_ValidInput_ReturnsNodeId()
{