docs(tests): fix CommentChecker findings across tests/ — 13,392 → 0 (repo-wide scan clean)

Comment/XML-doc changes only:
- add summaries to ~10k test methods, fixtures, fakes and helpers
  (+ <param> on theories, <returns> on async Task methods,
  <inheritdoc/> on interface implementations the checker can resolve)
- strip ~2.6k project-tracking references (WP*, P*-*, row-NN, Task N,
  #NN, Component-0NN) from comments, keeping the explanatory text;
  reword false positives in comments only
- real docs on fakes implementing BCL/library interfaces
  (IDisposable, ILogger, IOptionsMonitor, IAsyncLifetime)
- reword the last 5 src/ false positives (CWE-1236, failures-1,
  year-0001, M365)

Only non-comment edits: four one-line nested classes split across lines
so members can carry docs. Build 0 errors / 0 warnings.
This commit is contained in:
Joseph Doherty
2026-10-07 15:05:49 -04:00
parent 0ffd4bdbea
commit 513fa1aa16
998 changed files with 17896 additions and 2395 deletions
@@ -18,6 +18,7 @@ public class CliRunnerHelpersTests
/// <see cref="CliRunner.ListTemplateIdsByNamePrefixAsync"/>, and
/// <see cref="CliRunner.DeleteTemplateAsync"/> as a round-trip.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task CreateThenDeleteTemplate_RoundTrips()
{
@@ -37,6 +38,7 @@ public class CliRunnerHelpersTests
/// <c>site-a</c> seed site by its <c>siteIdentifier</c> and returns a
/// positive id.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task ResolveSiteA_ReturnsId()
{
@@ -49,6 +51,7 @@ public class CliRunnerHelpersTests
/// deleted in teardown, exercising <see cref="CliRunner.CreateDataConnectionAsync"/>
/// and <see cref="CliRunner.DeleteDataConnectionAsync"/> as a round-trip.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task CreateThenDeleteDataConnection_RoundTrips()
{
@@ -70,6 +73,7 @@ public class CliRunnerHelpersTests
/// teardown, exercising <see cref="CliRunner.CreateApiMethodAsync"/> and
/// <see cref="CliRunner.DeleteApiMethodAsync"/> as a round-trip.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task CreateThenDeleteApiMethod_RoundTrips()
{
@@ -93,6 +97,7 @@ public class CliRunnerHelpersTests
/// <see cref="CliRunner.ListAreaIdsByNamePrefixAsync"/>, and
/// <see cref="CliRunner.DeleteAreaAsync"/>.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task ListAreaIdsByNamePrefix_FindsCreatedArea()
{
@@ -118,6 +123,7 @@ public class CliRunnerHelpersTests
/// <see cref="CliRunner.ListExternalSystemIdsByNamePrefixAsync"/>, and
/// <see cref="CliRunner.DeleteExternalSystemAsync"/> as a round-trip.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task CreateThenDeleteExternalSystem_RoundTrips()
{
@@ -138,6 +144,7 @@ public class CliRunnerHelpersTests
/// <see cref="CliRunner.ListNotificationListIdsByNamePrefixAsync"/>, and
/// <see cref="CliRunner.DeleteNotificationListAsync"/> as a round-trip.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task CreateThenDeleteNotificationList_RoundTrips()
{
@@ -157,6 +164,7 @@ public class CliRunnerHelpersTests
/// teardown, exercising <see cref="CliRunner.CreateSharedScriptAsync"/> and
/// <see cref="CliRunner.DeleteSharedScriptAsync"/> as a round-trip.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task CreateThenDeleteSharedScript_RoundTrips()
{
@@ -172,6 +180,7 @@ public class CliRunnerHelpersTests
/// teardown, exercising <see cref="CliRunner.CreateRoleMappingAsync"/> and
/// <see cref="CliRunner.DeleteRoleMappingAsync"/> as a round-trip.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task CreateThenDeleteRoleMapping_RoundTrips()
{
@@ -194,6 +203,7 @@ public class CliRunnerHelpersTests
/// <see cref="CliRunner.AddAlarmAsync"/> with <c>--hi</c>/<c>--hihi</c> returns a
/// positive id, confirming the server accepted the serialized trigger-config JSON.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task AddAlarmWithTypedFlags_RoundTrips()
{