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
@@ -16,6 +16,10 @@ public sealed class FocasCapabilityMatrixTests
{
// ---- Macro ranges ----
/// <summary>Verifies that macro range matches series.</summary>
/// <param name="series">The FOCAS CNC series to validate.</param>
/// <param name="number">The macro number to test.</param>
/// <param name="accepted">Whether the address should be accepted.</param>
[Theory]
[InlineData(FocasCncSeries.Sixteen_i, 999, true)]
[InlineData(FocasCncSeries.Sixteen_i, 1000, false)] // above legacy ceiling
@@ -37,6 +41,10 @@ public sealed class FocasCapabilityMatrixTests
// ---- Parameter ranges ----
/// <summary>Verifies that parameter range matches series.</summary>
/// <param name="series">The FOCAS CNC series to validate.</param>
/// <param name="number">The parameter number to test.</param>
/// <param name="accepted">Whether the address should be accepted.</param>
[Theory]
[InlineData(FocasCncSeries.Sixteen_i, 9999, true)]
[InlineData(FocasCncSeries.Sixteen_i, 10000, false)] // 16i capped at 9999
@@ -53,6 +61,10 @@ public sealed class FocasCapabilityMatrixTests
// ---- PMC letters ----
/// <summary>Verifies that PMC letter matches series.</summary>
/// <param name="series">The FOCAS CNC series to validate.</param>
/// <param name="letter">The PMC signal group letter to test.</param>
/// <param name="accepted">Whether the address should be accepted.</param>
[Theory]
[InlineData(FocasCncSeries.Sixteen_i, "X", true)]
[InlineData(FocasCncSeries.Sixteen_i, "Y", true)]
@@ -77,6 +89,11 @@ public sealed class FocasCapabilityMatrixTests
// ---- PMC number ceiling ----
/// <summary>Verifies that PMC number ceiling matches series.</summary>
/// <param name="series">The FOCAS CNC series to validate.</param>
/// <param name="letter">The PMC signal group letter to test.</param>
/// <param name="number">The PMC address number to test.</param>
/// <param name="accepted">Whether the address should be accepted.</param>
[Theory]
[InlineData(FocasCncSeries.Sixteen_i, "R", 999, true)]
[InlineData(FocasCncSeries.Sixteen_i, "R", 1000, false)]
@@ -95,6 +112,9 @@ public sealed class FocasCapabilityMatrixTests
// ---- Unknown series is permissive ----
/// <summary>Verifies that unknown series accepts any PMC.</summary>
/// <param name="letter">The PMC signal group letter to test.</param>
/// <param name="number">The PMC address number to test.</param>
[Theory]
[InlineData("Z", 999_999)] // absurd PMC address
[InlineData("Q", 0)] // non-existent letter
@@ -104,6 +124,7 @@ public sealed class FocasCapabilityMatrixTests
FocasCapabilityMatrix.Validate(FocasCncSeries.Unknown, address).ShouldBeNull();
}
/// <summary>Verifies that unknown series accepts any macro number.</summary>
[Fact]
public void Unknown_series_accepts_any_macro_number()
{
@@ -111,6 +132,7 @@ public sealed class FocasCapabilityMatrixTests
FocasCapabilityMatrix.Validate(FocasCncSeries.Unknown, address).ShouldBeNull();
}
/// <summary>Verifies that unknown series accepts any parameter number.</summary>
[Fact]
public void Unknown_series_accepts_any_parameter_number()
{
@@ -120,6 +142,7 @@ public sealed class FocasCapabilityMatrixTests
// ---- Reason messages include enough context to diagnose ----
/// <summary>Verifies that rejection message names series and limit.</summary>
[Fact]
public void Rejection_message_names_series_and_limit()
{
@@ -131,6 +154,7 @@ public sealed class FocasCapabilityMatrixTests
reason.ShouldContain("9999");
}
/// <summary>Verifies that PMC rejection lists accepted letters.</summary>
[Fact]
public void Pmc_rejection_lists_accepted_letters()
{
@@ -144,6 +168,8 @@ public sealed class FocasCapabilityMatrixTests
// ---- PMC address letter is case-insensitive ----
/// <summary>Verifies that PMC letter match is case insensitive on 30i.</summary>
/// <param name="letter">The PMC signal group letter to test in various cases.</param>
[Theory]
[InlineData("x")]
[InlineData("X")]