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 OverrideCsvParserTests
{
/// <summary>Verifies that a simple three-column file parses into two rows with no errors.</summary>
[Fact]
public void Parse_SimpleThreeColumnFile_ReturnsTwoRowsNoErrors()
{
@@ -25,6 +26,7 @@ public class OverrideCsvParserTests
Assert.Equal(3, result.Rows[1].LineNumber);
}
/// <summary>Verifies that rows from a two-column file without an element type have a null element type.</summary>
[Fact]
public void Parse_TwoColumnFileWithoutElementType_RowsHaveNullElementType()
{
@@ -39,6 +41,7 @@ public class OverrideCsvParserTests
Assert.Equal("Pump A", result.Rows[1].Value);
}
/// <summary>Verifies that a quoted value containing a comma keeps the embedded comma.</summary>
[Fact]
public void Parse_QuotedValueWithComma_PreservesEmbeddedComma()
{
@@ -53,6 +56,7 @@ public class OverrideCsvParserTests
Assert.Null(row.ElementType);
}
/// <summary>Verifies that a doubled quote escape is unescaped to a single quote.</summary>
[Fact]
public void Parse_DoubledQuoteEscape_UnescapesToSingleQuote()
{
@@ -65,6 +69,7 @@ public class OverrideCsvParserTests
Assert.Equal("he said \"hi\"", row.Value);
}
/// <summary>Verifies that an empty value field yields a null value.</summary>
[Fact]
public void Parse_EmptyValueField_YieldsNullValue()
{
@@ -79,6 +84,7 @@ public class OverrideCsvParserTests
Assert.Null(row.ElementType);
}
/// <summary>Verifies that a row with too few columns produces a line-numbered error and is excluded from the result.</summary>
[Fact]
public void Parse_RowWithTooFewColumns_ProducesLineNumberedErrorAndExcludesRow()
{
@@ -95,6 +101,7 @@ public class OverrideCsvParserTests
Assert.Contains("2", error);
}
/// <summary>Verifies that a blank attribute name produces a line-numbered error.</summary>
[Fact]
public void Parse_BlankAttributeName_ProducesLineNumberedError()
{
@@ -107,6 +114,7 @@ public class OverrideCsvParserTests
Assert.Contains("2", error);
}
/// <summary>Verifies that blank lines are skipped without raising an error.</summary>
[Fact]
public void Parse_BlankLines_AreSkippedWithoutError()
{
@@ -121,6 +129,7 @@ public class OverrideCsvParserTests
Assert.Equal(5, result.Rows[1].LineNumber);
}
/// <summary>Verifies that a missing header returns zero rows and a header error.</summary>
[Fact]
public void Parse_MissingHeader_ReturnsZeroRowsAndHeaderError()
{
@@ -133,6 +142,7 @@ public class OverrideCsvParserTests
Assert.Contains("header", error, StringComparison.OrdinalIgnoreCase);
}
/// <summary>Verifies that the header match is case-insensitive and trims surrounding whitespace.</summary>
[Fact]
public void Parse_HeaderIsCaseInsensitiveAndTrimsWhitespace()
{
@@ -147,6 +157,7 @@ public class OverrideCsvParserTests
Assert.Equal("Int32", row.ElementType);
}
/// <summary>Verifies that empty input returns a header error.</summary>
[Fact]
public void Parse_EmptyInput_ReturnsHeaderError()
{
@@ -156,6 +167,7 @@ public class OverrideCsvParserTests
Assert.Single(result.Errors);
}
/// <summary>Verifies that unquoted whitespace is trimmed while quoted whitespace is preserved.</summary>
[Fact]
public void Parse_UnquotedWhitespace_IsTrimmedButQuotedWhitespacePreserved()
{
@@ -170,6 +182,7 @@ public class OverrideCsvParserTests
Assert.Equal(" spaced ", result.Rows[1].Value);
}
/// <summary>Verifies that an unquoted quote character in the middle of a field is preserved literally.</summary>
[Fact]
public void Parse_MidFieldUnquotedQuote_IsPreservedAsLiteral()
{
@@ -186,6 +199,7 @@ public class OverrideCsvParserTests
Assert.Equal("Type", row.ElementType);
}
/// <summary>Verifies that an unterminated quoted field produces a line-numbered error and is excluded from the result.</summary>
[Fact]
public void Parse_UnterminatedQuotedField_ProducesLineNumberedErrorAndExcludesRow()
{
@@ -200,6 +214,7 @@ public class OverrideCsvParserTests
Assert.Contains("Unterminated", error, StringComparison.OrdinalIgnoreCase);
}
/// <summary>Verifies that a well-formed quoted field containing a comma still parses correctly.</summary>
[Fact]
public void Parse_WellFormedQuotedFieldWithComma_StillParses()
{
@@ -216,6 +231,7 @@ public class OverrideCsvParserTests
Assert.Equal("Type", row.ElementType);
}
/// <summary>Verifies that an empty quoted field yields a null value.</summary>
[Fact]
public void Parse_EmptyQuotedField_YieldsNullValue()
{
@@ -231,6 +247,7 @@ public class OverrideCsvParserTests
Assert.Equal("Type", row.ElementType);
}
/// <summary>Verifies that a quoted field followed by trailing whitespace after the closing quote is accepted.</summary>
[Fact]
public void Parse_QuotedFieldWithTrailingWhitespaceAfterClose_IsAccepted()
{