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,6 +7,7 @@ namespace ZB.MOM.WW.OtOpcUa.Client.Shared.Tests;
[Trait("Category", "Unit")]
public sealed class ClientStoragePathsTests
{
/// <summary>Verifies that GetRoot returns the canonical folder name under LocalAppData.</summary>
[Fact]
public void GetRoot_ReturnsCanonicalFolderName_UnderLocalAppData()
{
@@ -15,6 +16,7 @@ public sealed class ClientStoragePathsTests
root.ShouldContain(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData));
}
/// <summary>Verifies that GetPkiPath nests PKI under root.</summary>
[Fact]
public void GetPkiPath_NestsPkiUnderRoot()
{
@@ -22,12 +24,14 @@ public sealed class ClientStoragePathsTests
pki.ShouldEndWith(Path.Combine(ClientStoragePaths.CanonicalFolderName, "pki"));
}
/// <summary>Verifies that CanonicalFolderName is OtOpcUaClient.</summary>
[Fact]
public void CanonicalFolderName_IsOtOpcUaClient()
{
ClientStoragePaths.CanonicalFolderName.ShouldBe("OtOpcUaClient");
}
/// <summary>Verifies that LegacyFolderName is LmxOpcUaClient.</summary>
[Fact]
public void LegacyFolderName_IsLmxOpcUaClient()
{
@@ -36,6 +40,7 @@ public sealed class ClientStoragePathsTests
ClientStoragePaths.LegacyFolderName.ShouldBe("LmxOpcUaClient");
}
/// <summary>Verifies that TryRunLegacyMigration returns false on repeat invocation.</summary>
[Fact]
public void TryRunLegacyMigration_Returns_False_On_Repeat_Invocation()
{