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
@@ -21,8 +21,15 @@ public class AutoLoginAuthenticationHandlerTests
private sealed class StubOptionsMonitor : IOptionsMonitor<AuthenticationSchemeOptions>
{
private readonly AuthenticationSchemeOptions _value = new();
/// <summary>Gets the fixed options value.</summary>
public AuthenticationSchemeOptions CurrentValue => _value;
/// <summary>Returns the fixed options value regardless of name.</summary>
/// <param name="name">The options name, ignored.</param>
/// <returns>The fixed options value.</returns>
public AuthenticationSchemeOptions Get(string? name) => _value;
/// <summary>Ignores the change listener; the fake never raises change notifications.</summary>
/// <param name="listener">The change listener, ignored.</param>
/// <returns>Always <see langword="null"/>.</returns>
public IDisposable? OnChange(Action<AuthenticationSchemeOptions, string?> listener) => null;
}
@@ -41,6 +48,8 @@ public class AutoLoginAuthenticationHandlerTests
return handler;
}
/// <summary>Verifies that authenticate, when grants all roles, system wide as configured user.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Authenticate_GrantsAllRoles_SystemWide_AsConfiguredUser()
{
@@ -56,6 +65,8 @@ public class AutoLoginAuthenticationHandlerTests
Assert.Empty(p.FindAll(JwtTokenService.SiteIdClaimType)); // system-wide => no scope claims
}
/// <summary>Verifies that authenticate, when blank user, falls back to multi role.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Authenticate_BlankUser_FallsBackToMultiRole()
{
@@ -64,6 +75,8 @@ public class AutoLoginAuthenticationHandlerTests
Assert.Equal("multi-role", result.Principal!.Identity!.Name);
}
/// <summary>Verifies that sign in and sign out, when are no ops, do not throw.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SignInAndSignOut_AreNoOps_DoNotThrow()
{