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
@@ -12,6 +12,7 @@ namespace ZB.MOM.WW.OtOpcUa.Core.Scripting.Tests;
[Trait("Category", "Unit")]
public sealed class DependencyExtractorTests
{
/// <summary>Verifies that a single literal tag read is extracted.</summary>
[Fact]
public void Extracts_single_literal_read()
{
@@ -24,6 +25,7 @@ public sealed class DependencyExtractorTests
result.Rejections.ShouldBeEmpty();
}
/// <summary>Verifies that multiple distinct tag reads are extracted.</summary>
[Fact]
public void Extracts_multiple_distinct_reads()
{
@@ -39,6 +41,7 @@ public sealed class DependencyExtractorTests
result.Reads.ShouldContain("Line1/B");
}
/// <summary>Verifies that identical reads are deduplicated.</summary>
[Fact]
public void Deduplicates_identical_reads_across_the_script()
{
@@ -53,6 +56,7 @@ public sealed class DependencyExtractorTests
result.Reads.ShouldContain("X");
}
/// <summary>Verifies that virtual tag writes are tracked separately from reads.</summary>
[Fact]
public void Tracks_virtual_tag_writes_separately_from_reads()
{
@@ -69,6 +73,7 @@ public sealed class DependencyExtractorTests
result.Writes.ShouldNotContain("InTag");
}
/// <summary>Verifies that variable paths are rejected.</summary>
[Fact]
public void Rejects_variable_path()
{
@@ -82,6 +87,7 @@ public sealed class DependencyExtractorTests
result.Rejections[0].Message.ShouldContain("string literal");
}
/// <summary>Verifies that concatenated string paths are rejected.</summary>
[Fact]
public void Rejects_concatenated_path()
{
@@ -91,6 +97,7 @@ public sealed class DependencyExtractorTests
result.Rejections[0].Message.ShouldContain("string literal");
}
/// <summary>Verifies that interpolated string paths are rejected.</summary>
[Fact]
public void Rejects_interpolated_path()
{
@@ -103,6 +110,7 @@ public sealed class DependencyExtractorTests
result.Rejections[0].Message.ShouldContain("string literal");
}
/// <summary>Verifies that method-returned paths are rejected.</summary>
[Fact]
public void Rejects_method_returned_path()
{
@@ -115,6 +123,7 @@ public sealed class DependencyExtractorTests
result.Rejections[0].Message.ShouldContain("string literal");
}
/// <summary>Verifies that empty literal paths are rejected.</summary>
[Fact]
public void Rejects_empty_literal_path()
{
@@ -124,6 +133,7 @@ public sealed class DependencyExtractorTests
result.Rejections[0].Message.ShouldContain("empty");
}
/// <summary>Verifies that whitespace-only paths are rejected.</summary>
[Fact]
public void Rejects_whitespace_only_path()
{
@@ -132,6 +142,7 @@ public sealed class DependencyExtractorTests
result.IsValid.ShouldBeFalse();
}
/// <summary>Verifies that free-function GetTag calls are ignored.</summary>
[Fact]
public void Ignores_non_ctx_method_named_GetTag_free_function()
{
@@ -147,6 +158,7 @@ public sealed class DependencyExtractorTests
result.Reads.ShouldBeEmpty();
}
/// <summary>Verifies that member-access GetTag on non-ctx receivers is ignored.</summary>
[Fact]
public void Ignores_member_access_GetTag_on_non_ctx_receiver()
{
@@ -165,6 +177,7 @@ public sealed class DependencyExtractorTests
result.Reads.ShouldNotContain("X");
}
/// <summary>Verifies that empty source is handled without error.</summary>
[Fact]
public void Empty_source_is_a_no_op()
{
@@ -173,6 +186,7 @@ public sealed class DependencyExtractorTests
DependencyExtractor.Extract(null!).IsValid.ShouldBeTrue();
}
/// <summary>Verifies that rejections include source span for UI pointing.</summary>
[Fact]
public void Rejection_carries_source_span_for_UI_pointing()
{
@@ -185,6 +199,7 @@ public sealed class DependencyExtractorTests
result.Rejections[0].Span.Length.ShouldBeGreaterThan(0);
}
/// <summary>Verifies that all bad paths are reported in a single pass.</summary>
[Fact]
public void Multiple_bad_paths_all_reported_in_one_pass()
{
@@ -197,6 +212,7 @@ public sealed class DependencyExtractorTests
result.Rejections.Count.ShouldBe(2);
}
/// <summary>Verifies that nested literal GetTag calls inside expressions are extracted.</summary>
[Fact]
public void Nested_literal_GetTag_inside_expression_is_extracted()
{
@@ -210,6 +226,7 @@ public sealed class DependencyExtractorTests
result.Reads.Count.ShouldBe(2);
}
/// <summary>Verifies that single-line raw string literal paths are accepted.</summary>
[Fact]
public void Accepts_single_line_raw_string_literal_path()
{
@@ -224,6 +241,7 @@ public sealed class DependencyExtractorTests
result.Rejections.ShouldBeEmpty();
}
/// <summary>Verifies that multi-line raw string literal paths are accepted.</summary>
[Fact]
public void Accepts_multi_line_raw_string_literal_path()
{