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,6 +6,7 @@ namespace ZB.MOM.WW.OtOpcUa.Client.Shared.Tests.Helpers;
public class FailoverUrlParserTests
{
/// <summary>Verifies that Parse returns only the primary URL when CSV failover list is null.</summary>
[Fact]
public void Parse_CsvNull_ReturnsPrimaryOnly()
{
@@ -13,6 +14,7 @@ public class FailoverUrlParserTests
result.ShouldBe(["opc.tcp://primary:4840"]);
}
/// <summary>Verifies that Parse returns only the primary URL when CSV failover list is empty.</summary>
[Fact]
public void Parse_CsvEmpty_ReturnsPrimaryOnly()
{
@@ -20,6 +22,7 @@ public class FailoverUrlParserTests
result.ShouldBe(["opc.tcp://primary:4840"]);
}
/// <summary>Verifies that Parse returns only the primary URL when CSV failover list is whitespace.</summary>
[Fact]
public void Parse_CsvWhitespace_ReturnsPrimaryOnly()
{
@@ -27,6 +30,7 @@ public class FailoverUrlParserTests
result.ShouldBe(["opc.tcp://primary:4840"]);
}
/// <summary>Verifies that Parse returns both primary and single failover URL.</summary>
[Fact]
public void Parse_SingleFailover_ReturnsBoth()
{
@@ -34,6 +38,7 @@ public class FailoverUrlParserTests
result.ShouldBe(["opc.tcp://primary:4840", "opc.tcp://backup:4840"]);
}
/// <summary>Verifies that Parse returns primary URL and all failover URLs from CSV list.</summary>
[Fact]
public void Parse_MultipleFailovers_ReturnsAll()
{
@@ -41,6 +46,7 @@ public class FailoverUrlParserTests
result.ShouldBe(["opc.tcp://primary:4840", "opc.tcp://backup1:4840", "opc.tcp://backup2:4840"]);
}
/// <summary>Verifies that Parse trims leading and trailing whitespace from failover URLs.</summary>
[Fact]
public void Parse_TrimsWhitespace()
{
@@ -48,6 +54,7 @@ public class FailoverUrlParserTests
result.ShouldBe(["opc.tcp://primary:4840", "opc.tcp://backup:4840"]);
}
/// <summary>Verifies that Parse deduplicates the primary URL if present in the failover list.</summary>
[Fact]
public void Parse_DeduplicatesPrimaryInFailoverList()
{
@@ -55,6 +62,7 @@ public class FailoverUrlParserTests
result.ShouldBe(["opc.tcp://primary:4840", "opc.tcp://backup:4840"]);
}
/// <summary>Verifies that Parse performs case-insensitive deduplication of URLs.</summary>
[Fact]
public void Parse_DeduplicatesCaseInsensitive()
{
@@ -62,6 +70,7 @@ public class FailoverUrlParserTests
result.ShouldBe(["opc.tcp://Primary:4840"]);
}
/// <summary>Verifies that Parse returns only the primary URL when array of failover URLs is null.</summary>
[Fact]
public void Parse_ArrayNull_ReturnsPrimaryOnly()
{
@@ -69,6 +78,7 @@ public class FailoverUrlParserTests
result.ShouldBe(["opc.tcp://primary:4840"]);
}
/// <summary>Verifies that Parse returns only the primary URL when array of failover URLs is empty.</summary>
[Fact]
public void Parse_ArrayEmpty_ReturnsPrimaryOnly()
{
@@ -76,6 +86,7 @@ public class FailoverUrlParserTests
result.ShouldBe(["opc.tcp://primary:4840"]);
}
/// <summary>Verifies that Parse returns primary URL and all failover URLs from array.</summary>
[Fact]
public void Parse_ArrayWithUrls_ReturnsAll()
{
@@ -84,6 +95,7 @@ public class FailoverUrlParserTests
result.ShouldBe(["opc.tcp://primary:4840", "opc.tcp://backup1:4840", "opc.tcp://backup2:4840"]);
}
/// <summary>Verifies that Parse deduplicates URLs from array if primary URL is present.</summary>
[Fact]
public void Parse_ArrayDeduplicates()
{
@@ -92,6 +104,7 @@ public class FailoverUrlParserTests
result.ShouldBe(["opc.tcp://primary:4840", "opc.tcp://backup:4840"]);
}
/// <summary>Verifies that Parse trims whitespace from URLs in array.</summary>
[Fact]
public void Parse_ArrayTrimsWhitespace()
{
@@ -100,6 +113,7 @@ public class FailoverUrlParserTests
result.ShouldBe(["opc.tcp://primary:4840", "opc.tcp://backup:4840"]);
}
/// <summary>Verifies that Parse skips null and empty URLs from array.</summary>
[Fact]
public void Parse_ArraySkipsNullAndEmpty()
{