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.Driver.TwinCAT.Tests;
[Trait("Category", "Unit")]
public sealed class TwinCATSymbolPathTests
{
/// <summary>Verifies that a single segment global variable parses correctly.</summary>
[Fact]
public void Single_segment_global_variable_parses()
{
@@ -16,6 +17,7 @@ public sealed class TwinCATSymbolPathTests
p.ToAdsSymbolName().ShouldBe("Counter");
}
/// <summary>Verifies that a POU dot-separated variable parses correctly.</summary>
[Fact]
public void POU_dot_variable_parses()
{
@@ -25,6 +27,7 @@ public sealed class TwinCATSymbolPathTests
p.ToAdsSymbolName().ShouldBe("MAIN.bStart");
}
/// <summary>Verifies that a GVL reference parses correctly.</summary>
[Fact]
public void GVL_reference_parses()
{
@@ -34,6 +37,7 @@ public sealed class TwinCATSymbolPathTests
p.ToAdsSymbolName().ShouldBe("GVL.Counter");
}
/// <summary>Verifies that structured member access is split into segments.</summary>
[Fact]
public void Structured_member_access_splits()
{
@@ -42,6 +46,7 @@ public sealed class TwinCATSymbolPathTests
p.Segments.Select(s => s.Name).ShouldBe(["Motor1", "Status", "Running"]);
}
/// <summary>Verifies that array subscripts parse correctly.</summary>
[Fact]
public void Array_subscript_parses()
{
@@ -51,6 +56,7 @@ public sealed class TwinCATSymbolPathTests
p.ToAdsSymbolName().ShouldBe("Data[5]");
}
/// <summary>Verifies that multi-dimensional array subscripts parse correctly.</summary>
[Fact]
public void Multi_dim_array_subscript_parses()
{
@@ -59,6 +65,7 @@ public sealed class TwinCATSymbolPathTests
p.Segments.Single().Subscripts.ShouldBe([1, 2]);
}
/// <summary>Verifies that bit access is captured as a bit index.</summary>
[Fact]
public void Bit_access_captured_as_bit_index()
{
@@ -69,6 +76,7 @@ public sealed class TwinCATSymbolPathTests
p.ToAdsSymbolName().ShouldBe("Flags.3");
}
/// <summary>Verifies that bit access works after a member path.</summary>
[Fact]
public void Bit_access_after_member_path()
{
@@ -78,6 +86,7 @@ public sealed class TwinCATSymbolPathTests
p.BitIndex.ShouldBe(7);
}
/// <summary>Verifies that combined scope, member, subscript, and bit access parses correctly.</summary>
[Fact]
public void Combined_scope_member_subscript_bit()
{
@@ -89,6 +98,8 @@ public sealed class TwinCATSymbolPathTests
p.ToAdsSymbolName().ShouldBe("MAIN.Motors[0].Status.5");
}
/// <summary>Verifies that invalid symbol path shapes return null.</summary>
/// <param name="input">The invalid symbol path input to test.</param>
[Theory]
[InlineData(null)]
[InlineData("")]
@@ -108,12 +119,14 @@ public sealed class TwinCATSymbolPathTests
TwinCATSymbolPath.TryParse(input).ShouldBeNull();
}
/// <summary>Verifies that underscore-prefixed identifiers are accepted.</summary>
[Fact]
public void Underscore_prefix_idents_accepted()
{
TwinCATSymbolPath.TryParse("_internal_var")!.Segments.Single().Name.ShouldBe("_internal_var");
}
/// <summary>Verifies that ToAdsSymbolName roundtrips correctly for various symbol formats.</summary>
[Fact]
public void ToAdsSymbolName_roundtrips()
{