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.Cluster.Tests;
public sealed class HoconLoaderTests
{
/// <summary>Verifies that LoadBaseConfig returns a non-empty string.</summary>
[Fact]
public void LoadBaseConfig_returns_nonempty_string()
{
@@ -13,6 +14,7 @@ public sealed class HoconLoaderTests
hocon.ShouldNotBeNullOrWhiteSpace();
}
/// <summary>Verifies that base config parses to cluster provider.</summary>
[Fact]
public void Base_config_parses_to_cluster_provider()
{
@@ -20,6 +22,7 @@ public sealed class HoconLoaderTests
cfg.GetString("akka.actor.provider").ShouldBe("cluster");
}
/// <summary>Verifies that split-brain resolver is set to keep-oldest.</summary>
[Fact]
public void Split_brain_resolver_is_keep_oldest()
{
@@ -27,6 +30,7 @@ public sealed class HoconLoaderTests
cfg.GetString("akka.cluster.split-brain-resolver.active-strategy").ShouldBe("keep-oldest");
}
/// <summary>Verifies that stable-after is configured to 15 seconds.</summary>
[Fact]
public void Stable_after_is_15_seconds()
{
@@ -35,6 +39,7 @@ public sealed class HoconLoaderTests
.ShouldBe(TimeSpan.FromSeconds(15));
}
/// <summary>Verifies that failure detector threshold is set to 10.</summary>
[Fact]
public void Failure_detector_threshold_is_10()
{
@@ -42,6 +47,7 @@ public sealed class HoconLoaderTests
cfg.GetDouble("akka.cluster.failure-detector.threshold").ShouldBe(10.0);
}
/// <summary>Verifies that OPC UA synchronized dispatcher is configured as pinned.</summary>
[Fact]
public void Opcua_synchronized_dispatcher_is_pinned()
{
@@ -5,6 +5,8 @@ namespace ZB.MOM.WW.OtOpcUa.Cluster.Tests;
public sealed class RoleParserTests
{
/// <summary>Verifies that empty input yields an empty array.</summary>
/// <param name="raw">The raw input string to test (null, empty, or whitespace).</param>
[Theory]
[InlineData(null)]
[InlineData("")]
@@ -14,36 +16,42 @@ public sealed class RoleParserTests
RoleParser.Parse(raw).ShouldBeEmpty();
}
/// <summary>Verifies that a single role 'admin' is parsed correctly.</summary>
[Fact]
public void Single_role_admin()
{
RoleParser.Parse("admin").ShouldBe(new[] { "admin" });
}
/// <summary>Verifies that two roles separated by comma are parsed correctly.</summary>
[Fact]
public void Two_roles_csv()
{
RoleParser.Parse("admin,driver").ShouldBe(new[] { "admin", "driver" });
}
/// <summary>Verifies that parser tolerates surrounding whitespace.</summary>
[Fact]
public void Whitespace_tolerant()
{
RoleParser.Parse(" admin , driver ").ShouldBe(new[] { "admin", "driver" });
}
/// <summary>Verifies that parser is case-insensitive and normalizes to lowercase.</summary>
[Fact]
public void Case_insensitive_normalizes_to_lower()
{
RoleParser.Parse("ADMIN,Driver").ShouldBe(new[] { "admin", "driver" });
}
/// <summary>Verifies that duplicate roles are removed.</summary>
[Fact]
public void Duplicate_roles_deduped()
{
RoleParser.Parse("admin,admin,driver").ShouldBe(new[] { "admin", "driver" });
}
/// <summary>Verifies that parser throws for unknown roles.</summary>
[Fact]
public void Unknown_role_throws()
{