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
@@ -10,6 +10,7 @@ namespace ZB.MOM.WW.OtOpcUa.Client.CLI.Tests;
public class HistoryReadCommandTests
{
/// <summary>Verifies RawRead execution prints values.</summary>
/// <returns>A task that represents the asynchronous test.</returns>
[Fact]
public async Task Execute_RawRead_PrintsValues()
{
@@ -44,6 +45,7 @@ public class HistoryReadCommandTests
}
/// <summary>Verifies RawRead execution calls HistoryReadRaw.</summary>
/// <returns>A task that represents the asynchronous test.</returns>
[Fact]
public async Task Execute_RawRead_CallsHistoryReadRaw()
{
@@ -65,6 +67,7 @@ public class HistoryReadCommandTests
}
/// <summary>Verifies AggregateRead execution calls HistoryReadAggregate.</summary>
/// <returns>A task that represents the asynchronous test.</returns>
[Fact]
public async Task Execute_AggregateRead_CallsHistoryReadAggregate()
{
@@ -87,6 +90,7 @@ public class HistoryReadCommandTests
}
/// <summary>Verifies AggregateRead execution prints aggregate info.</summary>
/// <returns>A task that represents the asynchronous test.</returns>
[Fact]
public async Task Execute_AggregateRead_PrintsAggregateInfo()
{
@@ -109,6 +113,7 @@ public class HistoryReadCommandTests
}
/// <summary>Verifies invalid aggregate throws CommandException.</summary>
/// <returns>A task that represents the asynchronous test.</returns>
[Fact]
public async Task Execute_InvalidAggregate_ThrowsCommandException()
{
@@ -129,6 +134,7 @@ public class HistoryReadCommandTests
}
/// <summary>Verifies disconnect is called in finally block.</summary>
/// <returns>A task that represents the asynchronous test.</returns>
[Fact]
public async Task Execute_DisconnectsInFinally()
{