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
@@ -8,18 +8,21 @@ namespace ZB.MOM.WW.OtOpcUa.Runtime.Tests.Drivers;
public sealed class DeploymentArtifactTests
{
/// <summary>Verifies that empty blob returns empty list.</summary>
[Fact]
public void Empty_blob_returns_empty_list()
{
DeploymentArtifact.ParseDriverInstances(ReadOnlySpan<byte>.Empty).ShouldBeEmpty();
}
/// <summary>Verifies that malformed JSON returns empty list.</summary>
[Fact]
public void Malformed_json_returns_empty_list()
{
DeploymentArtifact.ParseDriverInstances(Encoding.UTF8.GetBytes("not json")).ShouldBeEmpty();
}
/// <summary>Verifies that snapshot without DriverInstances returns empty.</summary>
[Fact]
public void Snapshot_without_DriverInstances_returns_empty()
{
@@ -27,6 +30,7 @@ public sealed class DeploymentArtifactTests
DeploymentArtifact.ParseDriverInstances(blob).ShouldBeEmpty();
}
/// <summary>Verifies that driver instances are parsed from composer-shaped blob.</summary>
[Fact]
public void Parses_driver_instances_from_composer_shaped_blob()
{
@@ -69,6 +73,7 @@ public sealed class DeploymentArtifactTests
specs[1].Enabled.ShouldBeFalse();
}
/// <summary>Verifies that ParseComposition returns empty for empty blob.</summary>
[Fact]
public void ParseComposition_returns_empty_for_empty_blob()
{
@@ -78,6 +83,7 @@ public sealed class DeploymentArtifactTests
c.ScriptedAlarmPlans.ShouldBeEmpty();
}
/// <summary>Verifies that ParseComposition reads all three entity classes sorted by ID.</summary>
[Fact]
public void ParseComposition_reads_all_three_entity_classes_sorted_by_id()
{
@@ -111,6 +117,7 @@ public sealed class DeploymentArtifactTests
c.ScriptedAlarmPlans.Single().ScriptedAlarmId.ShouldBe("alarm-1");
}
/// <summary>Verifies that specs missing required fields are dropped.</summary>
[Fact]
public void Spec_missing_required_fields_is_dropped()
{