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,7 @@ public sealed class OpcUaClientNamespaceTests
{
// ---- Driver.OpcUaClient-004: TargetNamespaceKind startup enforcement ----
/// <summary>Verifies that Equipment namespace kind without mapping table is rejected.</summary>
[Fact]
public void ValidateNamespaceKind_Equipment_without_mapping_table_is_rejected()
{
@@ -24,6 +25,7 @@ public sealed class OpcUaClientNamespaceTests
.Message.ShouldContain("UnsMappingTable");
}
/// <summary>Verifies that Equipment namespace kind with mapping table passes.</summary>
[Fact]
public void ValidateNamespaceKind_Equipment_with_mapping_table_passes()
{
@@ -35,6 +37,7 @@ public sealed class OpcUaClientNamespaceTests
Should.NotThrow(() => OpcUaClientDriver.ValidateNamespaceKind(opts));
}
/// <summary>Verifies that SystemPlatform namespace kind with mapping table is rejected.</summary>
[Fact]
public void ValidateNamespaceKind_SystemPlatform_with_mapping_table_is_rejected()
{
@@ -48,6 +51,7 @@ public sealed class OpcUaClientNamespaceTests
.Message.ShouldContain("SystemPlatform");
}
/// <summary>Verifies that SystemPlatform namespace kind without mapping table passes.</summary>
[Fact]
public void ValidateNamespaceKind_SystemPlatform_without_mapping_table_passes()
{
@@ -55,6 +59,7 @@ public sealed class OpcUaClientNamespaceTests
Should.NotThrow(() => OpcUaClientDriver.ValidateNamespaceKind(opts));
}
/// <summary>Verifies that the default target namespace kind is Equipment.</summary>
[Fact]
public void Default_TargetNamespaceKind_is_Equipment()
{
@@ -64,10 +69,12 @@ public sealed class OpcUaClientNamespaceTests
// ---- Driver.OpcUaClient-004: server-stable NodeId encoding ----
/// <summary>Verifies that NamespaceMap.FromSession rejects null session.</summary>
[Fact]
public void NamespaceMap_FromSession_rejects_null_session() =>
Should.Throw<ArgumentNullException>(() => NamespaceMap.FromSession(null!));
/// <summary>Verifies that namespace 0 NodeId keeps compact form.</summary>
[Fact]
public void NamespaceMap_namespace0_NodeId_keeps_compact_form()
{
@@ -79,6 +86,7 @@ public sealed class OpcUaClientNamespaceTests
map.ToStableReference(coreNode).ShouldNotContain("nsu=");
}
/// <summary>Verifies that nonzero namespace NodeId is encoded with URI, not index.</summary>
[Fact]
public void NamespaceMap_nonzero_namespace_NodeId_is_encoded_with_uri_not_index()
{
@@ -92,6 +100,7 @@ public sealed class OpcUaClientNamespaceTests
stable.ShouldNotStartWith("ns=1");
}
/// <summary>Verifies that unknown namespace index falls back to raw form.</summary>
[Fact]
public void NamespaceMap_unknown_namespace_index_falls_back_to_raw_form()
{
@@ -102,6 +111,7 @@ public sealed class OpcUaClientNamespaceTests
Should.NotThrow(() => map.ToStableReference(node));
}
/// <summary>Verifies that namespace index and URI lookups are bidirectional.</summary>
[Fact]
public void NamespaceMap_index_and_uri_lookups_are_bidirectional()
{
@@ -113,6 +123,7 @@ public sealed class OpcUaClientNamespaceTests
map.UriForIndex(99).ShouldBeNull();
}
/// <summary>Verifies that NamespaceMap.TryResolve rejects empty and null input.</summary>
[Fact]
public void NamespaceMap_TryResolve_rejects_empty_and_null_input()
{