docs: complete XML doc comments via fixdocs (2757 to 131 findings)

Add missing <returns>/<param>/<summary>/<typeparam> tags and clean up
misused inheritdoc across 481 files so the documented API surface is
complete. Documentation-only (zero code lines changed). The 131 remaining
findings are inheritdoc-style warnings deliberately left to preserve
hand-written implementation rationale (plan-decision notes, race-condition
explanations).
This commit is contained in:
Joseph Doherty
2026-06-03 12:34:34 -04:00
parent c6d9b20d9f
commit bd6c0b4d3d
481 changed files with 2550 additions and 1668 deletions
@@ -8,6 +8,7 @@ namespace ZB.MOM.WW.OtOpcUa.Client.CLI.Tests;
public class AlarmsCommandTests
{
/// <summary>Verifies that Execute subscribes to alarms.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Execute_SubscribesToAlarms()
{
@@ -33,6 +34,7 @@ public class AlarmsCommandTests
}
/// <summary>Verifies that Execute with node passes source node ID.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Execute_WithNode_PassesSourceNodeId()
{
@@ -58,6 +60,7 @@ public class AlarmsCommandTests
}
/// <summary>Verifies that Execute with refresh requests condition refresh.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Execute_WithRefresh_RequestsConditionRefresh()
{
@@ -83,6 +86,7 @@ public class AlarmsCommandTests
}
/// <summary>Verifies that refresh failure prints error.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Execute_RefreshFailure_PrintsError()
{
@@ -110,6 +114,7 @@ public class AlarmsCommandTests
}
/// <summary>Verifies that Execute unsubscribes on cancellation.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Execute_UnsubscribesOnCancellation()
{
@@ -132,6 +137,7 @@ public class AlarmsCommandTests
}
/// <summary>Verifies that Execute disconnects in finally block.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Execute_DisconnectsInFinally()
{