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
@@ -15,6 +15,7 @@ public class NodeOptionsValidatorTests
{
// ---- NodeOptions ----
/// <summary>Verifies that default node options with a node name are valid.</summary>
[Fact]
public void Node_DefaultsWithNodeName_AreValid()
{
@@ -22,6 +23,8 @@ public class NodeOptionsValidatorTests
Assert.True(validator.Validate(null, new NodeOptions { NodeName = "node-a" }).Succeeded);
}
/// <summary>Verifies that an empty or whitespace node name fails validation.</summary>
/// <param name="nodeName">The invalid node name.</param>
[Theory]
[InlineData("")]
[InlineData(" ")]
@@ -34,6 +37,7 @@ public class NodeOptionsValidatorTests
f => f.Contains(nameof(NodeOptions.NodeName), StringComparison.Ordinal));
}
/// <summary>Verifies that a remoting port of zero is valid.</summary>
[Fact]
public void Node_ZeroRemotingPort_IsValid()
{
@@ -43,6 +47,8 @@ public class NodeOptionsValidatorTests
new NodeOptions { NodeName = "node-a", RemotingPort = 0 }).Succeeded);
}
/// <summary>Verifies that a remoting port outside the valid range fails validation.</summary>
/// <param name="port">The out-of-range port number.</param>
[Theory]
[InlineData(-1)]
[InlineData(65_536)]
@@ -58,6 +64,7 @@ public class NodeOptionsValidatorTests
// ---- DatabaseOptions ----
/// <summary>Verifies that database options with all values null are valid.</summary>
[Fact]
public void Database_AllNull_IsValid()
{
@@ -66,6 +73,7 @@ public class NodeOptionsValidatorTests
Assert.True(validator.Validate(null, new DatabaseOptions()).Succeeded);
}
/// <summary>Verifies that a whitespace database value fails validation.</summary>
[Fact]
public void Database_WhitespaceValue_Fails()
{
@@ -78,6 +86,7 @@ public class NodeOptionsValidatorTests
// ---- LoggingOptions ----
/// <summary>Verifies that the default Information logging level is valid.</summary>
[Fact]
public void Logging_DefaultInformation_IsValid()
{
@@ -85,6 +94,8 @@ public class NodeOptionsValidatorTests
Assert.True(validator.Validate(null, new LoggingOptions()).Succeeded);
}
/// <summary>Verifies that a recognised logging level is valid.</summary>
/// <param name="level">The logging level name.</param>
[Theory]
[InlineData("Verbose")]
[InlineData("debug")]
@@ -95,6 +106,7 @@ public class NodeOptionsValidatorTests
Assert.True(validator.Validate(null, new LoggingOptions { MinimumLevel = level }).Succeeded);
}
/// <summary>Verifies that an unknown logging level fails validation.</summary>
[Fact]
public void Logging_UnknownLevel_Fails()
{