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
@@ -4,6 +4,7 @@ namespace ZB.MOM.WW.ScadaBridge.Commons.Tests;
public class NativeAlarmSourceOverrideCsvParserTests
{
/// <summary>Verifies that a simple file parses into rows with no errors.</summary>
[Fact]
public void Parse_SimpleFile_ReturnsRowsNoErrors()
{
@@ -30,6 +31,7 @@ public class NativeAlarmSourceOverrideCsvParserTests
Assert.Equal(3, result.Rows[1].LineNumber);
}
/// <summary>Verifies that blank override fields become null so the inherited value applies.</summary>
[Fact]
public void Parse_BlankOverrideFields_BecomeNullInherited()
{
@@ -47,6 +49,7 @@ public class NativeAlarmSourceOverrideCsvParserTests
Assert.Null(row.Filter);
}
/// <summary>Verifies that header names are matched case-insensitively.</summary>
[Fact]
public void Parse_HeaderCaseInsensitive_Accepted()
{
@@ -60,6 +63,7 @@ public class NativeAlarmSourceOverrideCsvParserTests
Assert.Single(result.Rows);
}
/// <summary>Verifies that a quoted field preserves an embedded comma.</summary>
[Fact]
public void Parse_QuotedFieldWithComma_PreservesEmbeddedComma()
{
@@ -74,6 +78,7 @@ public class NativeAlarmSourceOverrideCsvParserTests
Assert.Equal("ns=2;s=a,b,c", row.SourceReference);
}
/// <summary>Verifies that a missing header returns a header error.</summary>
[Fact]
public void Parse_MissingHeader_ReturnsHeaderError()
{
@@ -86,6 +91,7 @@ public class NativeAlarmSourceOverrideCsvParserTests
Assert.Contains("SourceName,Connection,SourceReference,Filter", error);
}
/// <summary>Verifies that a row with the wrong column count reports a per-line error and is skipped.</summary>
[Fact]
public void Parse_WrongColumnCount_ReportsPerLineErrorAndSkipsRow()
{
@@ -104,6 +110,7 @@ public class NativeAlarmSourceOverrideCsvParserTests
Assert.Equal("Temp", row.SourceName);
}
/// <summary>Verifies that a blank source name reports an error.</summary>
[Fact]
public void Parse_BlankSourceName_ReportsError()
{
@@ -118,6 +125,7 @@ public class NativeAlarmSourceOverrideCsvParserTests
Assert.Contains("SourceName must not be blank", error);
}
/// <summary>Verifies that an unterminated quote reports an error.</summary>
[Fact]
public void Parse_UnterminatedQuote_ReportsError()
{
@@ -131,6 +139,7 @@ public class NativeAlarmSourceOverrideCsvParserTests
Assert.Contains(result.Errors, e => e.Contains("Unterminated quoted field"));
}
/// <summary>Verifies that blank lines are skipped without an error.</summary>
[Fact]
public void Parse_BlankLinesSkippedWithoutError()
{