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
@@ -82,6 +82,7 @@ namespace ZB.MOM.WW.OtOpcUa.Core.Resilience {
}
""";
/// <summary>Verifies that a direct ReadAsync call in the Server namespace trips the diagnostic.</summary>
[Fact]
public async Task Direct_ReadAsync_Call_InServerNamespace_TripsDiagnostic()
{
@@ -105,6 +106,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
diags[0].GetMessage().ShouldContain("ReadAsync");
}
/// <summary>Verifies that a wrapped ReadAsync call inside a CapabilityInvoker lambda passes cleanly.</summary>
[Fact]
public async Task Wrapped_ReadAsync_InsideCapabilityInvokerLambda_PassesCleanly()
{
@@ -128,6 +130,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
diags.ShouldBeEmpty();
}
/// <summary>Verifies that a direct write without wrapper trips the diagnostic.</summary>
[Fact]
public async Task DirectWrite_WithoutWrapper_TripsDiagnostic()
{
@@ -150,6 +153,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
diags[0].GetMessage().ShouldContain("WriteAsync");
}
/// <summary>Verifies that a discovery call without wrapper trips the diagnostic.</summary>
[Fact]
public async Task Discovery_Call_WithoutWrapper_TripsDiagnostic()
{
@@ -171,6 +175,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
diags[0].GetMessage().ShouldContain("DiscoverAsync");
}
/// <summary>Verifies that a call outside of a lambda but inside an invoker call still trips the diagnostic.</summary>
[Fact]
public async Task Call_OutsideOfLambda_ButInsideInvokerCall_StillTripsDiagnostic()
{
@@ -204,6 +209,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
// ISubscribable
// -----------------------------------------------------------------------
/// <summary>Verifies that a direct SubscribeAsync call trips the diagnostic.</summary>
[Fact]
public async Task Direct_SubscribeAsync_Call_TripsDiagnostic()
{
@@ -227,6 +233,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
diags[0].GetMessage().ShouldContain("SubscribeAsync");
}
/// <summary>Verifies that a wrapped SubscribeAsync call inside a CapabilityInvoker lambda passes cleanly.</summary>
[Fact]
public async Task Wrapped_SubscribeAsync_InsideCapabilityInvokerLambda_PassesCleanly()
{
@@ -256,6 +263,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
// IAlarmSource
// -----------------------------------------------------------------------
/// <summary>Verifies that a direct SubscribeAlarmsAsync call trips the diagnostic.</summary>
[Fact]
public async Task Direct_SubscribeAlarmsAsync_Call_TripsDiagnostic()
{
@@ -278,6 +286,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
diags[0].GetMessage().ShouldContain("SubscribeAlarmsAsync");
}
/// <summary>Verifies that a wrapped SubscribeAlarmsAsync call inside a CapabilityInvoker lambda passes cleanly.</summary>
[Fact]
public async Task Wrapped_SubscribeAlarmsAsync_InsideCapabilityInvokerLambda_PassesCleanly()
{
@@ -306,6 +315,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
// IHistoryProvider — interface-typed receiver
// -----------------------------------------------------------------------
/// <summary>Verifies that a direct ReadRawAsync call on an interface trips the diagnostic.</summary>
[Fact]
public async Task Direct_ReadRawAsync_OnInterface_TripsDiagnostic()
{
@@ -328,6 +338,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
diags[0].GetMessage().ShouldContain("ReadRawAsync");
}
/// <summary>Verifies that a direct ReadProcessedAsync call on an interface trips the diagnostic.</summary>
[Fact]
public async Task Direct_ReadProcessedAsync_OnInterface_TripsDiagnostic()
{
@@ -350,6 +361,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
diags[0].GetMessage().ShouldContain("ReadProcessedAsync");
}
/// <summary>Verifies that a direct ReadAtTimeAsync call on an interface trips the diagnostic.</summary>
[Fact]
public async Task Direct_ReadAtTimeAsync_OnInterface_TripsDiagnostic()
{
@@ -375,6 +387,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
diags[0].GetMessage().ShouldContain("ReadAtTimeAsync");
}
/// <summary>Verifies that a wrapped ReadRawAsync call inside a CapabilityInvoker lambda passes cleanly.</summary>
[Fact]
public async Task Wrapped_ReadRawAsync_InsideCapabilityInvokerLambda_PassesCleanly()
{
@@ -403,6 +416,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
// IHistoryProvider — concrete driver receiver (FindImplementationForInterfaceMember branch)
// -----------------------------------------------------------------------
/// <summary>Verifies that a direct HistoryRead call on a concrete driver trips the diagnostic.</summary>
[Fact]
public async Task Direct_HistoryRead_OnConcreteDriver_TripsDiagnostic()
{
@@ -436,6 +450,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
// IHostConnectivityProbe — synchronous member must NOT be flagged
// -----------------------------------------------------------------------
/// <summary>Verifies that a synchronous GetHostStatuses call is not flagged.</summary>
[Fact]
public async Task Synchronous_GetHostStatuses_IsNotFlagged()
{
@@ -459,6 +474,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
// Concrete driver receiver with a renamed implementing method
// -----------------------------------------------------------------------
/// <summary>Verifies that a concrete driver with a renamed read method still trips the diagnostic.</summary>
[Fact]
public async Task ConcreteDriver_RenamedReadMethod_StillTripsDiagnostic()
{
@@ -503,6 +519,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
// ExecuteWriteAsync wrapping
// -----------------------------------------------------------------------
/// <summary>Verifies that a wrapped WriteAsync call inside ExecuteWriteAsync passes cleanly.</summary>
[Fact]
public async Task Wrapped_WriteAsync_InsideExecuteWriteAsync_PassesCleanly()
{
@@ -531,6 +548,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
// Nested lambda — inner guarded call must not be suppressed by outer non-wrapper lambda
// -----------------------------------------------------------------------
/// <summary>Verifies that a guarded call inside a nested non-wrapper lambda trips the diagnostic.</summary>
[Fact]
public async Task GuardedCall_InsideNestedNonWrapperLambda_TripsDiagnostic()
{
@@ -559,6 +577,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
diags[0].GetMessage().ShouldContain("ReadAsync");
}
/// <summary>Verifies that a guarded call inside a wrapper lambda inside a non-wrapper lambda passes cleanly.</summary>
[Fact]
public async Task GuardedCall_InsideWrapperLambda_InsideNonWrapperLambda_PassesCleanly()
{
@@ -595,6 +614,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
// match because the actual wrapping lambda lives on _invoker.ExecuteAsync.
// =======================================================================
/// <summary>Verifies that a guarded call inside an alarm surface invoker method wrapped by CapabilityInvoker passes cleanly.</summary>
[Fact]
public async Task GuardedCall_InsideAlarmSurfaceInvokerMethod_WrappedByCapabilityInvoker_PassesCleanly()
{
@@ -632,6 +652,7 @@ namespace ZB.MOM.WW.OtOpcUa.Core.Resilience.Test {
// can pin the no-false-positive contract for unrelated invocations.
// =======================================================================
/// <summary>Verifies that a non-guarded async call does not trip the diagnostic.</summary>
[Fact]
public async Task NonGuardedAsyncCall_DoesNotTrip()
{
@@ -659,6 +680,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
// referenced at all, the analyzer must be a no-op for the compilation.
// =======================================================================
/// <summary>Verifies that a compilation without guarded interface references emits no diagnostics.</summary>
[Fact]
public async Task Compilation_WithoutGuardedInterfaceReferences_EmitsNoDiagnostics()
{
@@ -686,6 +708,7 @@ namespace SomeOther {
// Analyzers-005 — IHistoryProvider default-interface-method asymmetry
// =======================================================================
/// <summary>Verifies that a direct ReadAtTimeAsync call on a concrete driver inheriting the DIM trips the diagnostic.</summary>
[Fact]
public async Task Direct_ReadAtTimeAsync_OnConcreteDriverInheritingDIM_TripsDiagnostic()
{
@@ -721,6 +744,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
diags[0].GetMessage().ShouldContain("ReadAtTimeAsync");
}
/// <summary>Verifies that a direct ReadEventsAsync call on a concrete driver inheriting the DIM trips the diagnostic.</summary>
[Fact]
public async Task Direct_ReadEventsAsync_OnConcreteDriverInheritingDIM_TripsDiagnostic()
{
@@ -750,6 +774,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
diags[0].GetMessage().ShouldContain("ReadEventsAsync");
}
/// <summary>Verifies that a direct ReadAtTimeAsync call on a concrete driver overriding the DIM trips the diagnostic.</summary>
[Fact]
public async Task Direct_ReadAtTimeAsync_OnConcreteDriverOverridingDIM_TripsDiagnostic()
{
@@ -781,6 +806,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
diags[0].GetMessage().ShouldContain("ReadAtTimeAsync");
}
/// <summary>Verifies that a wrapped ReadAtTimeAsync DIM call inside a CapabilityInvoker lambda passes cleanly.</summary>
[Fact]
public async Task Wrapped_ReadAtTimeAsync_DIM_InsideCapabilityInvokerLambda_PassesCleanly()
{