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
@@ -29,6 +29,7 @@ public class SmtpUpdateCommandTests
private static ParseResult ParseUpdate(params string[] args)
=> SmtpUpdateCommand().Parse(args);
/// <summary>Verifies that an update with a TLS mode and credentials produces a command carrying both.</summary>
[Fact]
public void Update_WithTlsModeAndCredentials_ProducesCommandCarryingThem()
{
@@ -49,6 +50,7 @@ public class SmtpUpdateCommandTests
Assert.Equal("user:pass", cmd.Credentials);
}
/// <summary>Verifies that an update without a TLS mode or credentials produces a command with null values for them.</summary>
[Fact]
public void Update_WithoutTlsModeAndCredentials_ProducesCommandWithNulls()
{
@@ -64,6 +66,8 @@ public class SmtpUpdateCommandTests
Assert.Null(cmd.Credentials);
}
/// <summary>Verifies that the TLS mode option accepts each canonical value.</summary>
/// <param name="value">The TLS mode value supplied on the command line.</param>
[Theory]
[InlineData("None")]
[InlineData("StartTLS")]
@@ -78,6 +82,8 @@ public class SmtpUpdateCommandTests
Assert.Empty(parse.Errors);
}
/// <summary>Verifies that the TLS mode option rejects values outside the canonical set.</summary>
/// <param name="value">The non-canonical TLS mode value supplied on the command line.</param>
[Theory]
[InlineData("Bogus")]
[InlineData("tls")]
@@ -92,6 +98,7 @@ public class SmtpUpdateCommandTests
Assert.NotEmpty(parse.Errors);
}
/// <summary>Verifies that an update with the EWS transport produces a command carrying that transport.</summary>
[Fact]
public void Update_WithTransportEws_ProducesCommandCarryingIt()
{
@@ -106,6 +113,7 @@ public class SmtpUpdateCommandTests
Assert.Equal("Ews", cmd.Transport);
}
/// <summary>Verifies that an update without a transport produces a command with a null transport.</summary>
[Fact]
public void Update_WithoutTransport_ProducesCommandWithNullTransport()
{
@@ -119,6 +127,8 @@ public class SmtpUpdateCommandTests
Assert.Null(cmd.Transport);
}
/// <summary>Verifies that the transport option rejects values outside the canonical set.</summary>
/// <param name="value">The non-canonical transport value supplied on the command line.</param>
[Theory]
[InlineData("Graph")]
[InlineData("ews")] // AcceptOnlyFromAmong is case-sensitive: constrain to canonical spelling
@@ -132,6 +142,7 @@ public class SmtpUpdateCommandTests
Assert.NotEmpty(parse.Errors);
}
/// <summary>Verifies that the TLS mode and credentials options are not required.</summary>
[Fact]
public void Update_TlsModeAndCredentials_AreNotRequired()
{