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
@@ -6,7 +6,7 @@ using ZB.MOM.WW.ScadaBridge.TemplateEngine;
namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.ScriptAnalysis;
/// <summary>
/// Regression tests for CentralUI-013. <c>ResolveCalledShape</c> resolved shared
/// Regression tests for sync-over-async shared-script resolution. <c>ResolveCalledShape</c> resolved shared
/// script shapes with <c>_sharedScripts.GetShapesAsync().GetAwaiter().GetResult()</c>
/// — a sync-over-async block on a request thread that risks thread-pool
/// starvation and deadlock. <c>Hover</c> and <c>SignatureHelp</c> were synchronous
@@ -20,6 +20,7 @@ public class ScriptAnalysisAsyncResolveTests
private readonly IServiceProvider _services = Substitute.For<IServiceProvider>();
private readonly ScriptAnalysisService _svc;
/// <summary>Initializes the test class and its script analysis service.</summary>
public ScriptAnalysisAsyncResolveTests()
{
_catalog.GetShapesAsync().Returns(Array.Empty<ScriptShape>());
@@ -29,6 +30,8 @@ public class ScriptAnalysisAsyncResolveTests
private static ScriptShape Shape(string name, params ParameterShape[] ps) => new(name, ps, null);
private static ParameterShape Param(string name, string type) => new(name, type, true);
/// <summary>Verifies that hover on a shared-call name awaits the catalog and resolves the call shape.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task HoverAsync_OnSharedCallName_AwaitsCatalog_AndResolvesShape()
{
@@ -53,6 +56,8 @@ public class ScriptAnalysisAsyncResolveTests
Assert.Contains("Aggregate", resp.Markdown);
}
/// <summary>Verifies that signature help inside a shared call awaits the catalog and resolves the parameters.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SignatureHelpAsync_InsideSharedCall_AwaitsCatalog_AndResolvesParameters()
{
@@ -75,6 +80,7 @@ public class ScriptAnalysisAsyncResolveTests
Assert.Equal(2, resp.Parameters!.Count);
}
/// <summary>Verifies that hover and signature help are asynchronous rather than sync-over-async.</summary>
[Fact]
public void HoverAndSignatureHelp_AreAsync_NotSyncOverAsync()
{