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
@@ -59,6 +59,7 @@ public class FlowShapePredictorTests
private static string? AnySiteScript(string instanceCode, string scriptName)
=> scriptName == "ProcessRecipeDownload" ? DelmiaSiteScript : null;
/// <summary>Verifies that delmia method plus site script predicts the full swimlane shape.</summary>
[Fact]
public void Delmia_MethodPlusSiteScript_PredictsTheFullSwimlaneShape()
{
@@ -104,6 +105,7 @@ public class FlowShapePredictorTests
Assert.True(flow.Edges[^1].CrossesBoundary);
}
/// <summary>Verifies that constant route target is not input dependent and qualifies site titles.</summary>
[Fact]
public void ConstantRouteTarget_IsNotInputDependent_AndQualifiesSiteTitles()
{
@@ -124,6 +126,7 @@ public class FlowShapePredictorTests
Assert.StartsWith("Z28061Sim.", write.Title);
}
/// <summary>Verifies that resolver returning null leaves the site run unexpanded.</summary>
[Fact]
public void ResolverReturningNull_LeavesTheSiteRunUnexpanded()
{
@@ -137,6 +140,7 @@ public class FlowShapePredictorTests
], flow.Nodes.Select(n => n.Kind).ToList());
}
/// <summary>Verifies that no recognised call yields only request and response.</summary>
[Fact]
public void NoRecognisedCall_YieldsOnlyRequestAndResponse()
{
@@ -150,6 +154,7 @@ public class FlowShapePredictorTests
Assert.False(edge.CrossesBoundary);
}
/// <summary>Verifies that recursion stops at max depth.</summary>
[Fact]
public void Recursion_StopsAtMaxDepth()
{
@@ -168,6 +173,7 @@ public class FlowShapePredictorTests
Assert.True(deep.Nodes.Count > shallow.Nodes.Count);
}
/// <summary>Verifies that malformed code never throws and notes the parse error.</summary>
[Fact]
public void MalformedCode_NeverThrows_AndNotesTheParseError()
{
@@ -182,6 +188,7 @@ public class FlowShapePredictorTests
Assert.Equal(FlowShapePredictor.ParseErrorNote, root.Note);
}
/// <summary>Verifies that predict site script roots at the script run and recognises attribute ops.</summary>
[Fact]
public void PredictSiteScript_RootsAtTheScriptRun_AndRecognisesAttributeOps()
{
@@ -208,6 +215,7 @@ public class FlowShapePredictorTests
Assert.Equal(FlowLane.External, flow.Nodes[4].Lane);
}
/// <summary>Verifies that outbound calls sit on the external lane sync in chain cached and notify branch async.</summary>
[Fact]
public void OutboundCalls_SitOnTheExternalLane_SyncInChain_CachedAndNotifyBranchAsync()
{
@@ -246,6 +254,7 @@ public class FlowShapePredictorTests
Assert.All(flow.Edges, e => Assert.False(e.CrossesBoundary));
}
/// <summary>Verifies that cached call is an async api call and notify to resolves the list.</summary>
[Fact]
public void CachedCall_IsAnAsyncApiCall_AndNotifyTo_ResolvesTheList()
{
@@ -268,6 +277,7 @@ public class FlowShapePredictorTests
Assert.Equal([(flow.Nodes[0].Id, true), (flow.Nodes[0].Id, true)], flow.Edges.Select(e => (e.From, e.Async)).ToList());
}
/// <summary>Verifies that outbound calls with computed targets are input dependent.</summary>
[Fact]
public void OutboundCalls_WithComputedTargets_AreInputDependent()
{
@@ -286,6 +296,7 @@ public class FlowShapePredictorTests
Assert.Equal("Notify.Send(list)", outbound[2].Title);
}
/// <summary>Verifies that inbound method database call crosses from central to external.</summary>
[Fact]
public void InboundMethod_DatabaseCall_CrossesFromCentralToExternal()
{
@@ -304,6 +315,7 @@ public class FlowShapePredictorTests
Assert.False(into.Async);
}
/// <summary>Verifies that input dependent attribute name is flagged.</summary>
[Fact]
public void InputDependentAttributeName_IsFlagged()
{
@@ -314,7 +326,7 @@ public class FlowShapePredictorTests
Assert.Equal("name", write.Title);
}
/// <summary>Gitea #36: the reset-aware overload predicts the reset write + echo wait ahead of the batch.</summary>
/// <summary>The reset-aware overload predicts the reset write + echo wait ahead of the batch.</summary>
[Fact]
public void ResetAwareWriteBatchAndWait_PredictsResetWriteAndEchoWaitBeforeTheBatch()
{