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 InterfaceIndependenceTests
{
private static readonly Assembly Assembly = typeof(IDriver).Assembly;
/// <summary>Verifies that the assembly has no references outside the BCL.</summary>
[Fact]
public void Assembly_HasNoReferencesOutsideBcl()
{
@@ -37,6 +38,7 @@ public sealed class InterfaceIndependenceTests
$"Found disallowed references: {string.Join(", ", disallowed.Select(a => a.Name))}");
}
/// <summary>Verifies that all public types live in the root namespace.</summary>
[Fact]
public void AllPublicTypes_LiveInRootNamespace()
{
@@ -51,6 +53,8 @@ public sealed class InterfaceIndependenceTests
$"Found types in other namespaces: {string.Join(", ", nonRoot.Select(t => $"{t.FullName}"))}");
}
/// <summary>Verifies that every capability interface is public.</summary>
/// <param name="type">The interface type to check.</param>
[Theory]
[InlineData(typeof(IDriver))]
[InlineData(typeof(ITagDiscovery))]