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
@@ -13,6 +13,7 @@ namespace ZB.MOM.WW.OtOpcUa.Client.CLI.Tests;
public class CommandRangeValidationTests
{
/// <summary>Verifies that BrowseCommand rejects negative depth values with a command exception.</summary>
/// <returns>A task that represents the asynchronous test.</returns>
[Fact]
public async Task BrowseCommand_NegativeDepth_ThrowsCommandException()
{
@@ -30,6 +31,7 @@ public class CommandRangeValidationTests
}
/// <summary>Verifies that BrowseCommand rejects zero depth values with a command exception.</summary>
/// <returns>A task that represents the asynchronous test.</returns>
[Fact]
public async Task BrowseCommand_ZeroDepth_ThrowsCommandException()
{
@@ -47,6 +49,7 @@ public class CommandRangeValidationTests
}
/// <summary>Verifies that SubscribeCommand rejects zero interval values with a command exception.</summary>
/// <returns>A task that represents the asynchronous test.</returns>
[Fact]
public async Task SubscribeCommand_ZeroInterval_ThrowsCommandException()
{
@@ -65,6 +68,7 @@ public class CommandRangeValidationTests
}
/// <summary>Verifies that SubscribeCommand rejects negative interval values with a command exception.</summary>
/// <returns>A task that represents the asynchronous test.</returns>
[Fact]
public async Task SubscribeCommand_NegativeInterval_ThrowsCommandException()
{
@@ -82,6 +86,7 @@ public class CommandRangeValidationTests
}
/// <summary>Verifies that SubscribeCommand in recursive mode rejects zero max depth with a command exception.</summary>
/// <returns>A task that represents the asynchronous test.</returns>
[Fact]
public async Task SubscribeCommand_RecursiveZeroMaxDepth_ThrowsCommandException()
{
@@ -102,6 +107,7 @@ public class CommandRangeValidationTests
}
/// <summary>Verifies that SubscribeCommand rejects negative duration values with a command exception.</summary>
/// <returns>A task that represents the asynchronous test.</returns>
[Fact]
public async Task SubscribeCommand_NegativeDuration_ThrowsCommandException()
{
@@ -119,6 +125,7 @@ public class CommandRangeValidationTests
}
/// <summary>Verifies that AlarmsCommand rejects zero interval values with a command exception.</summary>
/// <returns>A task that represents the asynchronous test.</returns>
[Fact]
public async Task AlarmsCommand_ZeroInterval_ThrowsCommandException()
{
@@ -136,6 +143,7 @@ public class CommandRangeValidationTests
}
/// <summary>Verifies that HistoryReadCommand rejects negative max values with a command exception.</summary>
/// <returns>A task that represents the asynchronous test.</returns>
[Fact]
public async Task HistoryReadCommand_NegativeMax_ThrowsCommandException()
{
@@ -154,6 +162,7 @@ public class CommandRangeValidationTests
}
/// <summary>Verifies that HistoryReadCommand rejects zero interval values with a command exception.</summary>
/// <returns>A task that represents the asynchronous test.</returns>
[Fact]
public async Task HistoryReadCommand_ZeroInterval_ThrowsCommandException()
{