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
@@ -3,25 +3,28 @@ using ZB.MOM.WW.ScadaBridge.ScriptAnalysis;
namespace ZB.MOM.WW.ScadaBridge.ScriptAnalysis.Tests;
/// <summary>
/// M3.1: parse + compile gate tests. The "representative real script" corpus is
/// Parse + compile gate tests. The "representative real script" corpus is
/// the PRIMARY guard that <see cref="ScriptCompileSurface"/> faithfully mirrors
/// the runtime <c>ScriptGlobals</c> surface — if a member or signature drifts,
/// the corpus stops binding and this test fails.
/// </summary>
public class RoslynScriptCompilerTests
{
/// <summary>Verifies that parse diagnostics non empty for syntax error.</summary>
[Fact]
public void ParseDiagnostics_NonEmpty_ForSyntaxError()
{
Assert.NotEmpty(RoslynScriptCompiler.ParseDiagnostics("var x = ;"));
}
/// <summary>Verifies that parse diagnostics empty for valid syntax.</summary>
[Fact]
public void ParseDiagnostics_Empty_ForValidSyntax()
{
Assert.Empty(RoslynScriptCompiler.ParseDiagnostics("var x = 1;"));
}
/// <summary>Verifies that compile non empty for undefined symbol.</summary>
[Fact]
public void Compile_NonEmpty_ForUndefinedSymbol()
{
@@ -29,6 +32,7 @@ public class RoslynScriptCompilerTests
Assert.NotEmpty(RoslynScriptCompiler.Compile(code, typeof(ScriptCompileSurface)));
}
/// <summary>Verifies that compile empty for representative real script.</summary>
[Fact]
public void Compile_Empty_ForRepresentativeRealScript()
{
@@ -67,6 +71,7 @@ public class RoslynScriptCompilerTests
Assert.Empty(diagnostics);
}
/// <summary>Verifies that compile empty for a recipe file parsing script.</summary>
[Fact]
public void Compile_Empty_ForARecipeFileParsingScript()
{
@@ -89,6 +94,7 @@ public class RoslynScriptCompilerTests
Assert.Empty(RoslynScriptCompiler.Compile(code, typeof(ScriptCompileSurface)));
}
/// <summary>Verifies that compile empty for the mes alarm status script shape.</summary>
[Fact]
public void Compile_Empty_ForTheMesAlarmStatusScriptShape()
{
@@ -139,6 +145,7 @@ public class RoslynScriptCompilerTests
Assert.Empty(RoslynScriptCompiler.Compile(code, typeof(ScriptCompileSurface)));
}
/// <summary>Verifies that compile empty for trigger expression.</summary>
[Fact]
public void Compile_Empty_ForTriggerExpression()
{
@@ -149,6 +156,7 @@ public class RoslynScriptCompilerTests
Assert.Empty(diagnostics);
}
/// <summary>Verifies that compile empty for wait async and wait for async.</summary>
[Fact]
public void Compile_Empty_ForWaitAsyncAndWaitForAsync()
{
@@ -171,6 +179,7 @@ public class RoslynScriptCompilerTests
Assert.Empty(diagnostics);
}
/// <summary>Verifies that compiles cleanly for the log global.</summary>
[Fact]
public void CompilesCleanly_ForTheLogGlobal()
{
@@ -190,6 +199,7 @@ public class RoslynScriptCompilerTests
Assert.Empty(diagnostics);
}
/// <summary>Verifies that compile twice with shared resolver still compiles cleanly.</summary>
[Fact]
public void Compile_TwiceWithSharedResolver_StillCompilesCleanly()
{